diff options
author | Stefan Agner <stefan@agner.ch> | 2014-07-03 17:05:43 +0400 |
---|---|---|
committer | Frantisek Burian <BuFran@seznam.cz> | 2014-10-15 21:31:02 +0400 |
commit | c83e16926e039c664ae296b1235cf26fedf6e55f (patch) | |
tree | 4ea4da3f3fb156d2ffaf9dccfda7b2194b49bc9c | |
parent | 3132ae50cbd2b7e695637985247baa4a750bd83c (diff) |
vf6xx: doc: initial commit
Add documentation Makefile and DoxygenLayout for Freescale Vybrid
VF6xx support.
31 files changed, 407 insertions, 3 deletions
@@ -31,6 +31,7 @@ include/libopencmsis/lpc17xx/ include/libopencmsis/lpc43xx/ include/libopencmsis/sam/ include/libopencmsis/stm32/ +include/libopencmsis/vf6xx/ # netbeans, intellij, eclipse project files netbeans diff --git a/doc/DoxygenLayout.xml b/doc/DoxygenLayout.xml index a01b6215..a860bce5 100644 --- a/doc/DoxygenLayout.xml +++ b/doc/DoxygenLayout.xml @@ -26,6 +26,7 @@ <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="user" visible="yes" url="../vf6xx/html/modules.html" title="VF6XX" 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 95e394c1..ab02efeb 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 sam3a sam3n sam3s sam3u sam3x top +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 cm3: cd cm3/; doxygen @@ -73,10 +73,13 @@ sam3u: sam3x: cd sam3x/; doxygen +vf6xx: + cd vf6xx/; 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 sam3a.pdf sam3n.pdf sam3s.pdf sam3u.pdf sam3x.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 vf6xx.pdf stm32l1.pdf: cd stm32l1/; doxygen Doxyfile_latex; cd latex/; $(MAKE); cp refman.pdf ../../stm32l1.pdf @@ -138,8 +141,11 @@ sam3u.pdf: sam3x.pdf: cd sam3x/; doxygen Doxyfile_latex; cd latex/; $(MAKE); cp refman.pdf ../../sam3x.pdf +vf6xx.pdf: + cd vf6xx/; doxygen Doxyfile_latex; cd latex/; $(MAKE); cp refman.pdf ../../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 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 vf6xx top latex diff --git a/doc/cm3/DoxygenLayout_cm3.xml b/doc/cm3/DoxygenLayout_cm3.xml index c4219af7..78df3364 100644 --- a/doc/cm3/DoxygenLayout_cm3.xml +++ b/doc/cm3/DoxygenLayout_cm3.xml @@ -25,6 +25,7 @@ <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="user" visible="yes" url="../../vf6xx/html/modules.html" title="VF6XX" 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 9ace984b..3ec76282 100644 --- a/doc/efm32g/DoxygenLayout_efm32g.xml +++ b/doc/efm32g/DoxygenLayout_efm32g.xml @@ -26,6 +26,7 @@ <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="user" visible="yes" url="../../vf6xx/html/modules.html" title="VF6XX" 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 ab7fb34a..5da81779 100644 --- a/doc/efm32gg/DoxygenLayout_efm32gg.xml +++ b/doc/efm32gg/DoxygenLayout_efm32gg.xml @@ -26,6 +26,7 @@ <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="user" visible="yes" url="../../vf6xx/html/modules.html" title="VF6XX" 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 fd07092e..cc2ab447 100644 --- a/doc/efm32lg/DoxygenLayout_efm32lg.xml +++ b/doc/efm32lg/DoxygenLayout_efm32lg.xml @@ -26,6 +26,7 @@ <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="user" visible="yes" url="../../vf6xx/html/modules.html" title="VF6XX" 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 f27b1145..e923dfe3 100644 --- a/doc/efm32tg/DoxygenLayout_efm32tg.xml +++ b/doc/efm32tg/DoxygenLayout_efm32tg.xml @@ -26,6 +26,7 @@ <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="user" visible="yes" url="../../vf6xx/html/modules.html" title="VF6XX" 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 73bb6735..0fd3343c 100644 --- a/doc/lm3s/DoxygenLayout_lm3s.xml +++ b/doc/lm3s/DoxygenLayout_lm3s.xml @@ -26,6 +26,7 @@ <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="user" visible="yes" url="../../vf6xx/html/modules.html" title="VF6XX" 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 710c4fc1..bd13a0e9 100644 --- a/doc/lm4f/DoxygenLayout_lm4f.xml +++ b/doc/lm4f/DoxygenLayout_lm4f.xml @@ -26,6 +26,7 @@ <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="user" visible="yes" url="../../vf6xx/html/modules.html" title="VF6XX" 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 3ca7013d..8e153ecf 100644 --- a/doc/lpc13xx/DoxygenLayout_lpc13xx.xml +++ b/doc/lpc13xx/DoxygenLayout_lpc13xx.xml @@ -25,6 +25,7 @@ <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="user" visible="yes" url="../../vf6xx/html/modules.html" title="VF6XX" 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 278d44f0..b154ab57 100644 --- a/doc/lpc17xx/DoxygenLayout_lpc17xx.xml +++ b/doc/lpc17xx/DoxygenLayout_lpc17xx.xml @@ -25,6 +25,7 @@ <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="user" visible="yes" url="../../vf6xx/html/modules.html" title="VF6XX" 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 6f6ad5b4..a7de0428 100644 --- a/doc/lpc43xx/DoxygenLayout_lpc43xx.xml +++ b/doc/lpc43xx/DoxygenLayout_lpc43xx.xml @@ -25,6 +25,7 @@ <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="user" visible="yes" url="../../vf6xx/html/modules.html" title="VF6XX" 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/DoxygenLayout_sam3a.xml b/doc/sam3a/DoxygenLayout_sam3a.xml index d1d425b1..1048daf0 100644 --- a/doc/sam3a/DoxygenLayout_sam3a.xml +++ b/doc/sam3a/DoxygenLayout_sam3a.xml @@ -26,6 +26,7 @@ <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="user" visible="yes" url="../../vf6xx/html/modules.html" title="VF6XX" 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/sam3n/DoxygenLayout_sam3n.xml b/doc/sam3n/DoxygenLayout_sam3n.xml index d7a17b8e..51a19fcc 100644 --- a/doc/sam3n/DoxygenLayout_sam3n.xml +++ b/doc/sam3n/DoxygenLayout_sam3n.xml @@ -26,6 +26,7 @@ <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="user" visible="yes" url="../../vf6xx/html/modules.html" title="VF6XX" 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/sam3s/DoxygenLayout_sam3s.xml b/doc/sam3s/DoxygenLayout_sam3s.xml index 83e4a36b..e8dfc72b 100644 --- a/doc/sam3s/DoxygenLayout_sam3s.xml +++ b/doc/sam3s/DoxygenLayout_sam3s.xml @@ -26,6 +26,7 @@ <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="user" visible="yes" url="../../vf6xx/html/modules.html" title="VF6XX" 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/sam3u/DoxygenLayout_sam3u.xml b/doc/sam3u/DoxygenLayout_sam3u.xml index f39f0de1..28b89354 100644 --- a/doc/sam3u/DoxygenLayout_sam3u.xml +++ b/doc/sam3u/DoxygenLayout_sam3u.xml @@ -26,6 +26,7 @@ <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="user" visible="yes" url="../../vf6xx/html/modules.html" title="VF6XX" 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/sam3x/DoxygenLayout_sam3x.xml b/doc/sam3x/DoxygenLayout_sam3x.xml index 717d3c10..97f05461 100644 --- a/doc/sam3x/DoxygenLayout_sam3x.xml +++ b/doc/sam3x/DoxygenLayout_sam3x.xml @@ -26,6 +26,7 @@ <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="user" visible="yes" url="../../vf6xx/html/modules.html" title="VF6XX" 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/stm32f0/DoxygenLayout_stm32f0.xml b/doc/stm32f0/DoxygenLayout_stm32f0.xml index 07b09bcc..8816377f 100644 --- a/doc/stm32f0/DoxygenLayout_stm32f0.xml +++ b/doc/stm32f0/DoxygenLayout_stm32f0.xml @@ -26,6 +26,7 @@ <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="user" visible="yes" url="../../vf6xx/html/modules.html" title="VF6XX" 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 9d5fea71..4760a406 100644 --- a/doc/stm32f1/DoxygenLayout_stm32f1.xml +++ b/doc/stm32f1/DoxygenLayout_stm32f1.xml @@ -26,6 +26,7 @@ <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="user" visible="yes" url="../../vf6xx/html/modules.html" title="VF6XX" 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 cd23ccd2..1099a6d4 100644 --- a/doc/stm32f2/DoxygenLayout_stm32f2.xml +++ b/doc/stm32f2/DoxygenLayout_stm32f2.xml @@ -26,6 +26,7 @@ <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="user" visible="yes" url="../../vf6xx/html/modules.html" title="VF6XX" 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 107a9c4e..3f077fea 100644 --- a/doc/stm32f3/DoxygenLayout_stm32f3.xml +++ b/doc/stm32f3/DoxygenLayout_stm32f3.xml @@ -26,6 +26,7 @@ <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="user" visible="yes" url="../../vf6xx/html/modules.html" title="VF6XX" 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 58f014f0..9b6cd9f7 100644 --- a/doc/stm32f4/DoxygenLayout_stm32f4.xml +++ b/doc/stm32f4/DoxygenLayout_stm32f4.xml @@ -26,6 +26,7 @@ <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="user" visible="yes" url="../../vf6xx/html/modules.html" title="VF6XX" 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 46fef450..5b09e390 100644 --- a/doc/stm32l1/DoxygenLayout_stm32l1.xml +++ b/doc/stm32l1/DoxygenLayout_stm32l1.xml @@ -26,6 +26,7 @@ <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="user" visible="yes" url="../../vf6xx/html/modules.html" title="VF6XX" 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 befab617..68f9f9f1 100644 --- a/doc/usb/DoxygenLayout_usb.xml +++ b/doc/usb/DoxygenLayout_usb.xml @@ -26,6 +26,7 @@ <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="user" visible="yes" url="../../vf6xx/html/modules.html" title="VF6XX" 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/vf6xx/Doxyfile b/doc/vf6xx/Doxyfile new file mode 100644 index 00000000..93dfb661 --- /dev/null +++ b/doc/vf6xx/Doxyfile @@ -0,0 +1,31 @@ +# HTML Documentation for VF6XX code level + +# 14 September 2012 +# (C) Ken Sarkies <ksarkies@internode.on.net> + +#--------------------------------------------------------------------------- +# Common Include File +#--------------------------------------------------------------------------- + +@INCLUDE = ../Doxyfile_common + +#--------------------------------------------------------------------------- +# Local settings +#--------------------------------------------------------------------------- + +WARN_LOGFILE = doxygen_vf6xx.log + +INPUT = ../../include/libopencm3/license.dox \ + ../../include/libopencm3/vf6xx + +INPUT += ../../lib/vf6xx + +EXCLUDE = + +LAYOUT_FILE = DoxygenLayout_vf6xx.xml + +GENERATE_TAGFILE = vf6xx.tag + +ENABLE_PREPROCESSING = YES + + diff --git a/doc/vf6xx/Doxyfile_latex b/doc/vf6xx/Doxyfile_latex new file mode 100644 index 00000000..34bf79b9 --- /dev/null +++ b/doc/vf6xx/Doxyfile_latex @@ -0,0 +1,35 @@ +# LaTeX Documentation for VF6XX code level + +# 14 September 2012 +# (C) Ken Sarkies <ksarkies@internode.on.net> + +#--------------------------------------------------------------------------- +# Common Include File +#--------------------------------------------------------------------------- + +@INCLUDE = ../Doxyfile_common + +#--------------------------------------------------------------------------- +# Local settings +#--------------------------------------------------------------------------- + +WARN_LOGFILE = doxygen_vf6xx_latex.log + +INPUT = ../../include/libopencm3/docmain.dox \ + ../../include/libopencm3/license.dox \ + ../../include/libopencm3/vf6xx + +INPUT += ../../lib/vf6xx + +EXCLUDE_PATTERNS = + +EXCLUDE = ../../include/libopencm3/vf6xx/doc-vf6xx.h + +LAYOUT_FILE = DoxygenLayout_vf6xx.xml + +GENERATE_HTML = NO + +GENERATE_LATEX = YES + +LATEX_HEADER = header_vf6xx.tex + diff --git a/doc/vf6xx/DoxygenLayout_vf6xx.xml b/doc/vf6xx/DoxygenLayout_vf6xx.xml new file mode 100644 index 00000000..714a2be9 --- /dev/null +++ b/doc/vf6xx/DoxygenLayout_vf6xx.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="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="modules" visible="yes" title="VF6XX" 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/vf6xx/header_vf6xx.tex b/doc/vf6xx/header_vf6xx.tex new file mode 100644 index 00000000..7493f832 --- /dev/null +++ b/doc/vf6xx/header_vf6xx.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\\ Freescale Vybrid VF6xx Series ARM Cortex-M4}\\ +\vspace*{1cm} +{\large Generated by Doxygen 1.8.2}\\ +\vspace*{0.5cm} +{\small Thu July 14 2014 14:26:45}\\ +\end{center} +\end{titlepage} +\pagenumbering{arabic} +\hypersetup{pageanchor=true,citecolor=blue} diff --git a/doc/vf6xx/index.html b/doc/vf6xx/index.html new file mode 100644 index 00000000..048aa174 --- /dev/null +++ b/doc/vf6xx/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> diff --git a/include/libopencm3/vf6xx/doc-vf6xx.h b/include/libopencm3/vf6xx/doc-vf6xx.h new file mode 100644 index 00000000..2fb634ae --- /dev/null +++ b/include/libopencm3/vf6xx/doc-vf6xx.h @@ -0,0 +1,32 @@ +/** @mainpage libopencm3 VF6xx + * + * @version 1.0.0 + * + * @date 03 July 2014 + * + * API documentation for Freescale VF6xx series Cortex-M4 core. + * + * LGPL License Terms @ref lgpl_license + */ + +/** @defgroup VF6xx VF6xx + * Libraries for Freescale VF6xx series Cortex-M4 core. + * + * @version 1.0.0 + * + * @date 03 July 2014 + * + * LGPL License Terms @ref lgpl_license + */ + +/** @defgroup VF6xx_defines VF6xx Defines + * + * @brief Defined Constants and Types for the VF6xx series + * + * @version 1.0.0 + * + * @date 03 July 2014 + * + * LGPL License Terms @ref lgpl_license + */ + |