From bdc38eed16693e84f6d6a4b3ec536b9b8736c2c1 Mon Sep 17 00:00:00 2001 From: Guillaume Revaillot Date: Sun, 17 Feb 2019 17:55:04 +0100 Subject: [PATCH] doc: attempt to get rid of doxygenlayouts and doxyfiles. Generate doc root doxygenlayout file, as well as devices stuff, based on main Makefile $(TARGETS) and template files. Avoids painfull sync/merge of 20 files+ when adding a new device. bonus : allow to build only one device doc easily (make TARGETS=stm32f0 doc) regression: we currently loose device "fancy" naming as device name is guessed (toUpper()..) from folder name. --- .gitignore | 5 +- doc/Makefile | 82 ++++--- doc/efm32g/Doxyfile | 27 --- doc/efm32g/DoxygenLayout_efm32g.xml | 210 ------------------ doc/efm32gg/Doxyfile | 27 --- doc/efm32gg/DoxygenLayout_efm32gg.xml | 210 ------------------ doc/efm32hg/Doxyfile | 25 --- doc/efm32hg/DoxygenLayout_efm32hg.xml | 210 ------------------ doc/efm32lg/Doxyfile | 27 --- doc/efm32lg/DoxygenLayout_efm32lg.xml | 210 ------------------ doc/efm32tg/Doxyfile | 27 --- doc/efm32tg/DoxygenLayout_efm32tg.xml | 210 ------------------ doc/lm3s/Doxyfile | 27 --- doc/lm3s/DoxygenLayout_lm3s.xml | 210 ------------------ doc/lm4f/Doxyfile | 27 --- doc/lpc13xx/Doxyfile | 27 --- doc/lpc13xx/DoxygenLayout_lpc13xx.xml | 210 ------------------ doc/lpc17xx/Doxyfile | 28 --- doc/lpc17xx/DoxygenLayout_lpc17xx.xml | 210 ------------------ doc/lpc43xx/Doxyfile | 28 --- doc/lpc43xx/DoxygenLayout_lpc43xx.xml | 210 ------------------ doc/msp432e4/Doxyfile | 11 - doc/msp432e4/DoxygenLayout_msp432e4.xml | 210 ------------------ doc/sam3a/Doxyfile | 29 --- doc/sam3a/DoxygenLayout_sam3a.xml | 210 ------------------ doc/sam3n/Doxyfile | 29 --- doc/sam3n/DoxygenLayout_sam3n.xml | 210 ------------------ doc/sam3s/Doxyfile | 29 --- doc/sam3s/DoxygenLayout_sam3s.xml | 210 ------------------ doc/sam3u/Doxyfile | 29 --- doc/sam3u/DoxygenLayout_sam3u.xml | 210 ------------------ doc/sam3x/Doxyfile | 29 --- doc/sam3x/DoxygenLayout_sam3x.xml | 210 ------------------ doc/stm32f0/Doxyfile | 27 --- doc/stm32f0/DoxygenLayout_stm32f0.xml | 210 ------------------ doc/stm32f0/index.html | 8 - doc/stm32f1/Doxyfile | 27 --- doc/stm32f1/DoxygenLayout_stm32f1.xml | 210 ------------------ doc/stm32f1/index.html | 8 - doc/stm32f2/Doxyfile | 27 --- doc/stm32f2/DoxygenLayout_stm32f2.xml | 210 ------------------ doc/stm32f2/index.html | 8 - doc/stm32f3/Doxyfile | 22 -- doc/stm32f3/DoxygenLayout_stm32f3.xml | 210 ------------------ doc/stm32f3/index.html | 8 - doc/stm32f4/Doxyfile | 27 --- doc/stm32f4/DoxygenLayout_stm32f4.xml | 210 ------------------ doc/stm32f4/index.html | 8 - doc/stm32f7/Doxyfile | 27 --- doc/stm32f7/DoxygenLayout_stm32f7.xml | 210 ------------------ doc/stm32f7/index.html | 8 - doc/stm32l0/Doxyfile | 27 --- doc/stm32l0/DoxygenLayout_stm32l0.xml | 210 ------------------ doc/stm32l0/index.html | 8 - doc/stm32l1/Doxyfile | 27 --- doc/stm32l1/DoxygenLayout_stm32l1.xml | 210 ------------------ doc/stm32l1/index.html | 8 - doc/stm32l4/Doxyfile | 27 --- doc/stm32l4/DoxygenLayout_stm32l4.xml | 210 ------------------ doc/stm32l4/index.html | 8 - doc/templates/Doxyfile_Device | 7 + .../DoxygenLayout_Device.xml} | 26 +-- .../DoxygenLayout_Root.xml} | 27 +-- doc/vf6xx/Doxyfile | 27 --- doc/vf6xx/DoxygenLayout_vf6xx.xml | 210 ------------------ doc/vf6xx/index.html | 8 - scripts/gendoxylayout.py | 68 ++++++ 67 files changed, 121 insertions(+), 6115 deletions(-) delete mode 100644 doc/efm32g/Doxyfile delete mode 100644 doc/efm32g/DoxygenLayout_efm32g.xml delete mode 100644 doc/efm32gg/Doxyfile delete mode 100644 doc/efm32gg/DoxygenLayout_efm32gg.xml delete mode 100644 doc/efm32hg/Doxyfile delete mode 100644 doc/efm32hg/DoxygenLayout_efm32hg.xml delete mode 100644 doc/efm32lg/Doxyfile delete mode 100644 doc/efm32lg/DoxygenLayout_efm32lg.xml delete mode 100644 doc/efm32tg/Doxyfile delete mode 100644 doc/efm32tg/DoxygenLayout_efm32tg.xml delete mode 100644 doc/lm3s/Doxyfile delete mode 100644 doc/lm3s/DoxygenLayout_lm3s.xml delete mode 100644 doc/lm4f/Doxyfile delete mode 100644 doc/lpc13xx/Doxyfile delete mode 100644 doc/lpc13xx/DoxygenLayout_lpc13xx.xml delete mode 100644 doc/lpc17xx/Doxyfile delete mode 100644 doc/lpc17xx/DoxygenLayout_lpc17xx.xml delete mode 100644 doc/lpc43xx/Doxyfile delete mode 100644 doc/lpc43xx/DoxygenLayout_lpc43xx.xml delete mode 100644 doc/msp432e4/Doxyfile delete mode 100644 doc/msp432e4/DoxygenLayout_msp432e4.xml delete mode 100644 doc/sam3a/Doxyfile delete mode 100644 doc/sam3a/DoxygenLayout_sam3a.xml delete mode 100644 doc/sam3n/Doxyfile delete mode 100644 doc/sam3n/DoxygenLayout_sam3n.xml delete mode 100644 doc/sam3s/Doxyfile delete mode 100644 doc/sam3s/DoxygenLayout_sam3s.xml delete mode 100644 doc/sam3u/Doxyfile delete mode 100644 doc/sam3u/DoxygenLayout_sam3u.xml delete mode 100644 doc/sam3x/Doxyfile delete mode 100644 doc/sam3x/DoxygenLayout_sam3x.xml delete mode 100644 doc/stm32f0/Doxyfile delete mode 100644 doc/stm32f0/DoxygenLayout_stm32f0.xml delete mode 100644 doc/stm32f0/index.html delete mode 100644 doc/stm32f1/Doxyfile delete mode 100644 doc/stm32f1/DoxygenLayout_stm32f1.xml delete mode 100644 doc/stm32f1/index.html delete mode 100644 doc/stm32f2/Doxyfile delete mode 100644 doc/stm32f2/DoxygenLayout_stm32f2.xml delete mode 100644 doc/stm32f2/index.html delete mode 100644 doc/stm32f3/Doxyfile delete mode 100644 doc/stm32f3/DoxygenLayout_stm32f3.xml delete mode 100644 doc/stm32f3/index.html delete mode 100644 doc/stm32f4/Doxyfile delete mode 100644 doc/stm32f4/DoxygenLayout_stm32f4.xml delete mode 100644 doc/stm32f4/index.html delete mode 100644 doc/stm32f7/Doxyfile delete mode 100644 doc/stm32f7/DoxygenLayout_stm32f7.xml delete mode 100644 doc/stm32f7/index.html delete mode 100644 doc/stm32l0/Doxyfile delete mode 100644 doc/stm32l0/DoxygenLayout_stm32l0.xml delete mode 100644 doc/stm32l0/index.html delete mode 100644 doc/stm32l1/Doxyfile delete mode 100644 doc/stm32l1/DoxygenLayout_stm32l1.xml delete mode 100644 doc/stm32l1/index.html delete mode 100644 doc/stm32l4/Doxyfile delete mode 100644 doc/stm32l4/DoxygenLayout_stm32l4.xml delete mode 100644 doc/stm32l4/index.html create mode 100644 doc/templates/Doxyfile_Device rename doc/{lm4f/DoxygenLayout_lm4f.xml => templates/DoxygenLayout_Device.xml} (70%) rename doc/{DoxygenLayout.xml => templates/DoxygenLayout_Root.xml} (67%) delete mode 100644 doc/vf6xx/Doxyfile delete mode 100644 doc/vf6xx/DoxygenLayout_vf6xx.xml delete mode 100644 doc/vf6xx/index.html create mode 100755 scripts/gendoxylayout.py diff --git a/.gitignore b/.gitignore index c8d76ee4..7ef237f1 100644 --- a/.gitignore +++ b/.gitignore @@ -25,7 +25,10 @@ include/libopencm3/**/nvic.h include/libopencm3/**/**/nvic.h lib/**/vector_nvic.c lib/**/**/vector_nvic.c -doxy.sourcelist +DoxygenLayout.xml +doc/*/Doxyfile +doc/*/DoxygenLayout_*.xml +doc/*/doxy.sourcelist include/libopencmsis/efm32/ include/libopencmsis/lm3s/ include/libopencmsis/lpc13xx/ diff --git a/doc/Makefile b/doc/Makefile index 731bf2b6..33448f11 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -3,52 +3,50 @@ # 14 September 2012 # (C) Ken Sarkies -ARCHS := stm32f0 stm32f1 stm32f2 stm32f3 stm32f4 stm32f7 -ARCHS += stm32l0 stm32l1 stm32l4 -ARCHS += efm32g efm32gg efm32hg efm32lg efm32tg -ARCHS += lm3s lm4f msp432e4 -ARCHS += lpc13xx lpc17xx lpc43xx -ARCHS += sam3a sam3n sam3s sam3u sam3x -ARCHS += vf6xx +# setup TARGETS if not set for legacy and ease of debug. +TARGETS ?= stm32/f0 stm32/f1 stm32/f2 stm32/f3 stm32/f4 stm32/f7 \ + stm32/l0 stm32/l1 stm32/l4 \ + efm32/g efm32/gg efm32/hg efm32/lg efm32/tg \ + lm3s lm4f \ + msp432/e4 \ + lpc13xx lpc17xx lpc43xx \ + sam/3a sam/3n sam/3s sam/3u sam/3x \ + vf6xx + +TARGETS_DIRS = $(subst /,,$(TARGETS)) doc: html -html: rebuildsources $(ARCHS) + +DoxygenLayout.xml: templates/DoxygenLayout_Root.xml + ../scripts/gendoxylayout.py --template $< --out $@ $(TARGETS_DIRS) + +define gen_DOC_TARGET +DOC_TARGETS += doc_$(1) + +$(1)/: + @mkdir -p $$@ + +$(1)/doxy.sourcelist: $(1)/ + @../scripts/gendoxylist ../lib/$(TARGET_SRC_DIR) $(1) + +$(1)/Doxyfile: templates/Doxyfile_Device | $(1)/ + @cat $$< | sed -s s/#device#/$(1)/g > $$@ + +$(1)/DoxygenLayout_$(1).xml: templates/DoxygenLayout_Device.xml | $(1)/ + @../scripts/gendoxylayout.py --template $$< --out $$@ --target $(1) $$(TARGETS_DIRS) + +doc_$(1): $(1)/doxy.sourcelist $(1)/Doxyfile $(1)/DoxygenLayout_$(1).xml + @(cd $(1); doxygen) +endef + +$(foreach TARGET_SRC_DIR, $(TARGETS), $(eval $(call gen_DOC_TARGET,$(subst /,,$(TARGET_SRC_DIR))))) + +html: $(DOC_TARGETS) DoxygenLayout.xml doxygen -$(ARCHS): - cd $@/; doxygen - clean: - @rm -rf html/ */html/ */*.tag */doxy.sourcelist */doxygen_*.log - -rebuildsources: - @printf "Manually regenerating source lists from build deps\n" - ../scripts/gendoxylist ../lib/stm32/f0 stm32f0 - ../scripts/gendoxylist ../lib/stm32/f1 stm32f1 - ../scripts/gendoxylist ../lib/stm32/f2 stm32f2 - ../scripts/gendoxylist ../lib/stm32/f3 stm32f3 - ../scripts/gendoxylist ../lib/stm32/f4 stm32f4 - ../scripts/gendoxylist ../lib/stm32/f7 stm32f7 - ../scripts/gendoxylist ../lib/stm32/l0 stm32l0 - ../scripts/gendoxylist ../lib/stm32/l1 stm32l1 - ../scripts/gendoxylist ../lib/stm32/l4 stm32l4 - ../scripts/gendoxylist ../lib/efm32/g efm32g - ../scripts/gendoxylist ../lib/efm32/gg efm32gg - ../scripts/gendoxylist ../lib/efm32/hg efm32hg - ../scripts/gendoxylist ../lib/efm32/lg efm32lg - ../scripts/gendoxylist ../lib/efm32/tg efm32tg - ../scripts/gendoxylist ../lib/lm3s lm3s - ../scripts/gendoxylist ../lib/lm4f lm4f - ../scripts/gendoxylist ../lib/msp432/e4 msp432e4 - ../scripts/gendoxylist ../lib/lpc13xx lpc13xx - ../scripts/gendoxylist ../lib/lpc17xx lpc17xx - ../scripts/gendoxylist ../lib/sam/3a sam3a - ../scripts/gendoxylist ../lib/sam/3n sam3n - ../scripts/gendoxylist ../lib/sam/3s sam3s - ../scripts/gendoxylist ../lib/sam/3u sam3u - ../scripts/gendoxylist ../lib/sam/3x sam3x - ../scripts/gendoxylist ../lib/vf6xx vf6xx - -.PHONY: doc html $(ARCHS) rebuildsources + @rm -rf html/ $(TARGETS_DIRS) DoxygenLayout.xml doxygen.log + +.PHONY: doc html $(DOC_TARGETS) diff --git a/doc/efm32g/Doxyfile b/doc/efm32g/Doxyfile deleted file mode 100644 index 566d50e8..00000000 --- a/doc/efm32g/Doxyfile +++ /dev/null @@ -1,27 +0,0 @@ -# HTML Documentation for efm32 code level - -# 11 November 2012 -# (C) Ken Sarkies - -#--------------------------------------------------------------------------- -# Common Include File -#--------------------------------------------------------------------------- - -@INCLUDE = ../Doxyfile_common - -#--------------------------------------------------------------------------- -# Local settings -#--------------------------------------------------------------------------- - -WARN_LOGFILE = doxygen_efm32g.log - -INPUT = ../../include/libopencm3/license.dox -@INCLUDE = doxy.sourcelist - -LAYOUT_FILE = DoxygenLayout_efm32g.xml - -GENERATE_TAGFILE = efm32g.tag - -ENABLE_PREPROCESSING = YES - - diff --git a/doc/efm32g/DoxygenLayout_efm32g.xml b/doc/efm32g/DoxygenLayout_efm32g.xml deleted file mode 100644 index 81cc3c19..00000000 --- a/doc/efm32g/DoxygenLayout_efm32g.xml +++ /dev/null @@ -1,210 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/efm32gg/Doxyfile b/doc/efm32gg/Doxyfile deleted file mode 100644 index 7b9cda5b..00000000 --- a/doc/efm32gg/Doxyfile +++ /dev/null @@ -1,27 +0,0 @@ -# HTML Documentation for efm32 code level - -# 11 November 2012 -# (C) Ken Sarkies - -#--------------------------------------------------------------------------- -# Common Include File -#--------------------------------------------------------------------------- - -@INCLUDE = ../Doxyfile_common - -#--------------------------------------------------------------------------- -# Local settings -#--------------------------------------------------------------------------- - -WARN_LOGFILE = doxygen_efm32gg.log - -INPUT = ../../include/libopencm3/license.dox -@INCLUDE = doxy.sourcelist - -LAYOUT_FILE = DoxygenLayout_efm32gg.xml - -GENERATE_TAGFILE = efm32gg.tag - -ENABLE_PREPROCESSING = YES - - diff --git a/doc/efm32gg/DoxygenLayout_efm32gg.xml b/doc/efm32gg/DoxygenLayout_efm32gg.xml deleted file mode 100644 index c80ef41e..00000000 --- a/doc/efm32gg/DoxygenLayout_efm32gg.xml +++ /dev/null @@ -1,210 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/efm32hg/Doxyfile b/doc/efm32hg/Doxyfile deleted file mode 100644 index db164da4..00000000 --- a/doc/efm32hg/Doxyfile +++ /dev/null @@ -1,25 +0,0 @@ -# HTML Documentation for efm32 code level - -# 11 November 2012 -# (C) Ken Sarkies - -#--------------------------------------------------------------------------- -# Common Include File -#--------------------------------------------------------------------------- - -@INCLUDE = ../Doxyfile_common - -#--------------------------------------------------------------------------- -# Local settings -#--------------------------------------------------------------------------- - -WARN_LOGFILE = doxygen_efm32hg.log - -INPUT = ../../include/libopencm3/license.dox -@INCLUDE = doxy.sourcelist - -LAYOUT_FILE = DoxygenLayout_efm32hg.xml - -GENERATE_TAGFILE = efm32hg.tag - -ENABLE_PREPROCESSING = YES diff --git a/doc/efm32hg/DoxygenLayout_efm32hg.xml b/doc/efm32hg/DoxygenLayout_efm32hg.xml deleted file mode 100644 index 3301e743..00000000 --- a/doc/efm32hg/DoxygenLayout_efm32hg.xml +++ /dev/null @@ -1,210 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/efm32lg/Doxyfile b/doc/efm32lg/Doxyfile deleted file mode 100644 index 7d5269fa..00000000 --- a/doc/efm32lg/Doxyfile +++ /dev/null @@ -1,27 +0,0 @@ -# HTML Documentation for efm32 code level - -# 11 November 2012 -# (C) Ken Sarkies - -#--------------------------------------------------------------------------- -# Common Include File -#--------------------------------------------------------------------------- - -@INCLUDE = ../Doxyfile_common - -#--------------------------------------------------------------------------- -# Local settings -#--------------------------------------------------------------------------- - -WARN_LOGFILE = doxygen_efm32lg.log - -INPUT = ../../include/libopencm3/license.dox -@INCLUDE = doxy.sourcelist - -LAYOUT_FILE = DoxygenLayout_efm32lg.xml - -GENERATE_TAGFILE = efm32lg.tag - -ENABLE_PREPROCESSING = YES - - diff --git a/doc/efm32lg/DoxygenLayout_efm32lg.xml b/doc/efm32lg/DoxygenLayout_efm32lg.xml deleted file mode 100644 index e5df50ed..00000000 --- a/doc/efm32lg/DoxygenLayout_efm32lg.xml +++ /dev/null @@ -1,210 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/efm32tg/Doxyfile b/doc/efm32tg/Doxyfile deleted file mode 100644 index 6ea2b79c..00000000 --- a/doc/efm32tg/Doxyfile +++ /dev/null @@ -1,27 +0,0 @@ -# HTML Documentation for efm32 code level - -# 11 November 2012 -# (C) Ken Sarkies - -#--------------------------------------------------------------------------- -# Common Include File -#--------------------------------------------------------------------------- - -@INCLUDE = ../Doxyfile_common - -#--------------------------------------------------------------------------- -# Local settings -#--------------------------------------------------------------------------- - -WARN_LOGFILE = doxygen_efm32tg.log - -INPUT = ../../include/libopencm3/license.dox -@INCLUDE = doxy.sourcelist - -LAYOUT_FILE = DoxygenLayout_efm32tg.xml - -GENERATE_TAGFILE = efm32tg.tag - -ENABLE_PREPROCESSING = YES - - diff --git a/doc/efm32tg/DoxygenLayout_efm32tg.xml b/doc/efm32tg/DoxygenLayout_efm32tg.xml deleted file mode 100644 index 5a7f3959..00000000 --- a/doc/efm32tg/DoxygenLayout_efm32tg.xml +++ /dev/null @@ -1,210 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/lm3s/Doxyfile b/doc/lm3s/Doxyfile deleted file mode 100644 index 07a62966..00000000 --- a/doc/lm3s/Doxyfile +++ /dev/null @@ -1,27 +0,0 @@ -# HTML Documentation for LM3S code level - -# 14 September 2012 -# (C) Ken Sarkies - -#--------------------------------------------------------------------------- -# Common Include File -#--------------------------------------------------------------------------- - -@INCLUDE = ../Doxyfile_common - -#--------------------------------------------------------------------------- -# Local settings -#--------------------------------------------------------------------------- - -WARN_LOGFILE = doxygen_lm3s.log - -INPUT = ../../include/libopencm3/license.dox -@INCLUDE = doxy.sourcelist - -LAYOUT_FILE = DoxygenLayout_lm3s.xml - -GENERATE_TAGFILE = lm3s.tag - -ENABLE_PREPROCESSING = YES - - diff --git a/doc/lm3s/DoxygenLayout_lm3s.xml b/doc/lm3s/DoxygenLayout_lm3s.xml deleted file mode 100644 index cc2303f2..00000000 --- a/doc/lm3s/DoxygenLayout_lm3s.xml +++ /dev/null @@ -1,210 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/lm4f/Doxyfile b/doc/lm4f/Doxyfile deleted file mode 100644 index 16164ce2..00000000 --- a/doc/lm4f/Doxyfile +++ /dev/null @@ -1,27 +0,0 @@ -# HTML Documentation for LM3S code level - -# 14 September 2012 -# (C) Ken Sarkies - -#--------------------------------------------------------------------------- -# Common Include File -#--------------------------------------------------------------------------- - -@INCLUDE = ../Doxyfile_common - -#--------------------------------------------------------------------------- -# Local settings -#--------------------------------------------------------------------------- - -WARN_LOGFILE = doxygen_lm4f.log - -INPUT = ../../include/libopencm3/license.dox -@INCLUDE = doxy.sourcelist - -LAYOUT_FILE = DoxygenLayout_lm4f.xml - -GENERATE_TAGFILE = lm4f.tag - -ENABLE_PREPROCESSING = YES - - diff --git a/doc/lpc13xx/Doxyfile b/doc/lpc13xx/Doxyfile deleted file mode 100644 index 4ed9d5f8..00000000 --- a/doc/lpc13xx/Doxyfile +++ /dev/null @@ -1,27 +0,0 @@ -# HTML Documentation for LPC13xx code level - -# 14 September 2012 -# (C) Ken Sarkies - -#--------------------------------------------------------------------------- -# Common Include File -#--------------------------------------------------------------------------- - -@INCLUDE = ../Doxyfile_common - -#--------------------------------------------------------------------------- -# Local settings -#--------------------------------------------------------------------------- - -WARN_LOGFILE = doxygen_lpc13xx.log - -INPUT = ../../include/libopencm3/license.dox -@INCLUDE = doxy.sourcelist - -LAYOUT_FILE = DoxygenLayout_lpc13xx.xml - -GENERATE_TAGFILE = lpc13xx.tag - -ENABLE_PREPROCESSING = YES - - diff --git a/doc/lpc13xx/DoxygenLayout_lpc13xx.xml b/doc/lpc13xx/DoxygenLayout_lpc13xx.xml deleted file mode 100644 index 921b7d88..00000000 --- a/doc/lpc13xx/DoxygenLayout_lpc13xx.xml +++ /dev/null @@ -1,210 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/lpc17xx/Doxyfile b/doc/lpc17xx/Doxyfile deleted file mode 100644 index 0dba6631..00000000 --- a/doc/lpc17xx/Doxyfile +++ /dev/null @@ -1,28 +0,0 @@ -# HTML Documentation for LPC17xx code level - -# 14 September 2012 -# (C) Ken Sarkies - -#--------------------------------------------------------------------------- -# Common Include File -#--------------------------------------------------------------------------- - -@INCLUDE = ../Doxyfile_common - -#--------------------------------------------------------------------------- -# Local settings -#--------------------------------------------------------------------------- - -WARN_LOGFILE = doxygen_lpc17xx.log - -INPUT = ../../include/libopencm3/license.dox \ - ../../include/libopencm3/lpc17xx \ - ../../lib/lpc17xx - -LAYOUT_FILE = DoxygenLayout_lpc17xx.xml - -GENERATE_TAGFILE = lpc17xx.tag - -ENABLE_PREPROCESSING = YES - - diff --git a/doc/lpc17xx/DoxygenLayout_lpc17xx.xml b/doc/lpc17xx/DoxygenLayout_lpc17xx.xml deleted file mode 100644 index 1da6c414..00000000 --- a/doc/lpc17xx/DoxygenLayout_lpc17xx.xml +++ /dev/null @@ -1,210 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/lpc43xx/Doxyfile b/doc/lpc43xx/Doxyfile deleted file mode 100644 index 52be8d6e..00000000 --- a/doc/lpc43xx/Doxyfile +++ /dev/null @@ -1,28 +0,0 @@ -# HTML Documentation for LPC43xx code level - -# 14 September 2012 -# (C) Ken Sarkies - -#--------------------------------------------------------------------------- -# Common Include File -#--------------------------------------------------------------------------- - -@INCLUDE = ../Doxyfile_common - -#--------------------------------------------------------------------------- -# Local settings -#--------------------------------------------------------------------------- - -WARN_LOGFILE = doxygen_lpc43xx.log - -INPUT = ../../include/libopencm3/license.dox -INPUT += ../../include/libopencm3/lpc43xx -INPUT += ../../lib/lpc43xx - -LAYOUT_FILE = DoxygenLayout_lpc43xx.xml - -GENERATE_TAGFILE = lpc43xx.tag - -ENABLE_PREPROCESSING = YES - - diff --git a/doc/lpc43xx/DoxygenLayout_lpc43xx.xml b/doc/lpc43xx/DoxygenLayout_lpc43xx.xml deleted file mode 100644 index bde9afca..00000000 --- a/doc/lpc43xx/DoxygenLayout_lpc43xx.xml +++ /dev/null @@ -1,210 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/msp432e4/Doxyfile b/doc/msp432e4/Doxyfile deleted file mode 100644 index 889faad5..00000000 --- a/doc/msp432e4/Doxyfile +++ /dev/null @@ -1,11 +0,0 @@ - -# Common settings, you shouldn't have to change these... -@INCLUDE = ../Doxyfile_common -INPUT = ../../include/libopencm3/license.dox -@INCLUDE = doxy.sourcelist -ENABLE_PREPROCESSING = YES - -# Target settings, should only need name changes -WARN_LOGFILE = doxygen_msp432e4.log -LAYOUT_FILE = DoxygenLayout_msp432e4.xml -GENERATE_TAGFILE = msp432e4.tag diff --git a/doc/msp432e4/DoxygenLayout_msp432e4.xml b/doc/msp432e4/DoxygenLayout_msp432e4.xml deleted file mode 100644 index 781fb1e5..00000000 --- a/doc/msp432e4/DoxygenLayout_msp432e4.xml +++ /dev/null @@ -1,210 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/sam3a/Doxyfile b/doc/sam3a/Doxyfile deleted file mode 100644 index ea06caee..00000000 --- a/doc/sam3a/Doxyfile +++ /dev/null @@ -1,29 +0,0 @@ -# HTML Documentation for SAM3A code level - -# 14 September 2012 -# (C) Ken Sarkies -# 09 February 2014 -# (C) Felix Held - -#--------------------------------------------------------------------------- -# Common Include File -#--------------------------------------------------------------------------- - -@INCLUDE = ../Doxyfile_common - -#--------------------------------------------------------------------------- -# Local settings -#--------------------------------------------------------------------------- - -WARN_LOGFILE = doxygen_sam3a.log - -INPUT = ../../include/libopencm3/license.dox -@INCLUDE = doxy.sourcelist - -LAYOUT_FILE = DoxygenLayout_sam3a.xml - -GENERATE_TAGFILE = sam3a.tag - -ENABLE_PREPROCESSING = YES - - diff --git a/doc/sam3a/DoxygenLayout_sam3a.xml b/doc/sam3a/DoxygenLayout_sam3a.xml deleted file mode 100644 index ce6bc7df..00000000 --- a/doc/sam3a/DoxygenLayout_sam3a.xml +++ /dev/null @@ -1,210 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/sam3n/Doxyfile b/doc/sam3n/Doxyfile deleted file mode 100644 index a2dd4612..00000000 --- a/doc/sam3n/Doxyfile +++ /dev/null @@ -1,29 +0,0 @@ -# HTML Documentation for SAM3N code level - -# 14 September 2012 -# (C) Ken Sarkies -# 09 February 2014 -# (C) Felix Held - -#--------------------------------------------------------------------------- -# Common Include File -#--------------------------------------------------------------------------- - -@INCLUDE = ../Doxyfile_common - -#--------------------------------------------------------------------------- -# Local settings -#--------------------------------------------------------------------------- - -WARN_LOGFILE = doxygen_sam3n.log - -INPUT = ../../include/libopencm3/license.dox -@INCLUDE = doxy.sourcelist - -LAYOUT_FILE = DoxygenLayout_sam3n.xml - -GENERATE_TAGFILE = sam3n.tag - -ENABLE_PREPROCESSING = YES - - diff --git a/doc/sam3n/DoxygenLayout_sam3n.xml b/doc/sam3n/DoxygenLayout_sam3n.xml deleted file mode 100644 index 56399c0e..00000000 --- a/doc/sam3n/DoxygenLayout_sam3n.xml +++ /dev/null @@ -1,210 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/sam3s/Doxyfile b/doc/sam3s/Doxyfile deleted file mode 100644 index 66a966fa..00000000 --- a/doc/sam3s/Doxyfile +++ /dev/null @@ -1,29 +0,0 @@ -# HTML Documentation for SAM3S code level - -# 14 September 2012 -# (C) Ken Sarkies -# 09 February 2014 -# (C) Felix Held - -#--------------------------------------------------------------------------- -# Common Include File -#--------------------------------------------------------------------------- - -@INCLUDE = ../Doxyfile_common - -#--------------------------------------------------------------------------- -# Local settings -#--------------------------------------------------------------------------- - -WARN_LOGFILE = doxygen_sam3s.log - -INPUT = ../../include/libopencm3/license.dox -@INCLUDE = doxy.sourcelist - -LAYOUT_FILE = DoxygenLayout_sam3s.xml - -GENERATE_TAGFILE = sam3s.tag - -ENABLE_PREPROCESSING = YES - - diff --git a/doc/sam3s/DoxygenLayout_sam3s.xml b/doc/sam3s/DoxygenLayout_sam3s.xml deleted file mode 100644 index ba744fef..00000000 --- a/doc/sam3s/DoxygenLayout_sam3s.xml +++ /dev/null @@ -1,210 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/sam3u/Doxyfile b/doc/sam3u/Doxyfile deleted file mode 100644 index 0503fb33..00000000 --- a/doc/sam3u/Doxyfile +++ /dev/null @@ -1,29 +0,0 @@ -# HTML Documentation for SAM3U code level - -# 14 September 2012 -# (C) Ken Sarkies -# 09 February 2014 -# (C) Felix Held - -#--------------------------------------------------------------------------- -# Common Include File -#--------------------------------------------------------------------------- - -@INCLUDE = ../Doxyfile_common - -#--------------------------------------------------------------------------- -# Local settings -#--------------------------------------------------------------------------- - -WARN_LOGFILE = doxygen_sam3u.log - -INPUT = ../../include/libopencm3/license.dox -@INCLUDE = doxy.sourcelist - -LAYOUT_FILE = DoxygenLayout_sam3u.xml - -GENERATE_TAGFILE = sam3u.tag - -ENABLE_PREPROCESSING = YES - - diff --git a/doc/sam3u/DoxygenLayout_sam3u.xml b/doc/sam3u/DoxygenLayout_sam3u.xml deleted file mode 100644 index 498e89d7..00000000 --- a/doc/sam3u/DoxygenLayout_sam3u.xml +++ /dev/null @@ -1,210 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/sam3x/Doxyfile b/doc/sam3x/Doxyfile deleted file mode 100644 index df4fe9e5..00000000 --- a/doc/sam3x/Doxyfile +++ /dev/null @@ -1,29 +0,0 @@ -# HTML Documentation for SAM3X code level - -# 14 September 2012 -# (C) Ken Sarkies -# 09 February 2014 -# (C) Felix Held - -#--------------------------------------------------------------------------- -# Common Include File -#--------------------------------------------------------------------------- - -@INCLUDE = ../Doxyfile_common - -#--------------------------------------------------------------------------- -# Local settings -#--------------------------------------------------------------------------- - -WARN_LOGFILE = doxygen_sam3x.log - -INPUT = ../../include/libopencm3/license.dox -@INCLUDE = doxy.sourcelist - -LAYOUT_FILE = DoxygenLayout_sam3x.xml - -GENERATE_TAGFILE = sam3x.tag - -ENABLE_PREPROCESSING = YES - - diff --git a/doc/sam3x/DoxygenLayout_sam3x.xml b/doc/sam3x/DoxygenLayout_sam3x.xml deleted file mode 100644 index c03fcebf..00000000 --- a/doc/sam3x/DoxygenLayout_sam3x.xml +++ /dev/null @@ -1,210 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/stm32f0/Doxyfile b/doc/stm32f0/Doxyfile deleted file mode 100644 index 3c1d999a..00000000 --- a/doc/stm32f0/Doxyfile +++ /dev/null @@ -1,27 +0,0 @@ -# HTML Documentation for STM32F0 code level - -# 14 September 2012 -# (C) Ken Sarkies - -#--------------------------------------------------------------------------- -# Common Include File -#--------------------------------------------------------------------------- - -@INCLUDE = ../Doxyfile_common - -#--------------------------------------------------------------------------- -# Local settings -#--------------------------------------------------------------------------- - -WARN_LOGFILE = doxygen_stm32f0.log - -INPUT = ../../include/libopencm3/license.dox -@INCLUDE = doxy.sourcelist - -LAYOUT_FILE = DoxygenLayout_stm32f0.xml - -GENERATE_TAGFILE = stm32f0.tag - -ENABLE_PREPROCESSING = YES - - diff --git a/doc/stm32f0/DoxygenLayout_stm32f0.xml b/doc/stm32f0/DoxygenLayout_stm32f0.xml deleted file mode 100644 index 742f984b..00000000 --- a/doc/stm32f0/DoxygenLayout_stm32f0.xml +++ /dev/null @@ -1,210 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/stm32f0/index.html b/doc/stm32f0/index.html deleted file mode 100644 index 7715877a..00000000 --- a/doc/stm32f0/index.html +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - Documentation index

