diff options
author | Karl Palsson <karlp@tweak.net.au> | 2018-08-22 22:59:33 +0300 |
---|---|---|
committer | Karl Palsson <karlp@tweak.net.au> | 2018-08-27 16:34:34 +0300 |
commit | 056602b12a0efd1d5e0c88fc4c9cf9e50a94982d (patch) | |
tree | 65292eeef03dce6b324491c572da03c844e7f376 | |
parent | 2adefd95fe76142ccbe777dfbc42bb4086308797 (diff) |
doc: msp432/e4: hook up doxygen generation
Just hooks up the target, no changes to the submitted documentation.
-rw-r--r-- | doc/DoxygenLayout.xml | 1 | ||||
-rw-r--r-- | doc/Makefile | 3 | ||||
-rw-r--r-- | doc/msp432e4/Doxyfile | 11 | ||||
-rw-r--r-- | doc/msp432e4/DoxygenLayout_msp432e4.xml | 210 |
4 files changed, 224 insertions, 1 deletions
diff --git a/doc/DoxygenLayout.xml b/doc/DoxygenLayout.xml index 3ad096ec..de27fa5d 100644 --- a/doc/DoxygenLayout.xml +++ b/doc/DoxygenLayout.xml @@ -15,6 +15,7 @@ <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="../msp432e4/html/modules.html" title="MSP432E4" 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=""/> diff --git a/doc/Makefile b/doc/Makefile index 483af768..731bf2b6 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -6,7 +6,7 @@ ARCHS := stm32f0 stm32f1 stm32f2 stm32f3 stm32f4 stm32f7 ARCHS += stm32l0 stm32l1 stm32l4 ARCHS += efm32g efm32gg efm32hg efm32lg efm32tg -ARCHS += lm3s lm4f +ARCHS += lm3s lm4f msp432e4 ARCHS += lpc13xx lpc17xx lpc43xx ARCHS += sam3a sam3n sam3s sam3u sam3x ARCHS += vf6xx @@ -40,6 +40,7 @@ rebuildsources: ../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 diff --git a/doc/msp432e4/Doxyfile b/doc/msp432e4/Doxyfile new file mode 100644 index 00000000..889faad5 --- /dev/null +++ b/doc/msp432e4/Doxyfile @@ -0,0 +1,11 @@ + +# 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 new file mode 100644 index 00000000..781fb1e5 --- /dev/null +++ b/doc/msp432e4/DoxygenLayout_msp432e4.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="../../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="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="MSP432E4" 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="../../efm32hg/html/modules.html" title="EFM32 Happy 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> |