diff options
author | Karl Palsson <karlp@tweak.net.au> | 2015-11-11 02:46:05 +0300 |
---|---|---|
committer | Karl Palsson <karlp@tweak.net.au> | 2015-11-11 03:51:08 +0300 |
commit | 7233d1112cd69a2c7d8a0026cc90e36ce60c849d (patch) | |
tree | e1c12a507731e0b406f24a30f25b70ea8f48b6cc /doc | |
parent | 507c184456ed9403624e42190d9ccde75967df2b (diff) |
stm32l4: Add to documentation build
Don't include any of the common files yet, we're only getting a stub framework
up for further work.
This is mostly noise adding links from the other families to make the l4
"exist"
Diffstat (limited to 'doc')
31 files changed, 382 insertions, 1 deletions
diff --git a/doc/DoxygenLayout.xml b/doc/DoxygenLayout.xml index ea54c494..98075380 100644 --- a/doc/DoxygenLayout.xml +++ b/doc/DoxygenLayout.xml @@ -14,6 +14,7 @@ <tab type="user" visible="yes" url="../stm32f7/html/modules.html" title="STM32F7" intro=""/> <tab type="user" visible="yes" url="../stm32l0/html/modules.html" title="STM32L0" intro=""/> <tab type="user" visible="yes" url="../stm32l1/html/modules.html" title="STM32L1" intro=""/> + <tab type="user" visible="yes" url="../stm32l4/html/modules.html" title="STM32L4" 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=""/> diff --git a/doc/Makefile b/doc/Makefile index 5b1ac1f9..a4b93fb1 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -4,7 +4,7 @@ # (C) Ken Sarkies <ksarkies@internode.on.net> ARCHS := stm32f0 stm32f1 stm32f2 stm32f3 stm32f4 stm32f7 -ARCHS += stm32l0 stm32l1 +ARCHS += stm32l0 stm32l1 stm32l4 ARCHS += efm32g efm32gg efm32lg efm32tg ARCHS += lm3s lm4f ARCHS += lpc13xx lpc17xx lpc43xx diff --git a/doc/cm3/DoxygenLayout_cm3.xml b/doc/cm3/DoxygenLayout_cm3.xml index 136c6bf5..8173b18e 100644 --- a/doc/cm3/DoxygenLayout_cm3.xml +++ b/doc/cm3/DoxygenLayout_cm3.xml @@ -13,6 +13,7 @@ <tab type="user" visible="yes" url="../../stm32f7/html/modules.html" title="STM32F7" intro=""/> <tab type="user" visible="yes" url="../../stm32l0/html/modules.html" title="STM32L0" intro=""/> <tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/> + <tab type="user" visible="yes" url="../../stm32l4/html/modules.html" title="STM32L4" 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=""/> diff --git a/doc/efm32g/DoxygenLayout_efm32g.xml b/doc/efm32g/DoxygenLayout_efm32g.xml index 2738abda..8c1fae61 100644 --- a/doc/efm32g/DoxygenLayout_efm32g.xml +++ b/doc/efm32g/DoxygenLayout_efm32g.xml @@ -14,6 +14,7 @@ <tab type="user" visible="yes" url="../../stm32f7/html/modules.html" title="STM32F7" intro=""/> <tab type="user" visible="yes" url="../../stm32l0/html/modules.html" title="STM32L0" intro=""/> <tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/> + <tab type="user" visible="yes" url="../../stm32l4/html/modules.html" title="STM32L4" 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=""/> diff --git a/doc/efm32gg/DoxygenLayout_efm32gg.xml b/doc/efm32gg/DoxygenLayout_efm32gg.xml index bc1a3302..2b3bcf2c 100644 --- a/doc/efm32gg/DoxygenLayout_efm32gg.xml +++ b/doc/efm32gg/DoxygenLayout_efm32gg.xml @@ -14,6 +14,7 @@ <tab type="user" visible="yes" url="../../stm32f7/html/modules.html" title="STM32F7" intro=""/> <tab type="user" visible="yes" url="../../stm32l0/html/modules.html" title="STM32L0" intro=""/> <tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/> + <tab type="user" visible="yes" url="../../stm32l4/html/modules.html" title="STM32L4" 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=""/> diff --git a/doc/efm32lg/DoxygenLayout_efm32lg.xml b/doc/efm32lg/DoxygenLayout_efm32lg.xml index 3d58f090..7517a3b8 100644 --- a/doc/efm32lg/DoxygenLayout_efm32lg.xml +++ b/doc/efm32lg/DoxygenLayout_efm32lg.xml @@ -14,6 +14,7 @@ <tab type="user" visible="yes" url="../../stm32f7/html/modules.html" title="STM32F7" intro=""/> <tab type="user" visible="yes" url="../../stm32l0/html/modules.html" title="STM32L0" intro=""/> <tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/> + <tab type="user" visible="yes" url="../../stm32l4/html/modules.html" title="STM32L4" 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=""/> diff --git a/doc/efm32tg/DoxygenLayout_efm32tg.xml b/doc/efm32tg/DoxygenLayout_efm32tg.xml index 5b1079a0..ac1cba91 100644 --- a/doc/efm32tg/DoxygenLayout_efm32tg.xml +++ b/doc/efm32tg/DoxygenLayout_efm32tg.xml @@ -14,6 +14,7 @@ <tab type="user" visible="yes" url="../../stm32f7/html/modules.html" title="STM32F7" intro=""/> <tab type="user" visible="yes" url="../../stm32l0/html/modules.html" title="STM32L0" intro=""/> <tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/> + <tab type="user" visible="yes" url="../../stm32l4/html/modules.html" title="STM32L4" 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=""/> diff --git a/doc/lm3s/DoxygenLayout_lm3s.xml b/doc/lm3s/DoxygenLayout_lm3s.xml index f89e4da3..178c9078 100644 --- a/doc/lm3s/DoxygenLayout_lm3s.xml +++ b/doc/lm3s/DoxygenLayout_lm3s.xml @@ -14,6 +14,7 @@ <tab type="user" visible="yes" url="../../stm32f7/html/modules.html" title="STM32F7" intro=""/> <tab type="user" visible="yes" url="../../stm32l0/html/modules.html" title="STM32L0" intro=""/> <tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/> + <tab type="user" visible="yes" url="../../stm32l4/html/modules.html" title="STM32L4" intro=""/> <tab type="modules" visible="yes" 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=""/> diff --git a/doc/lm4f/DoxygenLayout_lm4f.xml b/doc/lm4f/DoxygenLayout_lm4f.xml index 7b3c7898..5e3fb0ad 100644 --- a/doc/lm4f/DoxygenLayout_lm4f.xml +++ b/doc/lm4f/DoxygenLayout_lm4f.xml @@ -14,6 +14,7 @@ <tab type="user" visible="yes" url="../../stm32f7/html/modules.html" title="STM32F7" intro=""/> <tab type="user" visible="yes" url="../../stm32l0/html/modules.html" title="STM32L0" intro=""/> <tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/> + <tab type="user" visible="yes" url="../../stm32l4/html/modules.html" title="STM32L4" intro=""/> <tab type="user" visible="yes" url="../../lm3s/html/modules.html" title="LM3S" intro=""/> <tab type="modules" visible="yes" title="LM4F" intro=""/> <tab type="user" visible="yes" url="../../lpc13xx/html/modules.html" title="LPC13" intro=""/> diff --git a/doc/lpc13xx/DoxygenLayout_lpc13xx.xml b/doc/lpc13xx/DoxygenLayout_lpc13xx.xml index c35dc3c0..a21c8a8a 100644 --- a/doc/lpc13xx/DoxygenLayout_lpc13xx.xml +++ b/doc/lpc13xx/DoxygenLayout_lpc13xx.xml @@ -13,6 +13,7 @@ <tab type="user" visible="yes" url="../../stm32f7/html/modules.html" title="STM32F7" intro=""/> <tab type="user" visible="yes" url="../../stm32l0/html/modules.html" title="STM32L0" intro=""/> <tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/> + <tab type="user" visible="yes" url="../../stm32l4/html/modules.html" title="STM32L4" 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="modules" visible="yes" title="LPC13" intro=""/> diff --git a/doc/lpc17xx/DoxygenLayout_lpc17xx.xml b/doc/lpc17xx/DoxygenLayout_lpc17xx.xml index 7c151b11..e82a7def 100644 --- a/doc/lpc17xx/DoxygenLayout_lpc17xx.xml +++ b/doc/lpc17xx/DoxygenLayout_lpc17xx.xml @@ -13,6 +13,7 @@ <tab type="user" visible="yes" url="../../stm32f7/html/modules.html" title="STM32F7" intro=""/> <tab type="user" visible="yes" url="../../stm32l0/html/modules.html" title="STM32L0" intro=""/> <tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/> + <tab type="user" visible="yes" url="../../stm32l4/html/modules.html" title="STM32L4" 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=""/> diff --git a/doc/lpc43xx/DoxygenLayout_lpc43xx.xml b/doc/lpc43xx/DoxygenLayout_lpc43xx.xml index 5e59dcf3..9c30b500 100644 --- a/doc/lpc43xx/DoxygenLayout_lpc43xx.xml +++ b/doc/lpc43xx/DoxygenLayout_lpc43xx.xml @@ -13,6 +13,7 @@ <tab type="user" visible="yes" url="../../stm32f7/html/modules.html" title="STM32F7" intro=""/> <tab type="user" visible="yes" url="../../stm32l0/html/modules.html" title="STM32L0" intro=""/> <tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/> + <tab type="user" visible="yes" url="../../stm32l4/html/modules.html" title="STM32L4" 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=""/> diff --git a/doc/sam3a/DoxygenLayout_sam3a.xml b/doc/sam3a/DoxygenLayout_sam3a.xml index 00eff856..46af0ce5 100644 --- a/doc/sam3a/DoxygenLayout_sam3a.xml +++ b/doc/sam3a/DoxygenLayout_sam3a.xml @@ -14,6 +14,7 @@ <tab type="user" visible="yes" url="../../stm32f7/html/modules.html" title="STM32F7" intro=""/> <tab type="user" visible="yes" url="../../stm32l0/html/modules.html" title="STM32L0" intro=""/> <tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/> + <tab type="user" visible="yes" url="../../stm32l4/html/modules.html" title="STM32L4" 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=""/> diff --git a/doc/sam3n/DoxygenLayout_sam3n.xml b/doc/sam3n/DoxygenLayout_sam3n.xml index eae8940e..4a5152c1 100644 --- a/doc/sam3n/DoxygenLayout_sam3n.xml +++ b/doc/sam3n/DoxygenLayout_sam3n.xml @@ -14,6 +14,7 @@ <tab type="user" visible="yes" url="../../stm32f7/html/modules.html" title="STM32F7" intro=""/> <tab type="user" visible="yes" url="../../stm32l0/html/modules.html" title="STM32L0" intro=""/> <tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/> + <tab type="user" visible="yes" url="../../stm32l4/html/modules.html" title="STM32L4" 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=""/> diff --git a/doc/sam3s/DoxygenLayout_sam3s.xml b/doc/sam3s/DoxygenLayout_sam3s.xml index 240ca46c..71305c80 100644 --- a/doc/sam3s/DoxygenLayout_sam3s.xml +++ b/doc/sam3s/DoxygenLayout_sam3s.xml @@ -14,6 +14,7 @@ <tab type="user" visible="yes" url="../../stm32f7/html/modules.html" title="STM32F7" intro=""/> <tab type="user" visible="yes" url="../../stm32l0/html/modules.html" title="STM32L0" intro=""/> <tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/> + <tab type="user" visible="yes" url="../../stm32l4/html/modules.html" title="STM32L4" 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=""/> diff --git a/doc/sam3u/DoxygenLayout_sam3u.xml b/doc/sam3u/DoxygenLayout_sam3u.xml index ca4a4e67..85023287 100644 --- a/doc/sam3u/DoxygenLayout_sam3u.xml +++ b/doc/sam3u/DoxygenLayout_sam3u.xml @@ -14,6 +14,7 @@ <tab type="user" visible="yes" url="../../stm32f7/html/modules.html" title="STM32F7" intro=""/> <tab type="user" visible="yes" url="../../stm32l0/html/modules.html" title="STM32L0" intro=""/> <tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/> + <tab type="user" visible="yes" url="../../stm32l4/html/modules.html" title="STM32L4" 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=""/> diff --git a/doc/sam3x/DoxygenLayout_sam3x.xml b/doc/sam3x/DoxygenLayout_sam3x.xml index b17c38cd..da863df9 100644 --- a/doc/sam3x/DoxygenLayout_sam3x.xml +++ b/doc/sam3x/DoxygenLayout_sam3x.xml @@ -14,6 +14,7 @@ <tab type="user" visible="yes" url="../../stm32f7/html/modules.html" title="STM32F7" intro=""/> <tab type="user" visible="yes" url="../../stm32l0/html/modules.html" title="STM32L0" intro=""/> <tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/> + <tab type="user" visible="yes" url="../../stm32l4/html/modules.html" title="STM32L4" 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=""/> diff --git a/doc/stm32f0/DoxygenLayout_stm32f0.xml b/doc/stm32f0/DoxygenLayout_stm32f0.xml index 577cb951..0bdde1f0 100644 --- a/doc/stm32f0/DoxygenLayout_stm32f0.xml +++ b/doc/stm32f0/DoxygenLayout_stm32f0.xml @@ -14,6 +14,7 @@ <tab type="user" visible="yes" url="../../stm32f7/html/modules.html" title="STM32F7" intro=""/> <tab type="user" visible="yes" url="../../stm32l0/html/modules.html" title="STM32L0" intro=""/> <tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/> + <tab type="user" visible="yes" url="../../stm32l4/html/modules.html" title="STM32L4" 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=""/> diff --git a/doc/stm32f1/DoxygenLayout_stm32f1.xml b/doc/stm32f1/DoxygenLayout_stm32f1.xml index ccd68760..20e26e5e 100644 --- a/doc/stm32f1/DoxygenLayout_stm32f1.xml +++ b/doc/stm32f1/DoxygenLayout_stm32f1.xml @@ -14,6 +14,7 @@ <tab type="user" visible="yes" url="../../stm32f7/html/modules.html" title="STM32F7" intro=""/> <tab type="user" visible="yes" url="../../stm32l0/html/modules.html" title="STM32L0" intro=""/> <tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/> + <tab type="user" visible="yes" url="../../stm32l4/html/modules.html" title="STM32L4" 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=""/> diff --git a/doc/stm32f2/DoxygenLayout_stm32f2.xml b/doc/stm32f2/DoxygenLayout_stm32f2.xml index 485af00d..1b23e833 100644 --- a/doc/stm32f2/DoxygenLayout_stm32f2.xml +++ b/doc/stm32f2/DoxygenLayout_stm32f2.xml @@ -14,6 +14,7 @@ <tab type="user" visible="yes" url="../../stm32f7/html/modules.html" title="STM32F7" intro=""/> <tab type="user" visible="yes" url="../../stm32l0/html/modules.html" title="STM32L0" intro=""/> <tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/> + <tab type="user" visible="yes" url="../../stm32l4/html/modules.html" title="STM32L4" 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=""/> diff --git a/doc/stm32f3/DoxygenLayout_stm32f3.xml b/doc/stm32f3/DoxygenLayout_stm32f3.xml index abdbf8e3..814011b2 100644 --- a/doc/stm32f3/DoxygenLayout_stm32f3.xml +++ b/doc/stm32f3/DoxygenLayout_stm32f3.xml @@ -14,6 +14,7 @@ <tab type="user" visible="yes" url="../../stm32f7/html/modules.html" title="STM32F7" intro=""/> <tab type="user" visible="yes" url="../../stm32l0/html/modules.html" title="STM32L0" intro=""/> <tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/> + <tab type="user" visible="yes" url="../../stm32l4/html/modules.html" title="STM32L4" 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=""/> diff --git a/doc/stm32f4/DoxygenLayout_stm32f4.xml b/doc/stm32f4/DoxygenLayout_stm32f4.xml index 4dcd0918..3fcef60c 100644 --- a/doc/stm32f4/DoxygenLayout_stm32f4.xml +++ b/doc/stm32f4/DoxygenLayout_stm32f4.xml @@ -14,6 +14,7 @@ <tab type="user" visible="yes" url="../../stm32f7/html/modules.html" title="STM32F7" intro=""/> <tab type="user" visible="yes" url="../../stm32l0/html/modules.html" title="STM32L0" intro=""/> <tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/> + <tab type="user" visible="yes" url="../../stm32l4/html/modules.html" title="STM32L4" 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=""/> diff --git a/doc/stm32f7/DoxygenLayout_stm32f7.xml b/doc/stm32f7/DoxygenLayout_stm32f7.xml index 067c4b8a..a44fbaf0 100644 --- a/doc/stm32f7/DoxygenLayout_stm32f7.xml +++ b/doc/stm32f7/DoxygenLayout_stm32f7.xml @@ -14,6 +14,7 @@ <tab type="modules" visible="yes" title="STM32F7" intro=""/> <tab type="user" visible="yes" url="../../stm32l0/html/modules.html" title="STM32L0" intro=""/> <tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/> + <tab type="user" visible="yes" url="../../stm32l4/html/modules.html" title="STM32L4" 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=""/> diff --git a/doc/stm32l0/DoxygenLayout_stm32l0.xml b/doc/stm32l0/DoxygenLayout_stm32l0.xml index f7e1add3..a50ef37f 100644 --- a/doc/stm32l0/DoxygenLayout_stm32l0.xml +++ b/doc/stm32l0/DoxygenLayout_stm32l0.xml @@ -14,6 +14,7 @@ <tab type="user" visible="yes" url="../../stm32f7/html/modules.html" title="STM32F7" intro=""/> <tab type="modules" visible="yes" title="STM32L0" intro=""/> <tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/> + <tab type="user" visible="yes" url="../../stm32l4/html/modules.html" title="STM32L4" 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=""/> diff --git a/doc/stm32l1/DoxygenLayout_stm32l1.xml b/doc/stm32l1/DoxygenLayout_stm32l1.xml index 039ec48c..b2d19af9 100644 --- a/doc/stm32l1/DoxygenLayout_stm32l1.xml +++ b/doc/stm32l1/DoxygenLayout_stm32l1.xml @@ -14,6 +14,7 @@ <tab type="user" visible="yes" url="../../stm32f7/html/modules.html" title="STM32F7" intro=""/> <tab type="user" visible="yes" url="../../stm32l0/html/modules.html" title="STM32L0" intro=""/> <tab type="modules" visible="yes" title="STM32L1" intro=""/> + <tab type="user" visible="yes" url="../../stm32l4/html/modules.html" title="STM32L4" 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=""/> diff --git a/doc/stm32l4/Doxyfile b/doc/stm32l4/Doxyfile new file mode 100644 index 00000000..1fd89062 --- /dev/null +++ b/doc/stm32l4/Doxyfile @@ -0,0 +1,39 @@ +# HTML Documentation for STM32L4 code level + +# 15 December 2012 +# (C) Ken Sarkies <ksarkies@internode.on.net> + +#--------------------------------------------------------------------------- +# Common Include File +#--------------------------------------------------------------------------- + +@INCLUDE = ../Doxyfile_common + +#--------------------------------------------------------------------------- +# Local settings +#--------------------------------------------------------------------------- + +WARN_LOGFILE = doxygen_stm32l4.log + +INPUT = ../../include/libopencm3/license.dox +INPUT +=../../include/libopencm3/stm32/l4 +#INPUT +=../../include/libopencm3/stm32/common + +INPUT +=../../lib/stm32/l4 +#INPUT +=../../lib/stm32/common + +# No headers to exclude until we include some! +EXCLUDE = + +# No libs to exclude until we include some! +EXCLUDE = + +EXCLUDE_PATTERNS = + +LAYOUT_FILE = DoxygenLayout_stm32l4.xml + +GENERATE_TAGFILE = stm32l4.tag + +ENABLE_PREPROCESSING = YES + + diff --git a/doc/stm32l4/Doxyfile_latex b/doc/stm32l4/Doxyfile_latex new file mode 100644 index 00000000..c03cb756 --- /dev/null +++ b/doc/stm32l4/Doxyfile_latex @@ -0,0 +1,38 @@ +# LaTeX Documentation for STM32L4 code level + +# 15 September 2014 +# (C) Ken Sarkies <ksarkies@internode.on.net> + +#--------------------------------------------------------------------------- +# Common Include File +#--------------------------------------------------------------------------- + +@INCLUDE = ../Doxyfile_common + +#--------------------------------------------------------------------------- +# Local settings +#--------------------------------------------------------------------------- + +WARN_LOGFILE = doxygen_stm32l4_latex.log + +INPUT = ../../include/libopencm3/docmain.dox +INPUT += ../../include/libopencm3/license.dox \ +INPUT += ../../include/libopencm3/stm32/l4 \ +INPUT += ../../include/libopencm3/stm32/common +INPUT += ../../lib/stm32/l4 +INPUT += ../../lib/stm32/common + +EXCLUDE = ../../include/libopencm3/stm32/l4/doc-stm32l4.h +EXCLUDE += ../../include/libopencm3/stm32/common/gpio_common_f24.h +EXCLUDE += ../../lib/stm32/common/gpio_common_f24.c + +EXCLUDE_PATTERNS = + +LAYOUT_FILE = DoxygenLayout_stm32l4.xml + +GENERATE_HTML = NO + +GENERATE_LATEX = YES + +LATEX_HEADER = header_stm32l4.tex + diff --git a/doc/stm32l4/DoxygenLayout_stm32l4.xml b/doc/stm32l4/DoxygenLayout_stm32l4.xml new file mode 100644 index 00000000..2049aff0 --- /dev/null +++ b/doc/stm32l4/DoxygenLayout_stm32l4.xml @@ -0,0 +1,210 @@ +<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="../../stm32f7/html/modules.html" title="STM32F7" intro=""/> + <tab type="user" visible="yes" url="../../stm32l0/html/modules.html" title="STM32L0" intro=""/> + <tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/> + <tab type="modules" visible="yes" title="STM32L4" 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="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=""/> + </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/stm32l4/header_stm32l4.tex b/doc/stm32l4/header_stm32l4.tex new file mode 100644 index 00000000..4ff6359a --- /dev/null +++ b/doc/stm32l4/header_stm32l4.tex @@ -0,0 +1,61 @@ +\documentclass{book} +\usepackage[a4paper,top=2.5cm,bottom=2.5cm,left=2.5cm,right=2.5cm]{geometry} +\usepackage{makeidx} +\usepackage{natbib} +\usepackage{graphicx} +\usepackage{multicol} +\usepackage{float} +\usepackage{listings} +\usepackage{color} +\usepackage{ifthen} +\usepackage[table]{xcolor} +\usepackage{textcomp} +\usepackage{alltt} +\usepackage{ifpdf} +\ifpdf +\usepackage[pdftex, + pagebackref=true, + colorlinks=true, + linkcolor=blue, + unicode + ]{hyperref} +\else +\usepackage[ps2pdf, + pagebackref=true, + colorlinks=true, + linkcolor=blue, + unicode + ]{hyperref} +\usepackage{pspicture} +\fi +\usepackage[utf8]{inputenc} +\usepackage{mathptmx} +\usepackage[scaled=.90]{helvet} +\usepackage{courier} +\usepackage{sectsty} +\usepackage{amssymb} +\usepackage[titles]{tocloft} +\usepackage{doxygen} +\lstset{language=C++,inputencoding=utf8,basicstyle=\footnotesize,breaklines=true,breakatwhitespace=true,tabsize=4,numbers=left } +\makeindex +\setcounter{tocdepth}{3} +\renewcommand{\footrulewidth}{0.4pt} +\renewcommand{\familydefault}{\sfdefault} +\hfuzz=15pt +\setlength{\emergencystretch}{15pt} +\hbadness=750 +\tolerance=750 +\begin{document} +\hypersetup{pageanchor=false,citecolor=blue} +\begin{titlepage} +\vspace*{7cm} +\begin{center} +{\Huge libopencm3: API Reference\\ STM STM32L4 ARM Cortex M4 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/stm32l4/index.html b/doc/stm32l4/index.html new file mode 100644 index 00000000..7715877a --- /dev/null +++ b/doc/stm32l4/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/doc/usb/DoxygenLayout_usb.xml b/doc/usb/DoxygenLayout_usb.xml index c782d528..c140cbdb 100644 --- a/doc/usb/DoxygenLayout_usb.xml +++ b/doc/usb/DoxygenLayout_usb.xml @@ -13,6 +13,7 @@ <tab type="user" visible="yes" url="../../stm32f4/html/modules.html" title="STM32F4" intro=""/> <tab type="user" visible="yes" url="../../stm32l0/html/modules.html" title="STM32L0" intro=""/> <tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/> + <tab type="user" visible="yes" url="../../stm32l4/html/modules.html" title="STM32L4" 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=""/> |