mohr/fsfw
1
0
Fork 0
forked from fsfw/fsfw
Code Pull Requests Activity

Introducing documentation with Sphinx

Browse Source 
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
This commit is contained in:
Robin Müller
2021-12-01 11:04:24 +01:00
parent bf31248a50
commit c2bf09d506
46 changed files with 1290 additions and 120 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/api/ipc.rst Normal file
View File

@ -0,0 +1,9 @@
IPC Module API
=================
``MessageQueueIF``
-------------------
.. doxygenclass:: MessageQueueIF
:members:
:protected-members: