More doxygen documentation

git-svn-id: https://svn.vbchaos.nl/svn/hsb/trunk@416 05563f52-14a8-4384-a975-3d1654cca0fa
This commit is contained in:
dvl
2018-01-11 13:51:42 +00:00
parent 39ceb106cf
commit 9915a5a349
8 changed files with 69 additions and 33 deletions

View File

@@ -0,0 +1,17 @@
// Just some definitions for Doxygen. Does not to be included in any file
/**
\defgroup HAL Hardware abstraction layer
Hardware abstraction layer
\defgroup hsb-mrts Application layer
Application layer
\defgroup Platform Platform layer
Platform layer
@mainpage HSB design document
This document describes most of the classes used in the HSB software. Although this
software is written in C, an object-oriented approach is used where classed are coded as
structs. This also makes it possible to let doxygen generate class diagrams.
<br/>
The "Modules" menu above is the easiest way to start browsing through all classes.
*/