diff options
author | Felix Held <felix-libopencm3@felixheld.de> | 2014-02-24 06:53:13 +0400 |
---|---|---|
committer | Karl Palsson <karlp@tweak.net.au> | 2014-02-24 22:35:22 +0400 |
commit | 5248bee6391c997bc9679b8202f8fd36bc13b4d2 (patch) | |
tree | dedb718b29451c56b7bf8ae908052898e0ce3aa7 /doc | |
parent | 641fbffe9a50795b42fe43ca6ff99a80bca97ec4 (diff) |
[sam3] show the sam3 subfamilies in the doxygen-generated documentation
Diffstat (limited to 'doc')
39 files changed, 1838 insertions, 3 deletions
diff --git a/doc/DoxygenLayout.xml b/doc/DoxygenLayout.xml index 2969bb05..a01b6215 100644 --- a/doc/DoxygenLayout.xml +++ b/doc/DoxygenLayout.xml @@ -21,6 +21,11 @@ <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=""/> diff --git a/doc/Makefile b/doc/Makefile index 4924543d..95e394c1 100644 --- a/doc/Makefile +++ b/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 top +html: cm3 usb stm32l1 stm32f0 stm32f1 stm32f2 stm32f3 stm32f4 efm32g efm32gg efm32lg efm32tg lm3s lm4f lpc13 lpc17 lpc43 sam3a sam3n sam3s sam3u sam3x top cm3: cd cm3/; doxygen @@ -58,10 +58,25 @@ stm32f4: stm32l1: cd stm32l1/; doxygen +sam3a: + cd sam3a/; doxygen + +sam3n: + cd sam3n/; doxygen + +sam3s: + cd sam3s/; doxygen + +sam3u: + cd sam3u/; doxygen + +sam3x: + cd sam3x/; doxygen + 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 +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 stm32l1.pdf: cd stm32l1/; doxygen Doxyfile_latex; cd latex/; $(MAKE); cp refman.pdf ../../stm32l1.pdf @@ -108,8 +123,23 @@ efm32lg.pdf: efm32tg.pdf: cd efm32tg/; doxygen Doxyfile_latex; cd latex/; $(MAKE); cp refman.pdf ../../efm32tg.pdf +sam3a.pdf: + cd sam3a/; doxygen Doxyfile_latex; cd latex/; $(MAKE); cp refman.pdf ../../sam3a.pdf + +sam3n.pdf: + cd sam3n/; doxygen Doxyfile_latex; cd latex/; $(MAKE); cp refman.pdf ../../sam3n.pdf + +sam3s.pdf: + cd sam3s/; doxygen Doxyfile_latex; cd latex/; $(MAKE); cp refman.pdf ../../sam3s.pdf + +sam3u.pdf: + cd sam3u/; doxygen Doxyfile_latex; cd latex/; $(MAKE); cp refman.pdf ../../sam3u.pdf + +sam3x.pdf: + cd sam3x/; doxygen Doxyfile_latex; cd latex/; $(MAKE); cp refman.pdf ../../sam3x.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 top latex +.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 top latex diff --git a/doc/cm3/DoxygenLayout_cm3.xml b/doc/cm3/DoxygenLayout_cm3.xml index 9311b149..c4219af7 100644 --- a/doc/cm3/DoxygenLayout_cm3.xml +++ b/doc/cm3/DoxygenLayout_cm3.xml @@ -20,6 +20,11 @@ <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=""/> diff --git a/doc/efm32g/DoxygenLayout_efm32g.xml b/doc/efm32g/DoxygenLayout_efm32g.xml index 38d943dc..9ace984b 100644 --- a/doc/efm32g/DoxygenLayout_efm32g.xml +++ b/doc/efm32g/DoxygenLayout_efm32g.xml @@ -21,6 +21,11 @@ <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=""/> diff --git a/doc/efm32gg/DoxygenLayout_efm32gg.xml b/doc/efm32gg/DoxygenLayout_efm32gg.xml index fa2d2f88..ab7fb34a 100644 --- a/doc/efm32gg/DoxygenLayout_efm32gg.xml +++ b/doc/efm32gg/DoxygenLayout_efm32gg.xml @@ -21,6 +21,11 @@ <tab type="modules" visible="yes" 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=""/> diff --git a/doc/efm32lg/DoxygenLayout_efm32lg.xml b/doc/efm32lg/DoxygenLayout_efm32lg.xml index 15201d98..fd07092e 100644 --- a/doc/efm32lg/DoxygenLayout_efm32lg.xml +++ b/doc/efm32lg/DoxygenLayout_efm32lg.xml @@ -21,6 +21,11 @@ <tab type="user" visible="yes" url="../../efm32gg/html/modules.html" title="EFM32 Giant Gecko" intro=""/> <tab type="modules" visible="yes" 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=""/> diff --git a/doc/efm32tg/DoxygenLayout_efm32tg.xml b/doc/efm32tg/DoxygenLayout_efm32tg.xml index 5e8d5146..f27b1145 100644 --- a/doc/efm32tg/DoxygenLayout_efm32tg.xml +++ b/doc/efm32tg/DoxygenLayout_efm32tg.xml @@ -21,6 +21,11 @@ <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="modules" visible="yes" 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=""/> diff --git a/doc/lm3s/DoxygenLayout_lm3s.xml b/doc/lm3s/DoxygenLayout_lm3s.xml index 110b3459..73bb6735 100644 --- a/doc/lm3s/DoxygenLayout_lm3s.xml +++ b/doc/lm3s/DoxygenLayout_lm3s.xml @@ -21,6 +21,11 @@ <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=""/> diff --git a/doc/lm4f/DoxygenLayout_lm4f.xml b/doc/lm4f/DoxygenLayout_lm4f.xml index 814cd4e5..710c4fc1 100644 --- a/doc/lm4f/DoxygenLayout_lm4f.xml +++ b/doc/lm4f/DoxygenLayout_lm4f.xml @@ -21,6 +21,11 @@ <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=""/> diff --git a/doc/lpc13xx/DoxygenLayout_lpc13xx.xml b/doc/lpc13xx/DoxygenLayout_lpc13xx.xml index b3a044f7..3ca7013d 100644 --- a/doc/lpc13xx/DoxygenLayout_lpc13xx.xml +++ b/doc/lpc13xx/DoxygenLayout_lpc13xx.xml @@ -20,6 +20,11 @@ <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=""/> diff --git a/doc/lpc17xx/DoxygenLayout_lpc17xx.xml b/doc/lpc17xx/DoxygenLayout_lpc17xx.xml index 86195f7b..278d44f0 100644 --- a/doc/lpc17xx/DoxygenLayout_lpc17xx.xml +++ b/doc/lpc17xx/DoxygenLayout_lpc17xx.xml @@ -20,6 +20,11 @@ <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=""/> diff --git a/doc/lpc43xx/DoxygenLayout_lpc43xx.xml b/doc/lpc43xx/DoxygenLayout_lpc43xx.xml index 231efad6..6f6ad5b4 100644 --- a/doc/lpc43xx/DoxygenLayout_lpc43xx.xml +++ b/doc/lpc43xx/DoxygenLayout_lpc43xx.xml @@ -20,6 +20,11 @@ <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=""/> diff --git a/doc/sam3a/Doxyfile b/doc/sam3a/Doxyfile new file mode 100644 index 00000000..4ec920c4 --- /dev/null +++ b/doc/sam3a/Doxyfile @@ -0,0 +1,37 @@ +# HTML Documentation for SAM3A code level + +# 14 September 2012 +# (C) Ken Sarkies <ksarkies@internode.on.net> +# 09 February 2014 +# (C) Felix Held <felix-libopencm3@felixheld.de> + +#--------------------------------------------------------------------------- +# Common Include File +#--------------------------------------------------------------------------- + +@INCLUDE = ../Doxyfile_common + +#--------------------------------------------------------------------------- +# Local settings +#--------------------------------------------------------------------------- + +WARN_LOGFILE = doxygen_sam3a.log + +INPUT = ../../include/libopencm3/license.dox \ + ../../include/libopencm3/sam/3a \ + ../../include/libopencm3/sam/common + +INPUT += ../../lib/sam/3a \ + ../../lib/sam/common + +EXCLUDE = + +EXCLUDE_PATTERNS = *_common_3n3s.h + +LAYOUT_FILE = DoxygenLayout_sam3a.xml + +GENERATE_TAGFILE = sam3a.tag + +ENABLE_PREPROCESSING = YES + + diff --git a/doc/sam3a/Doxyfile_latex b/doc/sam3a/Doxyfile_latex new file mode 100644 index 00000000..c20eb73c --- /dev/null +++ b/doc/sam3a/Doxyfile_latex @@ -0,0 +1,39 @@ +# LaTeX Documentation for SAM3A code level + +# 14 September 2012 +# (C) Ken Sarkies <ksarkies@internode.on.net> +# 09 February 2014 +# (C) Felix Held <felix-libopencm3@felixheld.de> + +#--------------------------------------------------------------------------- +# Common Include File +#--------------------------------------------------------------------------- + +@INCLUDE = ../Doxyfile_common + +#--------------------------------------------------------------------------- +# Local settings +#--------------------------------------------------------------------------- + +WARN_LOGFILE = doxygen_sam3a_latex.log + +INPUT = ../../include/libopencm3/docmain.dox \ + ../../include/libopencm3/license.dox \ + ../../include/libopencm3/sam/3a \ + ../../include/libopencm3/sam/common + +INPUT += ../../lib/sam/3a \ + ../../lib/sam/common + +EXCLUDE = + +EXCLUDE_PATTERNS = *_common_3n3s.h + +LAYOUT_FILE = DoxygenLayout_sam3a.xml + +GENERATE_HTML = NO + +GENERATE_LATEX = YES + +LATEX_HEADER = header_sam3a.tex + diff --git a/doc/sam3a/DoxygenLayout_sam3a.xml b/doc/sam3a/DoxygenLayout_sam3a.xml new file mode 100644 index 00000000..d1d425b1 --- /dev/null +++ b/doc/sam3a/DoxygenLayout_sam3a.xml @@ -0,0 +1,206 @@ +<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="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="modules" visible="yes" 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> diff --git a/doc/sam3a/header_sam3a.tex b/doc/sam3a/header_sam3a.tex new file mode 100644 index 00000000..89c48881 --- /dev/null +++ b/doc/sam3a/header_sam3a.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\\ Atmel SAM3A ARM Cortex M3 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} diff --git a/doc/sam3n/Doxyfile b/doc/sam3n/Doxyfile new file mode 100644 index 00000000..c268821c --- /dev/null +++ b/doc/sam3n/Doxyfile @@ -0,0 +1,37 @@ +# HTML Documentation for SAM3N code level + +# 14 September 2012 +# (C) Ken Sarkies <ksarkies@internode.on.net> +# 09 February 2014 +# (C) Felix Held <felix-libopencm3@felixheld.de> + +#--------------------------------------------------------------------------- +# Common Include File +#--------------------------------------------------------------------------- + +@INCLUDE = ../Doxyfile_common + +#--------------------------------------------------------------------------- +# Local settings +#--------------------------------------------------------------------------- + +WARN_LOGFILE = doxygen_sam3n.log + +INPUT = ../../include/libopencm3/license.dox \ + ../../include/libopencm3/sam/3n \ + ../../include/libopencm3/sam/common + +INPUT += ../../lib/sam/3n \ + ../../lib/sam/common + +EXCLUDE = + +EXCLUDE_PATTERNS = *_common_3a3u3x.h + +LAYOUT_FILE = DoxygenLayout_sam3n.xml + +GENERATE_TAGFILE = sam3n.tag + +ENABLE_PREPROCESSING = YES + + diff --git a/doc/sam3n/Doxyfile_latex b/doc/sam3n/Doxyfile_latex new file mode 100644 index 00000000..9583bc56 --- /dev/null +++ b/doc/sam3n/Doxyfile_latex @@ -0,0 +1,39 @@ +# LaTeX Documentation for SAM3N code level + +# 14 September 2012 +# (C) Ken Sarkies <ksarkies@internode.on.net> +# 09 February 2014 +# (C) Felix Held <felix-libopencm3@felixheld.de> + +#--------------------------------------------------------------------------- +# Common Include File +#--------------------------------------------------------------------------- + +@INCLUDE = ../Doxyfile_common + +#--------------------------------------------------------------------------- +# Local settings +#--------------------------------------------------------------------------- + +WARN_LOGFILE = doxygen_sam3n_latex.log + +INPUT = ../../include/libopencm3/docmain.dox \ + ../../include/libopencm3/license.dox \ + ../../include/libopencm3/sam/3n \ + ../../include/libopencm3/sam/common + +INPUT += ../../lib/sam/3n \ + ../../lib/sam/common + +EXCLUDE = + +EXCLUDE_PATTERNS = *_common_3a3u3x.h + +LAYOUT_FILE = DoxygenLayout_sam3n.xml + +GENERATE_HTML = NO + +GENERATE_LATEX = YES + +LATEX_HEADER = header_sam3n.tex + diff --git a/doc/sam3n/DoxygenLayout_sam3n.xml b/doc/sam3n/DoxygenLayout_sam3n.xml new file mode 100644 index 00000000..d7a17b8e --- /dev/null +++ b/doc/sam3n/DoxygenLayout_sam3n.xml @@ -0,0 +1,206 @@ +<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="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="modules" visible="yes" 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> diff --git a/doc/sam3n/header_sam3a.tex b/doc/sam3n/header_sam3a.tex new file mode 100644 index 00000000..987ced71 --- /dev/null +++ b/doc/sam3n/header_sam3a.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\\ Atmel SAM3N ARM Cortex M3 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} diff --git a/doc/sam3s/Doxyfile b/doc/sam3s/Doxyfile new file mode 100644 index 00000000..2c6a2ebb --- /dev/null +++ b/doc/sam3s/Doxyfile @@ -0,0 +1,37 @@ +# HTML Documentation for SAM3S code level + +# 14 September 2012 +# (C) Ken Sarkies <ksarkies@internode.on.net> +# 09 February 2014 +# (C) Felix Held <felix-libopencm3@felixheld.de> + +#--------------------------------------------------------------------------- +# Common Include File +#--------------------------------------------------------------------------- + +@INCLUDE = ../Doxyfile_common + +#--------------------------------------------------------------------------- +# Local settings +#--------------------------------------------------------------------------- + +WARN_LOGFILE = doxygen_sam3s.log + +INPUT = ../../include/libopencm3/license.dox \ + ../../include/libopencm3/sam/3s \ + ../../include/libopencm3/sam/common + +INPUT += ../../lib/sam/3a \ + ../../lib/sam/common + +EXCLUDE = + +EXCLUDE_PATTERNS = *_common_3a3u3x.h + +LAYOUT_FILE = DoxygenLayout_sam3s.xml + +GENERATE_TAGFILE = sam3s.tag + +ENABLE_PREPROCESSING = YES + + diff --git a/doc/sam3s/Doxyfile_latex b/doc/sam3s/Doxyfile_latex new file mode 100644 index 00000000..648f7a8f --- /dev/null +++ b/doc/sam3s/Doxyfile_latex @@ -0,0 +1,39 @@ +# LaTeX Documentation for SAM3S code level + +# 14 September 2012 +# (C) Ken Sarkies <ksarkies@internode.on.net> +# 09 February 2014 +# (C) Felix Held <felix-libopencm3@felixheld.de> + +#--------------------------------------------------------------------------- +# Common Include File +#--------------------------------------------------------------------------- + +@INCLUDE = ../Doxyfile_common + +#--------------------------------------------------------------------------- +# Local settings +#--------------------------------------------------------------------------- + +WARN_LOGFILE = doxygen_sam3s_latex.log + +INPUT = ../../include/libopencm3/docmain.dox \ + ../../include/libopencm3/license.dox \ + ../../include/libopencm3/sam/3s \ + ../../include/libopencm3/sam/common + +INPUT += ../../lib/sam/3s \ + ../../lib/sam/common + +EXCLUDE = + +EXCLUDE_PATTERNS = *_common_3a3u3x.h + +LAYOUT_FILE = DoxygenLayout_sam3s.xml + +GENERATE_HTML = NO + +GENERATE_LATEX = YES + +LATEX_HEADER = header_sam3s.tex + diff --git a/doc/sam3s/DoxygenLayout_sam3s.xml b/doc/sam3s/DoxygenLayout_sam3s.xml new file mode 100644 index 00000000..83e4a36b --- /dev/null +++ b/doc/sam3s/DoxygenLayout_sam3s.xml @@ -0,0 +1,206 @@ +<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="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="modules" visible="yes" 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> diff --git a/doc/sam3s/header_sam3a.tex b/doc/sam3s/header_sam3a.tex new file mode 100644 index 00000000..61e24c13 --- /dev/null +++ b/doc/sam3s/header_sam3a.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\\ Atmel SAM3S ARM Cortex M3 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} diff --git a/doc/sam3u/Doxyfile b/doc/sam3u/Doxyfile new file mode 100644 index 00000000..72fddf45 --- /dev/null +++ b/doc/sam3u/Doxyfile @@ -0,0 +1,37 @@ +# HTML Documentation for SAM3U code level + +# 14 September 2012 +# (C) Ken Sarkies <ksarkies@internode.on.net> +# 09 February 2014 +# (C) Felix Held <felix-libopencm3@felixheld.de> + +#--------------------------------------------------------------------------- +# Common Include File +#--------------------------------------------------------------------------- + +@INCLUDE = ../Doxyfile_common + +#--------------------------------------------------------------------------- +# Local settings +#--------------------------------------------------------------------------- + +WARN_LOGFILE = doxygen_sam3u.log + +INPUT = ../../include/libopencm3/license.dox \ + ../../include/libopencm3/sam/3u \ + ../../include/libopencm3/sam/common + +INPUT += ../../lib/sam/3u \ + ../../lib/sam/common + +EXCLUDE = + +EXCLUDE_PATTERNS = *_common_3n3s.h + +LAYOUT_FILE = DoxygenLayout_sam3u.xml + +GENERATE_TAGFILE = sam3u.tag + +ENABLE_PREPROCESSING = YES + + diff --git a/doc/sam3u/Doxyfile_latex b/doc/sam3u/Doxyfile_latex new file mode 100644 index 00000000..d732d6eb --- /dev/null +++ b/doc/sam3u/Doxyfile_latex @@ -0,0 +1,39 @@ +# LaTeX Documentation for SAM3U code level + +# 14 September 2012 +# (C) Ken Sarkies <ksarkies@internode.on.net> +# 09 February 2014 +# (C) Felix Held <felix-libopencm3@felixheld.de> + +#--------------------------------------------------------------------------- +# Common Include File +#--------------------------------------------------------------------------- + +@INCLUDE = ../Doxyfile_common + +#--------------------------------------------------------------------------- +# Local settings +#--------------------------------------------------------------------------- + +WARN_LOGFILE = doxygen_sam3u_latex.log + +INPUT = ../../include/libopencm3/docmain.dox \ + ../../include/libopencm3/license.dox \ + ../../include/libopencm3/sam/3u \ + ../../include/libopencm3/sam/common + +INPUT += ../../lib/sam/3u \ + ../../lib/sam/common + +EXCLUDE = + +EXCLUDE_PATTERNS = *_common_3n3s.h + +LAYOUT_FILE = DoxygenLayout_sam3u.xml + +GENERATE_HTML = NO + +GENERATE_LATEX = YES + +LATEX_HEADER = header_sam3u.tex + diff --git a/doc/sam3u/DoxygenLayout_sam3u.xml b/doc/sam3u/DoxygenLayout_sam3u.xml new file mode 100644 index 00000000..f39f0de1 --- /dev/null +++ b/doc/sam3u/DoxygenLayout_sam3u.xml @@ -0,0 +1,206 @@ +<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="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="modules" visible="yes" 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> diff --git a/doc/sam3u/header_sam3a.tex b/doc/sam3u/header_sam3a.tex new file mode 100644 index 00000000..79668b1b --- /dev/null +++ b/doc/sam3u/header_sam3a.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\\ Atmel SAM3U ARM Cortex M3 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} diff --git a/doc/sam3x/Doxyfile b/doc/sam3x/Doxyfile new file mode 100644 index 00000000..ce5e62a7 --- /dev/null +++ b/doc/sam3x/Doxyfile @@ -0,0 +1,37 @@ +# HTML Documentation for SAM3X code level + +# 14 September 2012 +# (C) Ken Sarkies <ksarkies@internode.on.net> +# 09 February 2014 +# (C) Felix Held <felix-libopencm3@felixheld.de> + +#--------------------------------------------------------------------------- +# Common Include File +#--------------------------------------------------------------------------- + +@INCLUDE = ../Doxyfile_common + +#--------------------------------------------------------------------------- +# Local settings +#--------------------------------------------------------------------------- + +WARN_LOGFILE = doxygen_sam3x.log + +INPUT = ../../include/libopencm3/license.dox \ + ../../include/libopencm3/sam/3x \ + ../../include/libopencm3/sam/common + +INPUT += ../../lib/sam/3x \ + ../../lib/sam/common + +EXCLUDE = + +EXCLUDE_PATTERNS = *_common_3n3s.h + +LAYOUT_FILE = DoxygenLayout_sam3x.xml + +GENERATE_TAGFILE = sam3x.tag + +ENABLE_PREPROCESSING = YES + + diff --git a/doc/sam3x/Doxyfile_latex b/doc/sam3x/Doxyfile_latex new file mode 100644 index 00000000..11e0105b --- /dev/null +++ b/doc/sam3x/Doxyfile_latex @@ -0,0 +1,39 @@ +# LaTeX Documentation for SAM3X code level + +# 14 September 2012 +# (C) Ken Sarkies <ksarkies@internode.on.net> +# 09 February 2014 +# (C) Felix Held <felix-libopencm3@felixheld.de> + +#--------------------------------------------------------------------------- +# Common Include File +#--------------------------------------------------------------------------- + +@INCLUDE = ../Doxyfile_common + +#--------------------------------------------------------------------------- +# Local settings +#--------------------------------------------------------------------------- + +WARN_LOGFILE = doxygen_sam3x_latex.log + +INPUT = ../../include/libopencm3/docmain.dox \ + ../../include/libopencm3/license.dox \ + ../../include/libopencm3/sam/3x \ + ../../include/libopencm3/sam/common + +INPUT += ../../lib/sam/3x \ + ../../lib/sam/common + +EXCLUDE = + +EXCLUDE_PATTERNS = *_common_3n3s.h + +LAYOUT_FILE = DoxygenLayout_sam3x.xml + +GENERATE_HTML = NO + +GENERATE_LATEX = YES + +LATEX_HEADER = header_sam3x.tex + diff --git a/doc/sam3x/DoxygenLayout_sam3x.xml b/doc/sam3x/DoxygenLayout_sam3x.xml new file mode 100644 index 00000000..717d3c10 --- /dev/null +++ b/doc/sam3x/DoxygenLayout_sam3x.xml @@ -0,0 +1,206 @@ +<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="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="modules" visible="yes" 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> diff --git a/doc/sam3x/header_sam3a.tex b/doc/sam3x/header_sam3a.tex new file mode 100644 index 00000000..b3c7e4ec --- /dev/null +++ b/doc/sam3x/header_sam3a.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\\ Atmel SAM3X ARM Cortex M3 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} diff --git a/doc/stm32f0/DoxygenLayout_stm32f0.xml b/doc/stm32f0/DoxygenLayout_stm32f0.xml index f614de0a..07b09bcc 100644 --- a/doc/stm32f0/DoxygenLayout_stm32f0.xml +++ b/doc/stm32f0/DoxygenLayout_stm32f0.xml @@ -21,6 +21,11 @@ <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=""/> diff --git a/doc/stm32f1/DoxygenLayout_stm32f1.xml b/doc/stm32f1/DoxygenLayout_stm32f1.xml index 12788889..9d5fea71 100644 --- a/doc/stm32f1/DoxygenLayout_stm32f1.xml +++ b/doc/stm32f1/DoxygenLayout_stm32f1.xml @@ -21,6 +21,11 @@ <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=""/> diff --git a/doc/stm32f2/DoxygenLayout_stm32f2.xml b/doc/stm32f2/DoxygenLayout_stm32f2.xml index f2bbfd41..cd23ccd2 100644 --- a/doc/stm32f2/DoxygenLayout_stm32f2.xml +++ b/doc/stm32f2/DoxygenLayout_stm32f2.xml @@ -21,6 +21,11 @@ <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=""/> diff --git a/doc/stm32f3/DoxygenLayout_stm32f3.xml b/doc/stm32f3/DoxygenLayout_stm32f3.xml index 79fb29d4..996481fa 100644 --- a/doc/stm32f3/DoxygenLayout_stm32f3.xml +++ b/doc/stm32f3/DoxygenLayout_stm32f3.xml @@ -21,6 +21,11 @@ <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=""/> diff --git a/doc/stm32f4/DoxygenLayout_stm32f4.xml b/doc/stm32f4/DoxygenLayout_stm32f4.xml index 7469ba16..58f014f0 100644 --- a/doc/stm32f4/DoxygenLayout_stm32f4.xml +++ b/doc/stm32f4/DoxygenLayout_stm32f4.xml @@ -21,6 +21,11 @@ <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=""/> diff --git a/doc/stm32l1/DoxygenLayout_stm32l1.xml b/doc/stm32l1/DoxygenLayout_stm32l1.xml index 4c6e59e7..46fef450 100644 --- a/doc/stm32l1/DoxygenLayout_stm32l1.xml +++ b/doc/stm32l1/DoxygenLayout_stm32l1.xml @@ -21,6 +21,11 @@ <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=""/> diff --git a/doc/usb/DoxygenLayout_usb.xml b/doc/usb/DoxygenLayout_usb.xml index 3773af81..befab617 100644 --- a/doc/usb/DoxygenLayout_usb.xml +++ b/doc/usb/DoxygenLayout_usb.xml @@ -21,6 +21,11 @@ <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=""/> |