aboutsummaryrefslogtreecommitdiff
path: root/doc/Doxyfile
diff options
context:
space:
mode:
authorKen Sarkies2012-09-15 12:51:46 +0930
committerKen Sarkies2012-09-15 12:51:46 +0930
commitff83a1ae1c0764aff11d8cd50f1f0f8a27ea4757 (patch)
tree030d15b829c2c76f1b97891a92cfc697d73aed3b /doc/Doxyfile
parentdcd98dde86c68340e950d12b078d24fd30bef625 (diff)
Setup to document entire project using doxygen.
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.
Diffstat (limited to 'doc/Doxyfile')
-rw-r--r--doc/Doxyfile31
1 files changed, 31 insertions, 0 deletions
diff --git a/doc/Doxyfile b/doc/Doxyfile
new file mode 100644
index 0000000..75f01f8
--- /dev/null
+++ b/doc/Doxyfile
@@ -0,0 +1,31 @@
+# Doxygen include file to generate top level entry document
+
+# 14 September 2012
+# (C) Ken Sarkies <ksarkies@internode.on.net>
+
+#---------------------------------------------------------------------------
+# Common Include File
+#---------------------------------------------------------------------------
+
+@INCLUDE = ./Doxyfile_common
+
+#---------------------------------------------------------------------------
+# Local settings
+#---------------------------------------------------------------------------
+
+INPUT = ../include/libopencm3/docmain.dox
+
+LAYOUT_FILE = DoxygenLayout.xml
+
+GENERATE_LATEX = NO
+
+TAGFILES = ./cm3/cm3.tag=../cm3/html \
+ ./stm32/stm32.tag=../stm32/html \
+ ./stm32f1/stm32f1.tag=../stm32f1/html \
+ ./stm32f4/stm32f4.tag=../stm32f4/html \
+ ./lm3s/lm3s.tag=../lm3s/html \
+ ./lpc13xx/lpc13xx.tag=../lpc13xx/html \
+ ./lpc17xx/lpc17xx.tag=../lpc17xx/html \
+ ./lpc43xx/lpc43xx.tag=../lpc43xx/html
+
+