- - diff --git a/doc/stm32f1/Doxyfile b/doc/stm32f1/Doxyfile deleted file mode 100644 index 65432dee..00000000 --- a/doc/stm32f1/Doxyfile +++ /dev/null @@ -1,27 +0,0 @@ -# HTML Documentation for STM32F1 code level - -# 14 September 2012 -# (C) Ken Sarkies - -#--------------------------------------------------------------------------- -# Common Include File -#--------------------------------------------------------------------------- - -@INCLUDE = ../Doxyfile_common - -#--------------------------------------------------------------------------- -# Local settings -#--------------------------------------------------------------------------- - -WARN_LOGFILE = doxygen_stm32f1.log - -INPUT = ../../include/libopencm3/license.dox -@INCLUDE = doxy.sourcelist - -LAYOUT_FILE = DoxygenLayout_stm32f1.xml - -GENERATE_TAGFILE = stm32f1.tag - -ENABLE_PREPROCESSING = YES - - diff --git a/doc/stm32f1/DoxygenLayout_stm32f1.xml b/doc/stm32f1/DoxygenLayout_stm32f1.xml deleted file mode 100644 index 063e2400..00000000 --- a/doc/stm32f1/DoxygenLayout_stm32f1.xml +++ /dev/null @@ -1,210 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/stm32f1/index.html b/doc/stm32f1/index.html deleted file mode 100644 index 7715877a..00000000 --- a/doc/stm32f1/index.html +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - Documentation index

