Browse Source

[stm32l0] Integrate the L0 architecture to the doxygen documentation

Conflicts:
	doc/Makefile
pull/356/head
Frantisek Burian 10 years ago
parent
commit
eee5a45019
  1. 1
      doc/DoxygenLayout.xml
  2. 12
      doc/Makefile
  3. 1
      doc/cm3/DoxygenLayout_cm3.xml
  4. 1
      doc/efm32g/DoxygenLayout_efm32g.xml
  5. 1
      doc/efm32gg/DoxygenLayout_efm32gg.xml
  6. 1
      doc/efm32lg/DoxygenLayout_efm32lg.xml
  7. 1
      doc/efm32tg/DoxygenLayout_efm32tg.xml
  8. 1
      doc/lm3s/DoxygenLayout_lm3s.xml
  9. 1
      doc/lm4f/DoxygenLayout_lm4f.xml
  10. 1
      doc/lpc13xx/DoxygenLayout_lpc13xx.xml
  11. 1
      doc/lpc17xx/DoxygenLayout_lpc17xx.xml
  12. 1
      doc/lpc43xx/DoxygenLayout_lpc43xx.xml
  13. 1
      doc/sam3a/DoxygenLayout_sam3a.xml
  14. 1
      doc/sam3n/DoxygenLayout_sam3n.xml
  15. 1
      doc/sam3s/DoxygenLayout_sam3s.xml
  16. 1
      doc/sam3u/DoxygenLayout_sam3u.xml
  17. 1
      doc/sam3x/DoxygenLayout_sam3x.xml
  18. 1
      doc/stm32f0/DoxygenLayout_stm32f0.xml
  19. 1
      doc/stm32f1/DoxygenLayout_stm32f1.xml
  20. 1
      doc/stm32f2/DoxygenLayout_stm32f2.xml
  21. 1
      doc/stm32f3/DoxygenLayout_stm32f3.xml
  22. 1
      doc/stm32f4/DoxygenLayout_stm32f4.xml
  23. 43
      doc/stm32l0/Doxyfile
  24. 38
      doc/stm32l0/Doxyfile_latex
  25. 207
      doc/stm32l0/DoxygenLayout_stm32l0.xml
  26. 61
      doc/stm32l0/header_stm32l0.tex
  27. 8
      doc/stm32l0/index.html
  28. 1
      doc/stm32l1/DoxygenLayout_stm32l1.xml
  29. 1
      doc/usb/DoxygenLayout_usb.xml
  30. 32
      include/libopencm3/stm32/l0/doc-stm32l0.h

1
doc/DoxygenLayout.xml

@ -11,6 +11,7 @@
<tab type="user" visible="yes" url="../stm32f2/html/modules.html" title="STM32F2" intro=""/>
<tab type="user" visible="yes" url="../stm32f3/html/modules.html" title="STM32F3" intro=""/>
<tab type="user" visible="yes" url="../stm32f4/html/modules.html" title="STM32F4" intro=""/>
<tab type="user" visible="yes" url="../stm32l0/html/modules.html" title="STM32L0" intro=""/>
<tab type="user" visible="yes" url="../stm32l1/html/modules.html" title="STM32L1" intro=""/>
<tab type="user" visible="yes" url="../lm3s/html/modules.html" title="LM3S" intro=""/>
<tab type="user" visible="yes" url="../lm4f/html/modules.html" title="LM4F" intro=""/>

12
doc/Makefile

@ -5,7 +5,7 @@
doc: html latex
html: cm3 usb stm32l1 stm32f0 stm32f1 stm32f2 stm32f3 stm32f4 efm32g efm32gg efm32lg efm32tg lm3s lm4f lpc13 lpc17 lpc43 sam3a sam3n sam3s sam3u sam3x vf6xx top
html: cm3 usb stm32l0 stm32l1 stm32f0 stm32f1 stm32f2 stm32f3 stm32f4 efm32g efm32gg efm32lg efm32tg lm3s lm4f lpc13 lpc17 lpc43 sam3a sam3n sam3s sam3u sam3x vf6xx top
cm3:
cd cm3/; doxygen
@ -55,6 +55,9 @@ stm32f3:
stm32f4:
cd stm32f4/; doxygen
stm32l0:
cd stm32l0/; doxygen
stm32l1:
cd stm32l1/; doxygen
@ -79,7 +82,10 @@ vf6xx:
top:
doxygen
latex: stm32l1.pdf stm32f0.pdf stm32f1.pdf stm32f2.pdf stm32f3.pdf stm32f4.pdf lm3s.pdf lm4f.pdf lpc13.pdf lpc17.pdf lpc43.pdf efm32g.pdf efm32gg.pdf efm32lg.pdf efm32tg.pdf sam3a.pdf sam3n.pdf sam3s.pdf sam3u.pdf sam3x.pdf vf6xx.pdf
latex: stm32l0.pdf stm32l1.pdf stm32f0.pdf stm32f1.pdf stm32f2.pdf stm32f3.pdf stm32f4.pdf lm3s.pdf lm4f.pdf lpc13.pdf lpc17.pdf lpc43.pdf efm32g.pdf efm32gg.pdf efm32lg.pdf efm32tg.pdf sam3a.pdf sam3n.pdf sam3s.pdf sam3u.pdf sam3x.pdf vf6xx.pdf
stm32l0.pdf:
cd stm32l0/; doxygen Doxyfile_latex; cd latex/; $(MAKE); cp refman.pdf ../../stm32l0.pdf
stm32l1.pdf:
cd stm32l1/; doxygen Doxyfile_latex; cd latex/; $(MAKE); cp refman.pdf ../../stm32l1.pdf
@ -147,5 +153,5 @@ vf6xx.pdf:
clean:
@rm -rf html/ */html/ */latex/ *.pdf */*.tag
.PHONY: doc html cm3 usb lm3s lm4f lpc13 lpc17 lpc43 stm32l1 stm32f0 stm32f1 stm32f2 stm32f3 stm32f4 efm32g efm32gg efm32lg efm32tg sam3a sam3n sam3s sam3u sam3x vf6xx top latex
.PHONY: doc html cm3 usb lm3s lm4f lpc13 lpc17 lpc43 stm32l0 stm32l1 stm32f0 stm32f1 stm32f2 stm32f3 stm32f4 efm32g efm32gg efm32lg efm32tg sam3a sam3n sam3s sam3u sam3x vf6xx top latex

1
doc/cm3/DoxygenLayout_cm3.xml

@ -10,6 +10,7 @@
<tab type="user" visible="yes" url="../../stm32f2/html/modules.html" title="STM32F2" intro=""/>
<tab type="user" visible="yes" url="../../stm32f3/html/modules.html" title="STM32F3" intro=""/>
<tab type="user" visible="yes" url="../../stm32f4/html/modules.html" title="STM32F4" intro=""/>
<tab type="user" visible="yes" url="../../stm32l0/html/modules.html" title="STM32L0" intro=""/>
<tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/>
<tab type="user" visible="yes" url="../../lm3s/html/modules.html" title="LM3S" intro=""/>
<tab type="user" visible="yes" url="../../lm4f/html/modules.html" title="LM4F" intro=""/>

1
doc/efm32g/DoxygenLayout_efm32g.xml

@ -11,6 +11,7 @@
<tab type="user" visible="yes" url="../../stm32f2/html/modules.html" title="STM32F2" intro=""/>
<tab type="user" visible="yes" url="../../stm32f3/html/modules.html" title="STM32F3" intro=""/>
<tab type="user" visible="yes" url="../../stm32f4/html/modules.html" title="STM32F4" intro=""/>
<tab type="user" visible="yes" url="../../stm32l0/html/modules.html" title="STM32L0" intro=""/>
<tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/>
<tab type="user" visible="yes" url="../../lm3s/html/modules.html" title="LM3S" intro=""/>
<tab type="user" visible="yes" url="../../lm4f/html/modules.html" title="LM4F" intro=""/>

1
doc/efm32gg/DoxygenLayout_efm32gg.xml

@ -11,6 +11,7 @@
<tab type="user" visible="yes" url="../../stm32f2/html/modules.html" title="STM32F2" intro=""/>
<tab type="user" visible="yes" url="../../stm32f3/html/modules.html" title="STM32F3" intro=""/>
<tab type="user" visible="yes" url="../../stm32f4/html/modules.html" title="STM32F4" intro=""/>
<tab type="user" visible="yes" url="../../stm32l0/html/modules.html" title="STM32L0" intro=""/>
<tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/>
<tab type="user" visible="yes" url="../../lm3s/html/modules.html" title="LM3S" intro=""/>
<tab type="user" visible="yes" url="../../lm4f/html/modules.html" title="LM4F" intro=""/>

1
doc/efm32lg/DoxygenLayout_efm32lg.xml

@ -11,6 +11,7 @@
<tab type="user" visible="yes" url="../../stm32f2/html/modules.html" title="STM32F2" intro=""/>
<tab type="user" visible="yes" url="../../stm32f3/html/modules.html" title="STM32F3" intro=""/>
<tab type="user" visible="yes" url="../../stm32f4/html/modules.html" title="STM32F4" intro=""/>
<tab type="user" visible="yes" url="../../stm32l0/html/modules.html" title="STM32L0" intro=""/>
<tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/>
<tab type="user" visible="yes" url="../../lm3s/html/modules.html" title="LM3S" intro=""/>
<tab type="user" visible="yes" url="../../lm4f/html/modules.html" title="LM4F" intro=""/>

1
doc/efm32tg/DoxygenLayout_efm32tg.xml

@ -11,6 +11,7 @@
<tab type="user" visible="yes" url="../../stm32f2/html/modules.html" title="STM32F2" intro=""/>
<tab type="user" visible="yes" url="../../stm32f3/html/modules.html" title="STM32F3" intro=""/>
<tab type="user" visible="yes" url="../../stm32f4/html/modules.html" title="STM32F4" intro=""/>
<tab type="user" visible="yes" url="../../stm32l0/html/modules.html" title="STM32L0" intro=""/>
<tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/>
<tab type="user" visible="yes" url="../../lm3s/html/modules.html" title="LM3S" intro=""/>
<tab type="user" visible="yes" url="../../lm4f/html/modules.html" title="LM4F" intro=""/>

1
doc/lm3s/DoxygenLayout_lm3s.xml

@ -11,6 +11,7 @@
<tab type="user" visible="yes" url="../../stm32f2/html/modules.html" title="STM32F2" intro=""/>
<tab type="user" visible="yes" url="../../stm32f3/html/modules.html" title="STM32F3" intro=""/>
<tab type="user" visible="yes" url="../../stm32f4/html/modules.html" title="STM32F4" intro=""/>
<tab type="user" visible="yes" url="../../stm32l0/html/modules.html" title="STM32L0" intro=""/>
<tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/>
<tab type="modules" visible="yes" title="LM3S" intro=""/>
<tab type="user" visible="yes" url="../../lm4f/html/modules.html" title="LM4F" intro=""/>

1
doc/lm4f/DoxygenLayout_lm4f.xml

@ -11,6 +11,7 @@
<tab type="user" visible="yes" url="../../stm32f2/html/modules.html" title="STM32F2" intro=""/>
<tab type="user" visible="yes" url="../../stm32f3/html/modules.html" title="STM32F3" intro=""/>
<tab type="user" visible="yes" url="../../stm32f4/html/modules.html" title="STM32F4" intro=""/>
<tab type="user" visible="yes" url="../../stm32l0/html/modules.html" title="STM32L0" intro=""/>
<tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/>
<tab type="user" visible="yes" url="../../lm3s/html/modules.html" title="LM3S" intro=""/>
<tab type="modules" visible="yes" title="LM4F" intro=""/>

1
doc/lpc13xx/DoxygenLayout_lpc13xx.xml

@ -10,6 +10,7 @@
<tab type="user" visible="yes" url="../../stm32f1/html/modules.html" 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="../../stm32l0/html/modules.html" title="STM32L0" intro=""/>
<tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/>
<tab type="user" visible="yes" url="../../lm3s/html/modules.html" title="LM3S" intro=""/>
<tab type="user" visible="yes" url="../../lm4f/html/modules.html" title="LM4F" intro=""/>

1
doc/lpc17xx/DoxygenLayout_lpc17xx.xml

@ -10,6 +10,7 @@
<tab type="user" visible="yes" url="../../stm32f1/html/modules.html" 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="../../stm32l0/html/modules.html" title="STM32L0" intro=""/>
<tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/>
<tab type="user" visible="yes" url="../../lm3s/html/modules.html" title="LM3S" intro=""/>
<tab type="user" visible="yes" url="../../lm4f/html/modules.html" title="LM4F" intro=""/>

1
doc/lpc43xx/DoxygenLayout_lpc43xx.xml

@ -10,6 +10,7 @@
<tab type="user" visible="yes" url="../../stm32f1/html/modules.html" 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="../../stm32l0/html/modules.html" title="STM32L0" intro=""/>
<tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/>
<tab type="user" visible="yes" url="../../lm3s/html/modules.html" title="LM3S" intro=""/>
<tab type="user" visible="yes" url="../../lm4f/html/modules.html" title="LM4F" intro=""/>

1
doc/sam3a/DoxygenLayout_sam3a.xml

@ -11,6 +11,7 @@
<tab type="user" visible="yes" url="../../stm32f2/html/modules.html" title="STM32F2" intro=""/>
<tab type="user" visible="yes" url="../../stm32f3/html/modules.html" title="STM32F3" intro=""/>
<tab type="user" visible="yes" url="../../stm32f4/html/modules.html" title="STM32F4" intro=""/>
<tab type="user" visible="yes" url="../../stm32l0/html/modules.html" title="STM32L0" intro=""/>
<tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/>
<tab type="user" visible="yes" url="../../lm3s/html/modules.html" title="LM3S" intro=""/>
<tab type="user" visible="yes" url="../../lm4f/html/modules.html" title="LM4F" intro=""/>

1
doc/sam3n/DoxygenLayout_sam3n.xml

@ -11,6 +11,7 @@
<tab type="user" visible="yes" url="../../stm32f2/html/modules.html" title="STM32F2" intro=""/>
<tab type="user" visible="yes" url="../../stm32f3/html/modules.html" title="STM32F3" intro=""/>
<tab type="user" visible="yes" url="../../stm32f4/html/modules.html" title="STM32F4" intro=""/>
<tab type="user" visible="yes" url="../../stm32l0/html/modules.html" title="STM32L0" intro=""/>
<tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/>
<tab type="user" visible="yes" url="../../lm3s/html/modules.html" title="LM3S" intro=""/>
<tab type="user" visible="yes" url="../../lm4f/html/modules.html" title="LM4F" intro=""/>

1
doc/sam3s/DoxygenLayout_sam3s.xml

@ -11,6 +11,7 @@
<tab type="user" visible="yes" url="../../stm32f2/html/modules.html" title="STM32F2" intro=""/>
<tab type="user" visible="yes" url="../../stm32f3/html/modules.html" title="STM32F3" intro=""/>
<tab type="user" visible="yes" url="../../stm32f4/html/modules.html" title="STM32F4" intro=""/>
<tab type="user" visible="yes" url="../../stm32l0/html/modules.html" title="STM32L0" intro=""/>
<tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/>
<tab type="user" visible="yes" url="../../lm3s/html/modules.html" title="LM3S" intro=""/>
<tab type="user" visible="yes" url="../../lm4f/html/modules.html" title="LM4F" intro=""/>

1
doc/sam3u/DoxygenLayout_sam3u.xml

@ -11,6 +11,7 @@
<tab type="user" visible="yes" url="../../stm32f2/html/modules.html" title="STM32F2" intro=""/>
<tab type="user" visible="yes" url="../../stm32f3/html/modules.html" title="STM32F3" intro=""/>
<tab type="user" visible="yes" url="../../stm32f4/html/modules.html" title="STM32F4" intro=""/>
<tab type="user" visible="yes" url="../../stm32l0/html/modules.html" title="STM32L0" intro=""/>
<tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/>
<tab type="user" visible="yes" url="../../lm3s/html/modules.html" title="LM3S" intro=""/>
<tab type="user" visible="yes" url="../../lm4f/html/modules.html" title="LM4F" intro=""/>

1
doc/sam3x/DoxygenLayout_sam3x.xml

@ -11,6 +11,7 @@
<tab type="user" visible="yes" url="../../stm32f2/html/modules.html" title="STM32F2" intro=""/>
<tab type="user" visible="yes" url="../../stm32f3/html/modules.html" title="STM32F3" intro=""/>
<tab type="user" visible="yes" url="../../stm32f4/html/modules.html" title="STM32F4" intro=""/>
<tab type="user" visible="yes" url="../../stm32l0/html/modules.html" title="STM32L0" intro=""/>
<tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/>
<tab type="user" visible="yes" url="../../lm3s/html/modules.html" title="LM3S" intro=""/>
<tab type="user" visible="yes" url="../../lm4f/html/modules.html" title="LM4F" intro=""/>

1
doc/stm32f0/DoxygenLayout_stm32f0.xml

@ -11,6 +11,7 @@
<tab type="user" visible="yes" url="../../stm32f2/html/modules.html" title="STM32F2" intro=""/>
<tab type="user" visible="yes" url="../../stm32f3/html/modules.html" title="STM32F3" intro=""/>
<tab type="user" visible="yes" url="../../stm32f4/html/modules.html" title="STM32F4" intro=""/>
<tab type="user" visible="yes" url="../../stm32l0/html/modules.html" title="STM32L0" intro=""/>
<tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/>
<tab type="user" visible="yes" url="../../lm3s/html/modules.html" title="LM3S" intro=""/>
<tab type="user" visible="yes" url="../../lm4f/html/modules.html" title="LM4F" intro=""/>

1
doc/stm32f1/DoxygenLayout_stm32f1.xml

@ -11,6 +11,7 @@
<tab type="user" visible="yes" url="../../stm32f2/html/modules.html" title="STM32F2" intro=""/>
<tab type="user" visible="yes" url="../../stm32f3/html/modules.html" title="STM32F3" intro=""/>
<tab type="user" visible="yes" url="../../stm32f4/html/modules.html" title="STM32F4" intro=""/>
<tab type="user" visible="yes" url="../../stm32l0/html/modules.html" title="STM32L0" intro=""/>
<tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/>
<tab type="user" visible="yes" url="../../lm3s/html/modules.html" title="LM3S" intro=""/>
<tab type="user" visible="yes" url="../../lm4f/html/modules.html" title="LM4F" intro=""/>

1
doc/stm32f2/DoxygenLayout_stm32f2.xml

@ -11,6 +11,7 @@
<tab type="modules" visible="yes" title="STM32F2" intro=""/>
<tab type="user" visible="yes" url="../../stm32f3/html/modules.html" title="STM32F3" intro=""/>
<tab type="user" visible="yes" url="../../stm32f4/html/modules.html" title="STM32F4" intro=""/>
<tab type="user" visible="yes" url="../../stm32l0/html/modules.html" title="STM32L0" intro=""/>
<tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/>
<tab type="user" visible="yes" url="../../lm3s/html/modules.html" title="LM3S" intro=""/>
<tab type="user" visible="yes" url="../../lm4f/html/modules.html" title="LM4F" intro=""/>

1
doc/stm32f3/DoxygenLayout_stm32f3.xml

@ -11,6 +11,7 @@
<tab type="user" visible="yes" url="../../stm32f2/html/modules.html" title="STM32F2" intro=""/>
<tab type="modules" visible="yes" title="STM32F3" intro=""/>
<tab type="user" visible="yes" url="../../stm32f4/html/modules.html" title="STM32F4" intro=""/>
<tab type="user" visible="yes" url="../../stm32l0/html/modules.html" title="STM32L0" intro=""/>
<tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/>
<tab type="user" visible="yes" url="../../lm3s/html/modules.html" title="LM3S" intro=""/>
<tab type="user" visible="yes" url="../../lm4f/html/modules.html" title="LM4F" intro=""/>

1
doc/stm32f4/DoxygenLayout_stm32f4.xml

@ -11,6 +11,7 @@
<tab type="user" visible="yes" url="../../stm32f2/html/modules.html" title="STM32F2" intro=""/>
<tab type="user" visible="yes" url="../../stm32f3/html/modules.html" title="STM32F3" intro=""/>
<tab type="modules" visible="yes" title="STM32F4" intro=""/>
<tab type="user" visible="yes" url="../../stm32l0/html/modules.html" title="STM32L0" intro=""/>
<tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/>
<tab type="user" visible="yes" url="../../lm3s/html/modules.html" title="LM3S" intro=""/>
<tab type="user" visible="yes" url="../../lm4f/html/modules.html" title="LM4F" intro=""/>

43
doc/stm32l0/Doxyfile

@ -0,0 +1,43 @@
# HTML Documentation for STM32L0 code level
# 15 December 2012
# (C) Ken Sarkies <ksarkies@internode.on.net>
#---------------------------------------------------------------------------
# Common Include File
#---------------------------------------------------------------------------
@INCLUDE = ../Doxyfile_common
#---------------------------------------------------------------------------
# Local settings
#---------------------------------------------------------------------------
WARN_LOGFILE = doxygen_stm32l0.log
INPUT = ../../include/libopencm3/license.dox
INPUT +=../../include/libopencm3/stm32/l0
INPUT +=../../include/libopencm3/stm32/common
INPUT +=../../lib/stm32/l0
INPUT +=../../lib/stm32/common
EXCLUDE = ../../include/libopencm3/stm32/common/gpio_common_f24.h
EXCLUDE +=../../include/libopencm3/stm32/common/timer_common_f24.h \
EXCLUDE +=../../include/libopencm3/stm32/common/crypto_common_f24.h \
EXCLUDE +=../../include/libopencm3/stm32/common/hash_common_f24.h
EXCLUDE =../../lib/stm32/common/gpio_common_f24.c
EXCLUDE =../../lib/stm32/common/timer_common_f24.c
EXCLUDE =../../lib/stm32/common/crypto_common_f24.c
EXCLUDE =../../lib/stm32/common/hash_common_f24.c
EXCLUDE_PATTERNS =
LAYOUT_FILE = DoxygenLayout_stm32l0.xml
GENERATE_TAGFILE = stm32l0.tag
ENABLE_PREPROCESSING = YES

38
doc/stm32l0/Doxyfile_latex

@ -0,0 +1,38 @@
# LaTeX Documentation for STM32L0 code level
# 15 September 2014
# (C) Ken Sarkies <ksarkies@internode.on.net>
#---------------------------------------------------------------------------
# Common Include File
#---------------------------------------------------------------------------
@INCLUDE = ../Doxyfile_common
#---------------------------------------------------------------------------
# Local settings
#---------------------------------------------------------------------------
WARN_LOGFILE = doxygen_stm32l0_latex.log
INPUT = ../../include/libopencm3/docmain.dox
INPUT += ../../include/libopencm3/license.dox \
INPUT += ../../include/libopencm3/stm32/l0 \
INPUT += ../../include/libopencm3/stm32/common
INPUT += ../../lib/stm32/l0
INPUT += ../../lib/stm32/common
EXCLUDE = ../../include/libopencm3/stm32/l0/doc-stm32l0.h
EXCLUDE += ../../include/libopencm3/stm32/common/gpio_common_f24.h
EXCLUDE += ../../lib/stm32/common/gpio_common_f24.c
EXCLUDE_PATTERNS =
LAYOUT_FILE = DoxygenLayout_stm32l0.xml
GENERATE_HTML = NO
GENERATE_LATEX = YES
LATEX_HEADER = header_stm32l0.tex

207
doc/stm32l0/DoxygenLayout_stm32l0.xml

@ -0,0 +1,207 @@
<doxygenlayout version="1.0">
<!-- Navigation index tabs for HTML output -->
<navindex>
<tab type="mainpage" visible="yes" title="libopencm3"/>
<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="user" visible="yes" url="../../usb/html/modules.html" title="Generic USB" intro=""/>
<tab type="user" visible="yes" url="../../stm32f0/html/modules.html" title="STM32F0" intro=""/>
<tab type="user" visible="yes" url="../../stm32f1/html/modules.html" title="STM32F1" intro=""/>
<tab type="user" visible="yes" url="../../stm32f2/html/modules.html" title="STM32F2" intro=""/>
<tab type="user" visible="yes" url="../../stm32f3/html/modules.html" title="STM32F3" intro=""/>
<tab type="user" visible="yes" url="../../stm32f4/html/modules.html" title="STM32F4" intro=""/>
<tab type="modules" visible="yes" title="STM32L0" intro=""/>
<tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/>
<tab type="user" visible="yes" url="../../lm3s/html/modules.html" title="LM3S" intro=""/>
<tab type="user" visible="yes" url="../../lm4f/html/modules.html" title="LM4F" intro=""/>
<tab type="user" visible="yes" url="../../lpc13xx/html/modules.html" title="LPC13" intro=""/>
<tab type="user" visible="yes" url="../../lpc17xx/html/modules.html" title="LPC17" intro=""/>
<tab type="user" visible="yes" url="../../lpc43xx/html/modules.html" title="LPC43" intro=""/>
<tab type="user" visible="yes" url="../../efm32g/html/modules.html" title="EFM32 Gecko" intro=""/>
<tab type="user" visible="yes" url="../../efm32gg/html/modules.html" title="EFM32 Giant Gecko" intro=""/>
<tab type="user" visible="yes" url="../../efm32lg/html/modules.html" title="EFM32 Leopard Gecko" intro=""/>
<tab type="user" visible="yes" url="../../efm32tg/html/modules.html" title="EFM32 Tiny Gecko" intro=""/>
<tab type="user" visible="yes" url="../../sam3a/html/modules.html" title="SAM3A" intro=""/>
<tab type="user" visible="yes" url="../../sam3n/html/modules.html" title="SAM3N" intro=""/>
<tab type="user" visible="yes" url="../../sam3s/html/modules.html" title="SAM3S" intro=""/>
<tab type="user" visible="yes" url="../../sam3u/html/modules.html" title="SAM3U" intro=""/>
<tab type="user" visible="yes" url="../../sam3x/html/modules.html" title="SAM3X" intro=""/>
<tab type="namespaces" visible="yes" title="">
<tab type="namespaces" visible="yes" title="" intro=""/>
<tab type="namespacemembers" visible="yes" title="" intro=""/>
</tab>
<tab type="classes" visible="yes" title="">
<tab type="classes" visible="yes" title="" intro=""/>
<tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/>
<tab type="hierarchy" visible="yes" title="" intro=""/>
<tab type="classmembers" visible="yes" title="" intro=""/>
</tab>
<tab type="files" visible="yes" title="">
<tab type="files" visible="yes" title="" intro=""/>
<tab type="globals" visible="yes" title="" intro=""/>
</tab>
<tab type="examples" visible="yes" title="" intro=""/>
</navindex>
<!-- Layout definition for a class page -->
<class>
<briefdescription visible="yes"/>
<includes visible="$SHOW_INCLUDE_FILES"/>
<inheritancegraph visible="$CLASS_GRAPH"/>
<collaborationgraph visible="$COLLABORATION_GRAPH"/>
<allmemberslink visible="yes"/>
<memberdecl>
<nestedclasses visible="yes" title=""/>
<publictypes title=""/>
<publicslots title=""/>
<signals title=""/>
<publicmethods title=""/>
<publicstaticmethods title=""/>
<publicattributes title=""/>
<publicstaticattributes title=""/>
<protectedtypes title=""/>
<protectedslots title=""/>
<protectedmethods title=""/>
<protectedstaticmethods title=""/>
<protectedattributes title=""/>
<protectedstaticattributes title=""/>
<packagetypes title=""/>
<packagemethods title=""/>
<packagestaticmethods title=""/>
<packageattributes title=""/>
<packagestaticattributes title=""/>
<properties title=""/>
<events title=""/>
<privatetypes title=""/>
<privateslots title=""/>
<privatemethods title=""/>
<privatestaticmethods title=""/>
<privateattributes title=""/>
<privatestaticattributes title=""/>
<friends title=""/>
<related title="" subtitle=""/>
<membergroups visible="yes"/>
</memberdecl>
<detaileddescription title=""/>
<memberdef>
<typedefs title=""/>
<enums title=""/>
<constructors title=""/>
<functions title=""/>
<related title=""/>
<variables title=""/>
<properties title=""/>
<events title=""/>
</memberdef>
<usedfiles visible="$SHOW_USED_FILES"/>
<authorsection visible="yes"/>
</class>
<!-- Layout definition for a namespace page -->
<namespace>
<briefdescription visible="yes"/>
<memberdecl>
<nestednamespaces visible="yes" title=""/>
<classes visible="yes" title=""/>
<typedefs title=""/>
<enums title=""/>
<functions title=""/>
<variables title=""/>
<membergroups visible="yes"/>
</memberdecl>
<detaileddescription title=""/>
<memberdef>
<typedefs title=""/>
<enums title=""/>
<functions title=""/>
<variables title=""/>
</memberdef>
<authorsection visible="yes"/>
</namespace>
<!-- Layout definition for a file page -->
<file>
<briefdescription visible="yes"/>
<includes visible="$SHOW_INCLUDE_FILES"/>
<includegraph visible="$INCLUDE_GRAPH"/>
<includedbygraph visible="$INCLUDED_BY_GRAPH"/>
<sourcelink visible="yes"/>
<memberdecl>
<classes visible="yes" title=""/>
<namespaces visible="yes" title=""/>
<defines title=""/>
<typedefs title=""/>
<enums title=""/>
<functions title=""/>
<variables title=""/>
<membergroups visible="yes"/>
</memberdecl>
<detaileddescription title=""/>
<memberdef>
<defines title=""/>
<typedefs title=""/>
<enums title=""/>
<functions title=""/>
<variables title=""/>
</memberdef>
<authorsection/>
</file>
<!-- Layout definition for a group page -->
<group>
<briefdescription visible="yes"/>
<groupgraph visible="$GROUP_GRAPHS"/>
<memberdecl>
<classes visible="yes" title=""/>
<namespaces visible="yes" title=""/>
<dirs visible="yes" title=""/>
<nestedgroups visible="yes" title=""/>
<files visible="yes" title=""/>
<defines title=""/>
<typedefs title=""/>
<enums title=""/>
<enumvalues title=""/>
<functions title=""/>
<variables title=""/>
<signals title=""/>
<publicslots title=""/>
<protectedslots title=""/>
<privateslots title=""/>
<events title=""/>
<properties title=""/>
<friends title=""/>
<membergroups visible="yes"/>
</memberdecl>
<detaileddescription title=""/>
<memberdef>
<pagedocs/>
<inlineclasses title=""/>
<defines title=""/>
<typedefs title=""/>
<enums title=""/>
<enumvalues title=""/>
<functions title=""/>
<variables title=""/>
<signals title=""/>
<publicslots title=""/>
<protectedslots title=""/>
<privateslots title=""/>
<events title=""/>
<properties title=""/>
<friends title=""/>
</memberdef>
<authorsection visible="yes"/>
</group>
<!-- Layout definition for a directory page -->
<directory>
<briefdescription visible="yes"/>
<directorygraph visible="yes"/>
<memberdecl>
<dirs visible="yes"/>
<files visible="yes"/>
</memberdecl>
<detaileddescription title=""/>
</directory>
</doxygenlayout>

61
doc/stm32l0/header_stm32l0.tex

@ -0,0 +1,61 @@
\documentclass{book}
\usepackage[a4paper,top=2.5cm,bottom=2.5cm,left=2.5cm,right=2.5cm]{geometry}
\usepackage{makeidx}
\usepackage{natbib}
\usepackage{graphicx}
\usepackage{multicol}
\usepackage{float}
\usepackage{listings}
\usepackage{color}
\usepackage{ifthen}
\usepackage[table]{xcolor}
\usepackage{textcomp}
\usepackage{alltt}
\usepackage{ifpdf}
\ifpdf
\usepackage[pdftex,
pagebackref=true,
colorlinks=true,
linkcolor=blue,
unicode
]{hyperref}
\else
\usepackage[ps2pdf,
pagebackref=true,
colorlinks=true,
linkcolor=blue,
unicode
]{hyperref}
\usepackage{pspicture}
\fi
\usepackage[utf8]{inputenc}
\usepackage{mathptmx}
\usepackage[scaled=.90]{helvet}
\usepackage{courier}
\usepackage{sectsty}
\usepackage{amssymb}
\usepackage[titles]{tocloft}
\usepackage{doxygen}
\lstset{language=C++,inputencoding=utf8,basicstyle=\footnotesize,breaklines=true,breakatwhitespace=true,tabsize=4,numbers=left }
\makeindex
\setcounter{tocdepth}{3}
\renewcommand{\footrulewidth}{0.4pt}
\renewcommand{\familydefault}{\sfdefault}
\hfuzz=15pt
\setlength{\emergencystretch}{15pt}
\hbadness=750
\tolerance=750
\begin{document}
\hypersetup{pageanchor=false,citecolor=blue}
\begin{titlepage}
\vspace*{7cm}
\begin{center}
{\Huge libopencm3: API Reference\\ STM STM32L0 ARM Cortex M0 Series}\\
\vspace*{1cm}
{\large Generated by Doxygen 1.8.2}\\
\vspace*{0.5cm}
{\small Thu Sep 13 2012 23:26:45}\\
\end{center}
\end{titlepage}
\pagenumbering{arabic}
\hypersetup{pageanchor=true,citecolor=blue}

8
doc/stm32l0/index.html

@ -0,0 +1,8 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="refresh" content="0;URL='html/index.html'" />
</head>
<body>
<a href="html/index.html">Documentation index</a></p>
</body>
</html>

1
doc/stm32l1/DoxygenLayout_stm32l1.xml

@ -11,6 +11,7 @@
<tab type="user" visible="yes" url="../../stm32f2/html/modules.html" title="STM32F2" intro=""/>
<tab type="user" visible="yes" url="../../stm32f3/html/modules.html" title="STM32F3" intro=""/>
<tab type="user" visible="yes" url="../../stm32f4/html/modules.html" title="STM32F4" intro=""/>
<tab type="user" visible="yes" url="../../stm32l0/html/modules.html" title="STM32L0" intro=""/>
<tab type="modules" visible="yes" title="STM32L1" intro=""/>
<tab type="user" visible="yes" url="../../lm3s/html/modules.html" title="LM3S" intro=""/>
<tab type="user" visible="yes" url="../../lm4f/html/modules.html" title="LM4F" intro=""/>

1
doc/usb/DoxygenLayout_usb.xml

@ -11,6 +11,7 @@
<tab type="user" visible="yes" url="../../stm32f2/html/modules.html" title="STM32F2" intro=""/>
<tab type="user" visible="yes" url="../../stm32f3/html/modules.html" title="STM32F3" intro=""/>
<tab type="user" visible="yes" url="../../stm32f4/html/modules.html" title="STM32F4" intro=""/>
<tab type="user" visible="yes" url="../../stm32l0/html/modules.html" title="STM32L0" intro=""/>
<tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/>
<tab type="user" visible="yes" url="../../lm3s/html/modules.html" title="LM3S" intro=""/>
<tab type="user" visible="yes" url="../../lm4f/html/modules.html" title="LM4F" intro=""/>

32
include/libopencm3/stm32/l0/doc-stm32l0.h

@ -0,0 +1,32 @@
/** @mainpage libopencm3 STM32L0
@version 1.0.0
@date 15 November 2014
API documentation for ST Microelectronics STM32L0 Cortex M0 series.
LGPL License Terms @ref lgpl_license
*/
/** @defgroup STM32L0xx STM32L0xx
Libraries for ST Microelectronics STM32L0xx series.
@version 1.0.0
@date 15 November 2014
LGPL License Terms @ref lgpl_license
*/
/** @defgroup STM32L0xx_defines STM32L0xx Defines
@brief Defined Constants and Types for the STM32L0xx series
@version 1.0.0
@date 7 September 2012
LGPL License Terms @ref lgpl_license
*/
Loading…
Cancel
Save