diff --git a/Hive.pro b/Hive.pro index 9eb74578..88709e3f 100644 --- a/Hive.pro +++ b/Hive.pro @@ -6,5 +6,5 @@ server.depends = libhive plugins plugins.depends = libhive docs.depends = libhive server -docs.commands = cd doc; qdoc config.qdocconf +docs.commands = cd ${PWD}; qdoc config.qdocconf QMAKE_EXTRA_TARGETS += docs diff --git a/doc/allclasses.qdoc b/doc/allclasses.qdoc new file mode 100644 index 00000000..23033287 --- /dev/null +++ b/doc/allclasses.qdoc @@ -0,0 +1,6 @@ +/*! + \page classes.html + \title All Hive Classes + + \generatelist classes +*/ diff --git a/doc/deviceplugins.qdoc b/doc/deviceplugins.qdoc new file mode 100644 index 00000000..d8b679fa --- /dev/null +++ b/doc/deviceplugins.qdoc @@ -0,0 +1,11 @@ +/*! + \page deviceplugins.html + \title Device Plugins + + \brief This is the API for implementing Hive device plugins. + + When creating a device plugin, start by subclassing \l{DevicePlugin} and filling + in information for the pure virtual methods. + + \annotatedlist devices +*/ diff --git a/doc/hive.qdoc b/doc/hive.qdoc index 77023c33..84c23f3c 100644 --- a/doc/hive.qdoc +++ b/doc/hive.qdoc @@ -1,22 +1,27 @@ /*! \page index.html - \title Hive + \title Hive Developer Documentation \section1 Summary - The hive backend service consists of three main modules: + The Hive backend service consists of three main modules: \list \li libhive \list - \li \l{Types} used in the hive system - \li Defines plugin API and plugin loading mechanism + \li \l{Types}{Types used in the hive system} + \li \l{Device Plugins}{The Device Plugin API} \endlist \li Hive server \list \li Hive core \li \l{JSONRPC Interface} - \li Rules engine + \li \l{Rules} \endlist \li Device plugins. A collection of officially supported device plugins. \endlist + + \section2 Quicklinks + \list + \li \l{All Hive Classes} + \endlist */ diff --git a/doc/html-styles.qdocconf b/doc/html-styles.qdocconf index 5c16c5df..a839c745 100644 --- a/doc/html-styles.qdocconf +++ b/doc/html-styles.qdocconf @@ -7,18 +7,6 @@ HTML.templatedir = . HTML.stylesheets = style.css HTML.scripts = - -# Files not referenced in any qdoc file (last four needed by qtdemo) -# See also qhp.Qt.extraFiles -extraimages.HTML = qt-logo.png \ - arrow_down.png \ - breadcrumb.png \ - bullet_gt.png \ - bullet_dn.png \ - bullet_sq.png \ - bullet_up.png \ - horBar.png \ - sprites-combined.png # Include the style sheets and scripts used. diff --git a/doc/html-template.qdocconf b/doc/html-template.qdocconf index 44c36680..4e9c791a 100644 --- a/doc/html-template.qdocconf +++ b/doc/html-template.qdocconf @@ -3,7 +3,7 @@ include(html-styles.qdocconf) HTML.postheader = \ "