- - diff --git a/doc/stm32f2/Doxyfile b/doc/stm32f2/Doxyfile deleted file mode 100644 index 88eb906f..00000000 --- a/doc/stm32f2/Doxyfile +++ /dev/null @@ -1,27 +0,0 @@ -# HTML Documentation for STM32F2 code level - -# 14 September 2012 -# (C) Ken Sarkies - -#--------------------------------------------------------------------------- -# Common Include File -#--------------------------------------------------------------------------- - -@INCLUDE = ../Doxyfile_common - -#--------------------------------------------------------------------------- -# Local settings -#--------------------------------------------------------------------------- - -WARN_LOGFILE = doxygen_stm32f2.log - -INPUT = ../../include/libopencm3/license.dox -@INCLUDE = doxy.sourcelist - -LAYOUT_FILE = DoxygenLayout_stm32f2.xml - -GENERATE_TAGFILE = stm32f2.tag - -ENABLE_PREPROCESSING = YES - - diff --git a/doc/stm32f2/DoxygenLayout_stm32f2.xml b/doc/stm32f2/DoxygenLayout_stm32f2.xml deleted file mode 100644 index 99a1863e..00000000 --- a/doc/stm32f2/DoxygenLayout_stm32f2.xml +++ /dev/null @@ -1,210 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/stm32f2/index.html b/doc/stm32f2/index.html deleted file mode 100644 index 7715877a..00000000 --- a/doc/stm32f2/index.html +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - Documentation index

- - diff --git a/doc/stm32f3/Doxyfile b/doc/stm32f3/Doxyfile deleted file mode 100644 index 8c788ef6..00000000 --- a/doc/stm32f3/Doxyfile +++ /dev/null @@ -1,22 +0,0 @@ -# HTML Documentation for STM32F3 code level - -#--------------------------------------------------------------------------- -# Common Include File -#--------------------------------------------------------------------------- - -@INCLUDE = ../Doxyfile_common - -#--------------------------------------------------------------------------- -# Local settings -#--------------------------------------------------------------------------- - -WARN_LOGFILE = doxygen_stm32f3.log - -INPUT = ../../include/libopencm3/license.dox -@INCLUDE = doxy.sourcelist - -LAYOUT_FILE = DoxygenLayout_stm32f3.xml - -GENERATE_TAGFILE = stm32f3.tag - -ENABLE_PREPROCESSING = YES diff --git a/doc/stm32f3/DoxygenLayout_stm32f3.xml b/doc/stm32f3/DoxygenLayout_stm32f3.xml deleted file mode 100644 index a0a3200f..00000000 --- a/doc/stm32f3/DoxygenLayout_stm32f3.xml +++ /dev/null @@ -1,210 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/stm32f3/index.html b/doc/stm32f3/index.html deleted file mode 100644 index 7715877a..00000000 --- a/doc/stm32f3/index.html +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - Documentation index

