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

Setup to document entire project using doxygen.

Browse Source 
New doc directory with config files and generated html, LaTeX/pdf.
Makefile provided for autogeneration and explanatory README.

The project structure is hostile to doxygen, which can't cope with functions
of the same name. Doxygen is run for each family separately, and separately
for LaTeX generation. Customized layout files sort of "integrate" HTML, and
separate pdfs are generated for each family. Not ideal but seems the best
solution until doxygen changes, if at all.
This commit is contained in:
Ken Sarkies
2012-09-15 12:51:46 +09:30
parent dcd98dde86
commit ff83a1ae1c
51 changed files with 3330 additions and 208 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
doc/stm32f4/Doxyfile Normal file
View File

@@ -0,0 +1,30 @@
# HTML Documentation for STM32F4 code level
# 14 September 2012
# (C) Ken Sarkies <ksarkies@internode.on.net>
#---------------------------------------------------------------------------
# Common Include File
#---------------------------------------------------------------------------
@INCLUDE = ../Doxyfile_common
#---------------------------------------------------------------------------
# Local settings
#---------------------------------------------------------------------------
WARN_LOGFILE = doxygen_stm32f4.log
INPUT = ../../include/libopencm3/license.dox \
../../include/libopencm3/stm32/f4 \
../../lib/stm32/f4
EXCLUDE = ../../include/libopencm3/stm32/f4/nvic_f4.h
LAYOUT_FILE = DoxygenLayout_stm32f4.xml
TAGFILES = ../cm3/cm3.tag=../../cm3/html \
../stm32/stm32.tag=../../stm32/html
GENERATE_TAGFILE = stm32f4.tag