diff --git a/doc/api.qdoc b/doc/api.qdoc deleted file mode 100644 index fdf2d9e2..00000000 --- a/doc/api.qdoc +++ /dev/null @@ -1,9 +0,0 @@ -/*! - \page api.html - \title The guh API's - - \l{JSON-RPC API} - - \l{REST API} - -*/ diff --git a/doc/guh.qdoc b/doc/guh.qdoc index 4fa5aa3d..9b390d53 100644 --- a/doc/guh.qdoc +++ b/doc/guh.qdoc @@ -1,6 +1,5 @@ /*! \page index.html - \title guh - Developer Documentation \section1 Overview The guh backend service consists of three main modules: @@ -9,7 +8,7 @@ \li \l{guhserver}{The guh server} \list \li \l{guhserver}{The guh server namespace} - \li \l{Rules} + \li \l{Rules}{The Rule Engine} \endlist \li \l{libguh}{The guh library} \list @@ -33,7 +32,7 @@ \section1 How To's \list - \li How to write a plugin + \li \l{How to write a plugin} \endlist \section1 Quicklinks diff --git a/doc/html-template.qdocconf b/doc/html-template.qdocconf index 47242da3..b3ccb3a5 100644 --- a/doc/html-template.qdocconf +++ b/doc/html-template.qdocconf @@ -3,7 +3,7 @@ include(html-styles.qdocconf) HTML.postheader = \ "
\n" \ "
\n" \ - " guh developer documentation\n" \ + " guh - Developer documentation\n" \ "
\n" \ "
\n" \ "
\n" \ "
\n" -HTML.footer = "" +HTML.footer = \ + "
\n" \ + "

\n" \ + " © 2013-2015 ARGE guh. All rights reserved." \ + "

\n" \ + "
\n" \ + +#HTML.footer = "" # Files not referenced in any qdoc file. # See also extraimages.HTML diff --git a/doc/rest.qdoc b/doc/rest.qdoc deleted file mode 100644 index e340d136..00000000 --- a/doc/rest.qdoc +++ /dev/null @@ -1,9 +0,0 @@ -/*! - \page rest.html - \title REST API - - \brief The REST API description of the guh server. - - - -*/ diff --git a/doc/style.css b/doc/style.css index 5f64724a..3109b89f 100644 --- a/doc/style.css +++ b/doc/style.css @@ -223,16 +223,17 @@ { display: block; clear: both; - overflow: hidden; + /*overflow: hidden;*/ background: #69938C; - height: 10.5em; + height: 10em; } /* end global settings*/ /* header elements */ - .header .indexref + .header .ind exref { - font-size: 130%; + font-size: 140%; + font-weight: bold } .titleText { diff --git a/doc/write-plugins.qdoc b/doc/write-plugins.qdoc new file mode 100644 index 00000000..032236f9 --- /dev/null +++ b/doc/write-plugins.qdoc @@ -0,0 +1,19 @@ +/*! + \page write-plugins.html + \title How to write a plugin + + \brief This tutorial shows you how to write a plugin for your device / service. + + + \chapter Create the build environment + + Assuming you are working an a Linux here are some steps how to set up the build environment. + + \section1 Install Qt + + \section1 Install guh dependencys + + + \chapter Getting started + +*/