- - diff --git a/doc/stm32f4/Doxyfile b/doc/stm32f4/Doxyfile deleted file mode 100644 index 67f4ed8f..00000000 --- a/doc/stm32f4/Doxyfile +++ /dev/null @@ -1,27 +0,0 @@ -# HTML Documentation for STM32F4 code level - -# 14 September 2012 -# (C) Ken Sarkies - -#--------------------------------------------------------------------------- -# Common Include File -#--------------------------------------------------------------------------- - -@INCLUDE = ../Doxyfile_common - -#--------------------------------------------------------------------------- -# Local settings -#--------------------------------------------------------------------------- - -WARN_LOGFILE = doxygen_stm32f4.log - -INPUT = ../../include/libopencm3/license.dox -@INCLUDE = doxy.sourcelist - -LAYOUT_FILE = DoxygenLayout_stm32f4.xml - -GENERATE_TAGFILE = stm32f4.tag - -ENABLE_PREPROCESSING = YES - - diff --git a/doc/stm32f4/DoxygenLayout_stm32f4.xml b/doc/stm32f4/DoxygenLayout_stm32f4.xml deleted file mode 100644 index 839301f3..00000000 --- a/doc/stm32f4/DoxygenLayout_stm32f4.xml +++ /dev/null @@ -1,210 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/stm32f4/index.html b/doc/stm32f4/index.html deleted file mode 100644 index 7715877a..00000000 --- a/doc/stm32f4/index.html +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - Documentation index

