fsfw/docs/api.rst

API
====

.. toctree::
   :maxdepth: 4

   api/cfdp
   api/objectmanager
   api/task
   api/ipc
   api/returnvalue
   api/event
   api/modes
   api/health
   api/action
   api/devicehandler
   api/controller
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			`API`
			`====`

			`.. toctree::`
			`:maxdepth: 4`

some doc updates 2022-08-09 16:26:37 +02:00			`api/cfdp`
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			`api/objectmanager`
			`api/task`
			`api/ipc`
			`api/returnvalue`
			`api/event`
			`api/modes`
			`api/health`
			`api/action`
			`api/devicehandler`
			`api/controller`