EMTime/libopencm3
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Changes to doxygen markup to solve a few problems that upset

Browse Source 
doxygen, and to correct minor errors.
This commit is contained in:
Ken Sarkies
2013-06-01 14:54:00 +09:30
committed by Piotr Esden-Tempski
parent bad5580492
commit f5c9bdfe61
29 changed files with 149 additions and 55 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
doc/HACKING
View File

@@ -33,7 +33,7 @@ functions and defines in the documentation.
The header and source files for each peripheral in each family must have a
heading section in which an @defgroup defines the group name for the particular
peripheral. This group name will be the same across all families as each one
is documented deparately. Thus for a peripheral xxx the header will have a
is documented separately. Thus for a peripheral xxx the header will have a
group name xxx_defines and the source file will have xxx_file. This will allow
the group to appear separately. An @ingroup must be provided to place the group
as a subgroup of the appropriate family grouping. Note that @file is not used.
@@ -78,6 +78,7 @@ LAYOUT_FILE = DoxygenLayout_$processor.xml
WARN_LOGFILE = doxygen_$processor.log
TAGFILES = ../cm3/cm3.tag=../../cm3/html
GENERATE_TAGFILE = $processor.tag
PREDEFINED = list of macro definitions
For the top level Doxyfile