Skip to content
Snippets Groups Projects
Commit 423a9173 authored by Francois Bleibel's avatar Francois Bleibel
Browse files

More documentation stubs.

parent 836c4f2a
No related branches found
No related tags found
No related merge requests found
...@@ -73,13 +73,18 @@ enable creation of this entity through the factory. ...@@ -73,13 +73,18 @@ enable creation of this entity through the factory.
The entities will be placed in ${PREFIX}/lib/plugin (since this may change, it is advised to The entities will be placed in ${PREFIX}/lib/plugin (since this may change, it is advised to
check the install log or the CMakeLists.txt file to check the installation path). check the install log or the CMakeLists.txt file to check the installation path).
\section signals About signals \section sigintro About signals
Entities can output different types of signals. All signals are templated by a Time Entities can output different types of signals. All signals are templated by a Time
tick type parameter (which is used in the caching of signals) - usually \c int. Signals tick type parameter (which is used in the caching of signals) - usually \c int. Signals
are also templated after the type of data they accept or provide. For example: are also templated after the type of data they accept or provide. For example:
(example)
For a more detailed programmer-oriented description of signals, please see \ref signals
\section usecase Use case \section scriptingabout About the scripting language
(...)
\section usecase Programmers use case
\image html pictures/use-case.svg \image html pictures/use-case.svg
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment