eive/fsfw
eive
/
fsfw
forked from fsfw/fsfw
14
1
Fork 0
Code Issues Pull Requests Releases 1 Wiki Activity
fsfw/docs/api/controller.rst

17 lines
277 B
ReStructuredText
Raw Normal View History

Introducing documentation with Sphinx This PR introduces the generation of documentation based on this excellent blog post: https://devblogs.microsoft.com/cppblog/clear-functional-c-documentation-with-sphinx-breathe-doxygen-cmake/ It combines the tools Sphinx, Doxygen and Breathe to generate good looking HTML documentation conveniently which can be hosted easily. The helper scripts were unified and there is now one helper.py script which can be used to create, build and open both tests and documentation. "./helper.py -h" can be used to get the different options. This PR also contains some smaller fixes which were necessary for the docs to build
2021-12-01 11:04:24 +01:00
Controller API
=================
``ControllerBase``
-------------------------
.. doxygenclass:: ControllerBase
:members:
:protected-members:
``ExtendedControllerBase``
-----------------------------
.. doxygenclass:: ExtendedControllerBase
:members:
:protected-members: