Merging pull request #72 Doc

Merge remote-tracking branch 'ksarkies/doc'

Conflicts:
	doc/stm32f1/Doxyfile
	doc/stm32f2/Doxyfile
	doc/stm32f4/Doxyfile
	lib/stm32/f1/Makefile
	lib/stm32/f2/Makefile
	lib/stm32/f4/Makefile
This commit is contained in:
Piotr Esden-Tempski
2013-01-09 00:51:24 -08:00
85 changed files with 3638 additions and 1933 deletions

View File

@@ -18,9 +18,10 @@ WARN_LOGFILE = doxygen_stm32f1_latex.log
INPUT = ../../include/libopencm3/docmain.dox \
../../include/libopencm3/license.dox \
../../include/libopencm3/stm32/f1 \
../../include/libopencm3/stm32/common \
../../lib/stm32/f1 \
../../lib/stm32/common
../../include/libopencm3/stm32/common
INPUT += ../../lib/stm32/f1 \
../../lib/stm32/common
EXCLUDE = ../../include/libopencm3/stm32/f1/doc-stm32f1.h \
../../include/libopencm3/stm32/f1/usb.h \

View File

@@ -5,7 +5,7 @@
<tab type="pages" visible="yes" title="General Information" intro=""/>
<tab type="user" visible="yes" url="../../html/index.html" title="Back to Top" intro=""/>
<tab type="user" visible="yes" url="../../cm3/html/modules.html" title="CM3 Core" intro=""/>
<tab type="modules" visible="yes" title="STMF1" intro=""/>
<tab type="modules" visible="yes" title="STM32F1" intro=""/>
<tab type="user" visible="yes" url="../../stm32f2/html/modules.html" title="STM32F2" intro=""/>
<tab type="user" visible="yes" url="../../stm32f4/html/modules.html" title="STM32F4" intro=""/>
<tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/>

View File

@@ -24,6 +24,8 @@ INPUT += ../../lib/stm32/f2 \
EXCLUDE =
EXCLUDE_PATTERNS =
LAYOUT_FILE = DoxygenLayout_stm32f2.xml
TAGFILES = ../cm3/cm3.tag=../../cm3/html

View File

@@ -18,12 +18,15 @@ WARN_LOGFILE = doxygen_stm32f2_latex.log
INPUT = ../../include/libopencm3/docmain.dox \
../../include/libopencm3/license.dox \
../../include/libopencm3/stm32/f2 \
../../include/libopencm3/stm32/common \
../../lib/stm32/f2 \
../../include/libopencm3/stm32/common
INPUT += ../../lib/stm32/f2 \
../../lib/stm32/common
EXCLUDE = ../../include/libopencm3/stm32/f2/doc-stm32f2.h
EXCLUDE_PATTERNS =
LAYOUT_FILE = DoxygenLayout_stm32f2.xml
GENERATE_HTML = NO

View File

@@ -18,12 +18,15 @@ WARN_LOGFILE = doxygen_stm32f4_latex.log
INPUT = ../../include/libopencm3/docmain.dox \
../../include/libopencm3/license.dox \
../../include/libopencm3/stm32/f4 \
../../include/libopencm3/stm32/common \
../../lib/stm32/f4 \
../../include/libopencm3/stm32/common
INPUT += ../../lib/stm32/f4 \
../../lib/stm32/common
EXCLUDE = ../../include/libopencm3/stm32/f4/doc-stm32f4.h
EXCLUDE_PATTERNS =
LAYOUT_FILE = DoxygenLayout_stm32f4.xml
GENERATE_HTML = NO

View File

@@ -1,13 +1,13 @@
# HTML Documentation for STM32F1 code level
# HTML Documentation for STM32L1 code level
# 14 September 2012
# 15 December 2012
# (C) Ken Sarkies <ksarkies@internode.on.net>
#---------------------------------------------------------------------------
# Common Include File
#---------------------------------------------------------------------------
@INCLUDE = ../Doxyfile_common
@INCLUDE = ../Doxyfile_common
#---------------------------------------------------------------------------
# Local settings
@@ -16,18 +16,21 @@
WARN_LOGFILE = doxygen_stm32l1.log
INPUT = ../../include/libopencm3/license.dox \
../../include/libopencm3/stm32/l1 \
../../include/libopencm3/stm32/common \
../../lib/stm32/l1 \
../../lib/stm32/common
../../include/libopencm3/stm32/l1 \
../../include/libopencm3/stm32/common
EXCLUDE =
INPUT += ../../lib/stm32/l1 \
../../lib/stm32/common
EXCLUDE_PATTERNS = *_common_f24.h
EXCLUDE = ../../include/libopencm3/stm32/common/gpio_common_f24.h
LAYOUT_FILE = DoxygenLayout_stm32l1.xml
EXCLUDE += ../../lib/stm32/common/gpio_common_f24.c
TAGFILES = ../cm3/cm3.tag=../../cm3/html \
EXCLUDE_PATTERNS =
LAYOUT_FILE = DoxygenLayout_stm32l1.xml
TAGFILES = ../cm3/cm3.tag=../../cm3/html
GENERATE_TAGFILE = stm32l1.tag

View File

@@ -18,13 +18,17 @@ WARN_LOGFILE = doxygen_stm32l1_latex.log
INPUT = ../../include/libopencm3/docmain.dox \
../../include/libopencm3/license.dox \
../../include/libopencm3/stm32/l1 \
../../include/libopencm3/stm32/common \
../../lib/stm32/l1 \
../../lib/stm32/common
../../include/libopencm3/stm32/common
EXCLUDE = ../../include/libopencm3/stm32/l1/doc-stm32l1.h
INPUT += ../../lib/stm32/l1 \
../../lib/stm32/common
EXCLUDE_PATTERNS = *_common_f24.h
EXCLUDE = ../../include/libopencm3/stm32/l1/doc-stm32l1.h \
../../include/libopencm3/stm32/common/gpio_common_f24.h
EXCLUDE += ../../lib/stm32/common/gpio_common_f24.c
EXCLUDE_PATTERNS =
LAYOUT_FILE = DoxygenLayout_stm32l1.xml