small documenttion changes

This commit is contained in:
Simon Stürz 2016-03-18 14:14:32 +01:00 committed by Michael Zanetti
parent 9449d67008
commit a002ed02e4
10 changed files with 13 additions and 4 deletions

View File

@ -34,4 +34,6 @@ exampledirs = ..
sourcedirs = .. sourcedirs = ..
sources.fileextensions = "*.cpp *.qdoc" sources.fileextensions = "*.cpp *.qdoc"
Cpp.ignoredirectives = DECLARE_TYPE \
DECLARE_OBJECT

View File

@ -3,6 +3,7 @@
\title Tutorial 1 - The "Minimal" plugin \title Tutorial 1 - The "Minimal" plugin
\brief This tutorial shows you how to open, edit, build and load the first plugin. \brief This tutorial shows you how to open, edit, build and load the first plugin.
\ingroup tutorials \ingroup tutorials
\contentspage {Tutorials}
\section1 Topics \section1 Topics
This first tutorial shows you how to: This first tutorial shows you how to:
@ -141,5 +142,4 @@
\endlist \endlist
Now you can take a look at \l{Tutorial 2 - The "Buttons" plugin}. Now you can take a look at \l{Tutorial 2 - The "Buttons" plugin}.
*/ */

View File

@ -458,7 +458,7 @@
\li Start guh-cli and add the a new \b {"Simple Button"} devcice. Give an appropriate name like \b {Test button}. \li Start guh-cli and add the a new \b {"Simple Button"} devcice. Give an appropriate name like \b {Test button}.
\li Use guh-cli to execute the \b {press the button} action: \li Use guh-cli to execute the \b {press the button} action:
\tt "Devices" \unicode{0x2192} \tt "Execute an action" \unicode{0x2192} \tt {"Your device name (Simple Button)"} \unicode{0x2192} \tt {press the button} \tt "Devices" \unicode{0x2192} \tt {"Execute an action"} \unicode{0x2192} \tt {"Your device name (Simple Button)"} \unicode{0x2192} \tt {press the button}
\endlist \endlist

View File

@ -1,7 +1,10 @@
/*! /*!
\page tutorials.html \page tutorials.html
\title Tutorials \title Tutorials
\contentspage {Tutorials}
\nextpage {Tutorial 1 - The "Minimal" plugin}
\previouspage {Write your own plugin}
In order to getting started with your own \l DevicePlugin it is recommanded to walk trough following tutorials to understand how the mechanism works: In order to getting started with your own \l DevicePlugin it is recommanded to walk trough following tutorials to understand how the mechanism works:
\annotatedlist tutorials \annotatedlist tutorials

View File

@ -24,6 +24,7 @@
\brief Describes a certain \l{Event}. \brief Describes a certain \l{Event}.
\ingroup guh-types \ingroup guh-types
\ingroup rules
\inmodule libguh \inmodule libguh
An EventDescriptor describes an \l{Event} in order to match it with a \l{guhserver::Rule}. An EventDescriptor describes an \l{Event} in order to match it with a \l{guhserver::Rule}.

View File

@ -24,6 +24,7 @@
\brief Describes a certain \l{Param}. \brief Describes a certain \l{Param}.
\ingroup guh-types \ingroup guh-types
\ingroup rules
\inmodule libguh \inmodule libguh
An ParamDescriptor describes a \l{Param} in order to match it with a \l{guhserver::Rule}. An ParamDescriptor describes a \l{Param} in order to match it with a \l{guhserver::Rule}.

View File

@ -24,6 +24,7 @@
\brief Describes an action for a \l{guhserver::Rule}. \brief Describes an action for a \l{guhserver::Rule}.
\ingroup guh-types \ingroup guh-types
\ingroup rules
\inmodule libguh \inmodule libguh
A RuleAction describes a special form of an \l{Action} for a \l{guhserver::Rule}. The main difference is A RuleAction describes a special form of an \l{Action} for a \l{guhserver::Rule}. The main difference is

View File

@ -24,6 +24,7 @@
\brief Holds the parameters for a \l{RuleAction}. \brief Holds the parameters for a \l{RuleAction}.
\ingroup guh-types \ingroup guh-types
\ingroup rules
\inmodule libguh \inmodule libguh
A RuleActionParam allows rules to take over an \l{Event} parameter into a rule A RuleActionParam allows rules to take over an \l{Event} parameter into a rule

View File

@ -24,6 +24,7 @@
\brief Describes a certain \l{State}. \brief Describes a certain \l{State}.
\ingroup guh-types \ingroup guh-types
\ingroup rules
\inmodule libguh \inmodule libguh
An StateDescriptor describes a \l{State} in order to match it with a \l{guhserver::Rule}. An StateDescriptor describes a \l{State} in order to match it with a \l{guhserver::Rule}.

View File

@ -256,7 +256,6 @@ bool StateEvaluator::isValid() const
} }
} }
} }
} }
if (m_operatorType == Types::StateOperatorOr) { if (m_operatorType == Types::StateOperatorOr) {