adding write plugin template

This commit is contained in:
Simon Stürz 2015-08-05 18:27:14 +02:00 committed by Michael Zanetti
parent ed0f25ec9d
commit b757c6d192
6 changed files with 35 additions and 27 deletions

View File

@ -1,9 +0,0 @@
/*!
\page api.html
\title The guh API's
\l{JSON-RPC API}
\l{REST API}
*/

View File

@ -1,6 +1,5 @@
/*! /*!
\page index.html \page index.html
\title guh - Developer Documentation
\section1 Overview \section1 Overview
The guh backend service consists of three main modules: The guh backend service consists of three main modules:
@ -9,7 +8,7 @@
\li \l{guhserver}{The guh server} \li \l{guhserver}{The guh server}
\list \list
\li \l{guhserver}{The guh server namespace} \li \l{guhserver}{The guh server namespace}
\li \l{Rules} \li \l{Rules}{The Rule Engine}
\endlist \endlist
\li \l{libguh}{The guh library} \li \l{libguh}{The guh library}
\list \list
@ -33,7 +32,7 @@
\section1 How To's \section1 How To's
\list \list
\li How to write a plugin \li \l{How to write a plugin}
\endlist \endlist
\section1 Quicklinks \section1 Quicklinks

View File

@ -3,7 +3,7 @@ include(html-styles.qdocconf)
HTML.postheader = \ HTML.postheader = \
"<div class=\"header\">\n" \ "<div class=\"header\">\n" \
" <div class=\"content\"> \n" \ " <div class=\"content\"> \n" \
" <a href=\"index.html\" class=\"indexref\"><img src=\"images/logo.png\"/><span class="titleText">guh developer documentation<span></a>\n" \ " <a href=\"index.html\" class=\"indexref\"><img src=\"images/logo.png\"/><span class="titleText">guh - Developer documentation<span></a>\n" \
" </div>\n" \ " </div>\n" \
" <div class=\"breadcrumb toolblock\">\n" \ " <div class=\"breadcrumb toolblock\">\n" \
" <ul>\n" \ " <ul>\n" \
@ -16,6 +16,13 @@ HTML.postpostheader = \
"</div>\n" \ "</div>\n" \
"<div class=\"content mainContent\">\n" "<div class=\"content mainContent\">\n"
HTML.footer = "" HTML.footer = \
"<div class=\"footer\">\n" \
" <p>\n" \
" <acronym title=\"Copyright\">&copy;</acronym> 2013-2015 ARGE guh. All rights reserved." \
" </p>\n" \
"</div>\n" \
#HTML.footer = ""
# Files not referenced in any qdoc file. # Files not referenced in any qdoc file.
# See also extraimages.HTML # See also extraimages.HTML

View File

@ -1,9 +0,0 @@
/*!
\page rest.html
\title REST API
\brief The REST API description of the guh server.
*/

View File

@ -223,16 +223,17 @@
{ {
display: block; display: block;
clear: both; clear: both;
overflow: hidden; /*overflow: hidden;*/
background: #69938C; background: #69938C;
height: 10.5em; height: 10em;
} }
/* end global settings*/ /* end global settings*/
/* header elements */ /* header elements */
.header .indexref .header .ind exref
{ {
font-size: 130%; font-size: 140%;
font-weight: bold
} }
.titleText { .titleText {

19
doc/write-plugins.qdoc Normal file
View File

@ -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
*/