- - diff --git a/doc/stm32f7/Doxyfile b/doc/stm32f7/Doxyfile deleted file mode 100644 index 3d2c9e45..00000000 --- a/doc/stm32f7/Doxyfile +++ /dev/null @@ -1,27 +0,0 @@ -# HTML Documentation for STM32F7 code level - -# 14 September 2012 -# (C) Ken Sarkies - -#--------------------------------------------------------------------------- -# Common Include File -#--------------------------------------------------------------------------- - -@INCLUDE = ../Doxyfile_common - -#--------------------------------------------------------------------------- -# Local settings -#--------------------------------------------------------------------------- - -WARN_LOGFILE = doxygen_stm32f7.log - -INPUT = ../../include/libopencm3/license.dox -@INCLUDE = doxy.sourcelist - -LAYOUT_FILE = DoxygenLayout_stm32f7.xml - -GENERATE_TAGFILE = stm32f7.tag - -ENABLE_PREPROCESSING = YES - - diff --git a/doc/stm32f7/DoxygenLayout_stm32f7.xml b/doc/stm32f7/DoxygenLayout_stm32f7.xml deleted file mode 100644 index 843b7e06..00000000 --- a/doc/stm32f7/DoxygenLayout_stm32f7.xml +++ /dev/null @@ -1,210 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/stm32f7/index.html b/doc/stm32f7/index.html deleted file mode 100644 index 7715877a..00000000 --- a/doc/stm32f7/index.html +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - Documentation index

