ETM-Schurig/powersync-core
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

improve documentation

Browse Source
This commit is contained in:
Simon Stürz 2015-08-05 02:08:31 +02:00 committed by Michael Zanetti
parent b35f5f69bf
commit ed0f25ec9d
8 changed files with 46 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/allclasses.qdoc
View File

@ -3,4 +3,5 @@
\title All guh Classes \title All guh Classes
\generatelist classes \generatelist classes
\generatelist overviews
*/ */

9
doc/api.qdoc Normal file
View File

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

34
doc/guh.qdoc
View File

@ -2,31 +2,41 @@
\page index.html \page index.html
\title guh - Developer Documentation \title guh - Developer Documentation
\section1 Summary \section1 Overview
The guh backend service consists of three main modules: The guh backend service consists of three main modules:
\list \list
\li \l{libguh} \li \l{guhserver}{The guh server}
\list
\li \l{guhserver}{The guh server namespace}
\li \l{Rules}
\endlist
\li \l{libguh}{The guh library}
\list \list
\li \l{Types}{Types used in the guh system} \li \l{Types}{Types used in the guh system}
\li \l{Device Plugins}{The Device Plugin API} \li \l{Device Plugins}{The Device Plugin API}
\li \l{Hardware Resources}{Hardware Resources} \li \l{Hardware Resources}{Hardware resources available for plugins}
\endlist \endlist
\li \l{guhserver} \li \l{Plugins}{The guh plugins}
\list
\li \l{guh Core}
\li \l{JSONRPC Interface}
\li \l{Rules}
\endlist
\li \l{Plugins}.
\list \list
\li \l{RF 433 MHz Plugins} \li \l{RF 433 MHz Plugins}
\li \l{Service Plugins} \li \l{Service Plugins}
\li \l{Network Plugins} \li \l{Network Plugins}
\endlist \endlist
\endlist \endlist
\section2 Quicklinks \section1 API's
\list
\li \l{JSON-RPC API}
\li \l{https://github.com/guh/guh/wiki/REST-Api-documentation}{REST API}
\endlist
\section1 How To's
\list
\li How to write a plugin
\endlist
\section1 Quicklinks
\list \list
\li \l{All guh Classes} \li \l{All guh Classes}
\li \l{All Modules} \li \l{All Modules}

2
doc/guhcore.qdoc
View File

@ -2,6 +2,6 @@
\page guhcore-index.html \page guhcore-index.html
\title guh Core \title guh Core
\annotatedlist core \annotatedlist server
*/ */

2
doc/jsonrpc.qdoc
View File

@ -1,6 +1,6 @@
/*! /*!
\page jsonrpc.html \page jsonrpc.html
\title JSONRPC Interface \title JSON-RPC API
\ingroup jsonrpc \ingroup jsonrpc
\brief The JSON RPC interface represents a TCP socket connection using plaintext string communication. \brief The JSON RPC interface represents a TCP socket connection using plaintext string communication.

2
doc/libguh.qdoc
View File

@ -1,6 +1,6 @@
/*! /*!
\module libguh \module libguh
\title libguh \title The guh library
\section1 Types \section1 Types
\annotatedlist types \annotatedlist types

9
doc/rest.qdoc Normal file
View File

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

2
server/websocketserver.cpp
View File

@ -25,6 +25,8 @@
\ingroup core \ingroup core
\inmodule server \inmodule server
\note The WebSocketServer is only available for builds with Qt version greater than Qt 5.3.0!
The websocket server provides a server for websocket clients based on The websocket server provides a server for websocket clients based on
\l{http://tools.ietf.org/html/rfc6455}{Protocol Version 13}. The default \l{http://tools.ietf.org/html/rfc6455}{Protocol Version 13}. The default
port for the websocket server is 4444, which is according to this port for the websocket server is 4444, which is according to this