- - diff --git a/doc/stm32l0/Doxyfile b/doc/stm32l0/Doxyfile deleted file mode 100644 index 6a5f10b5..00000000 --- a/doc/stm32l0/Doxyfile +++ /dev/null @@ -1,27 +0,0 @@ -# HTML Documentation for STM32L0 code level - -# 15 December 2012 -# (C) Ken Sarkies - -#--------------------------------------------------------------------------- -# Common Include File -#--------------------------------------------------------------------------- - -@INCLUDE = ../Doxyfile_common - -#--------------------------------------------------------------------------- -# Local settings -#--------------------------------------------------------------------------- - -WARN_LOGFILE = doxygen_stm32l0.log - -INPUT = ../../include/libopencm3/license.dox -@INCLUDE = doxy.sourcelist - -LAYOUT_FILE = DoxygenLayout_stm32l0.xml - -GENERATE_TAGFILE = stm32l0.tag - -ENABLE_PREPROCESSING = YES - - diff --git a/doc/stm32l0/DoxygenLayout_stm32l0.xml b/doc/stm32l0/DoxygenLayout_stm32l0.xml deleted file mode 100644 index 6015ab7e..00000000 --- a/doc/stm32l0/DoxygenLayout_stm32l0.xml +++ /dev/null @@ -1,210 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/stm32l0/index.html b/doc/stm32l0/index.html deleted file mode 100644 index 7715877a..00000000 --- a/doc/stm32l0/index.html +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - Documentation index

- - diff --git a/doc/stm32l1/Doxyfile b/doc/stm32l1/Doxyfile deleted file mode 100644 index 95820578..00000000 --- a/doc/stm32l1/Doxyfile +++ /dev/null @@ -1,27 +0,0 @@ -# HTML Documentation for STM32L1 code level - -# 15 December 2012 -# (C) Ken Sarkies - -#--------------------------------------------------------------------------- -# Common Include File -#--------------------------------------------------------------------------- - -@INCLUDE = ../Doxyfile_common - -#--------------------------------------------------------------------------- -# Local settings -#--------------------------------------------------------------------------- - -WARN_LOGFILE = doxygen_stm32l1.log - -INPUT = ../../include/libopencm3/license.dox -@INCLUDE = doxy.sourcelist - -LAYOUT_FILE = DoxygenLayout_stm32l1.xml - -GENERATE_TAGFILE = stm32l1.tag - -ENABLE_PREPROCESSING = YES - - diff --git a/doc/stm32l1/DoxygenLayout_stm32l1.xml b/doc/stm32l1/DoxygenLayout_stm32l1.xml deleted file mode 100644 index 94ee8172..00000000 --- a/doc/stm32l1/DoxygenLayout_stm32l1.xml +++ /dev/null @@ -1,210 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/stm32l1/index.html b/doc/stm32l1/index.html deleted file mode 100644 index 7715877a..00000000 --- a/doc/stm32l1/index.html +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - Documentation index

- - diff --git a/doc/stm32l4/Doxyfile b/doc/stm32l4/Doxyfile deleted file mode 100644 index 153cec42..00000000 --- a/doc/stm32l4/Doxyfile +++ /dev/null @@ -1,27 +0,0 @@ -# HTML Documentation for STM32L4 code level - -# 15 December 2012 -# (C) Ken Sarkies - -#--------------------------------------------------------------------------- -# Common Include File -#--------------------------------------------------------------------------- - -@INCLUDE = ../Doxyfile_common - -#--------------------------------------------------------------------------- -# Local settings -#--------------------------------------------------------------------------- - -WARN_LOGFILE = doxygen_stm32l4.log - -INPUT = ../../include/libopencm3/license.dox -@INCLUDE = doxy.sourcelist - -LAYOUT_FILE = DoxygenLayout_stm32l4.xml - -GENERATE_TAGFILE = stm32l4.tag - -ENABLE_PREPROCESSING = YES - - diff --git a/doc/stm32l4/DoxygenLayout_stm32l4.xml b/doc/stm32l4/DoxygenLayout_stm32l4.xml deleted file mode 100644 index f6b2a6a2..00000000 --- a/doc/stm32l4/DoxygenLayout_stm32l4.xml +++ /dev/null @@ -1,210 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/stm32l4/index.html b/doc/stm32l4/index.html deleted file mode 100644 index 7715877a..00000000 --- a/doc/stm32l4/index.html +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - Documentation index

- - diff --git a/doc/templates/Doxyfile_Device b/doc/templates/Doxyfile_Device new file mode 100644 index 00000000..c1ba756c --- /dev/null +++ b/doc/templates/Doxyfile_Device @@ -0,0 +1,7 @@ +@INCLUDE = ../Doxyfile_common +INPUT = ../../include/libopencm3/license.dox +@INCLUDE = doxy.sourcelist +WARN_LOGFILE = doxygen_#device#.log +LAYOUT_FILE = DoxygenLayout_#device#.xml +GENERATE_TAGFILE = #device#.tag +ENABLE_PREPROCESSING = YES diff --git a/doc/lm4f/DoxygenLayout_lm4f.xml b/doc/templates/DoxygenLayout_Device.xml similarity index 70% rename from doc/lm4f/DoxygenLayout_lm4f.xml rename to doc/templates/DoxygenLayout_Device.xml index 28020aa7..853301b3 100644 --- a/doc/lm4f/DoxygenLayout_lm4f.xml +++ b/doc/templates/DoxygenLayout_Device.xml @@ -4,31 +4,7 @@ - - - - - - - - - - - - - - - - - - - - - - - - - + diff --git a/doc/DoxygenLayout.xml b/doc/templates/DoxygenLayout_Root.xml similarity index 67% rename from doc/DoxygenLayout.xml rename to doc/templates/DoxygenLayout_Root.xml index de27fa5d..e39594f8 100644 --- a/doc/DoxygenLayout.xml +++ b/doc/templates/DoxygenLayout_Root.xml @@ -4,32 +4,7 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - + diff --git a/doc/vf6xx/Doxyfile b/doc/vf6xx/Doxyfile deleted file mode 100644 index 5041a4b3..00000000 --- a/doc/vf6xx/Doxyfile +++ /dev/null @@ -1,27 +0,0 @@ -# HTML Documentation for VF6XX code level - -# 14 September 2012 -# (C) Ken Sarkies - -#--------------------------------------------------------------------------- -# Common Include File -#--------------------------------------------------------------------------- - -@INCLUDE = ../Doxyfile_common - -#--------------------------------------------------------------------------- -# Local settings -#--------------------------------------------------------------------------- - -WARN_LOGFILE = doxygen_vf6xx.log - -INPUT = ../../include/libopencm3/license.dox -@INCLUDE = doxy.sourcelist - -LAYOUT_FILE = DoxygenLayout_vf6xx.xml - -GENERATE_TAGFILE = vf6xx.tag - -ENABLE_PREPROCESSING = YES - - diff --git a/doc/vf6xx/DoxygenLayout_vf6xx.xml b/doc/vf6xx/DoxygenLayout_vf6xx.xml deleted file mode 100644 index 352b5872..00000000 --- a/doc/vf6xx/DoxygenLayout_vf6xx.xml +++ /dev/null @@ -1,210 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/vf6xx/index.html b/doc/vf6xx/index.html deleted file mode 100644 index 048aa174..00000000 --- a/doc/vf6xx/index.html +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - Documentation index

- - diff --git a/scripts/gendoxylayout.py b/scripts/gendoxylayout.py new file mode 100755 index 00000000..24154958 --- /dev/null +++ b/scripts/gendoxylayout.py @@ -0,0 +1,68 @@ +#!/usr/bin/env python +# This python program generates parameters for the linker script generator feature. + +# This file is part of the libopencm3 project. +# +# 2019 Guillaume Revaillot +# +# This library is free software: you can redistribute it and/or modify +# it under the terms of the GNU Lesser General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public License +# along with this library. If not, see . + +from xml.etree import ElementTree + +import argparse + + +parser = argparse.ArgumentParser(prog='gendoxylayout') +parser.add_argument("--template", required=True) +parser.add_argument("--out", required=True) +parser.add_argument("--target") +parser.add_argument("devices", nargs='*') +args = parser.parse_args() + +class CommentedTreeBuilder(ElementTree.TreeBuilder): + def __init__(self, *args, **kwargs): + super(CommentedTreeBuilder, self).__init__(*args, **kwargs) + + def comment(self, data): + self.start(ElementTree.Comment, {}) + self.data(data) + self.end(ElementTree.Comment) + +tree = ElementTree.parse(args.template, ElementTree.XMLParser(target=CommentedTreeBuilder())) +parent_map = {c:p for p in tree.iter() for c in p} +for element in tree.iter(tag=ElementTree.Comment): + if ("#devices#" in element.text): + idx = (list(parent_map[element]).index(element)) + for device in args.devices: + tab = ElementTree.Element('tab') + + tab.set("visible", "yes") + tab.set("title", str(device).upper()) + tab.set("intro", "") + + if (args.target != None): + if (device == args.target): + tab.set("type", "modules") + else: + tab.set("type", "user") + tab.set("url", "../../" + device + "/html/modules.html") + else: + tab.set("type", "user") + tab.set("url", "../" + device + "/html/modules.html") + + parent_map[element].insert(idx, tab) + idx = idx+1; + parent_map[element].remove(element) + +tree.write(args.out)