-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Generated doxygen docs for master from cron job
- Loading branch information
Showing
73,185 changed files
with
8,299,318 additions
and
0 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# Doxygen include file to generate top level entry document | ||
|
||
# 14 September 2012 | ||
# (C) Ken Sarkies <ksarkies@internode.on.net> | ||
|
||
#--------------------------------------------------------------------------- | ||
# Common Include File | ||
#--------------------------------------------------------------------------- | ||
|
||
@INCLUDE = ./Doxyfile_common | ||
|
||
#--------------------------------------------------------------------------- | ||
# Local settings | ||
#--------------------------------------------------------------------------- | ||
|
||
INPUT = ../include/libopencm3/docmain.dox | ||
|
||
LAYOUT_FILE = DoxygenLayout.xml | ||
|
||
GENERATE_LATEX = NO | ||
|
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,173 @@ | ||
<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="Top Level" intro="" /> | ||
<tab visible="yes" title="STM32F0" intro="" type="user" url="../stm32f0/html/modules.html" /><tab visible="yes" title="STM32F1" intro="" type="user" url="../stm32f1/html/modules.html" /><tab visible="yes" title="STM32F2" intro="" type="user" url="../stm32f2/html/modules.html" /><tab visible="yes" title="STM32F3" intro="" type="user" url="../stm32f3/html/modules.html" /><tab visible="yes" title="STM32F4" intro="" type="user" url="../stm32f4/html/modules.html" /><tab visible="yes" title="STM32F7" intro="" type="user" url="../stm32f7/html/modules.html" /><tab visible="yes" title="STM32H7" intro="" type="user" url="../stm32h7/html/modules.html" /><tab visible="yes" title="STM32L0" intro="" type="user" url="../stm32l0/html/modules.html" /><tab visible="yes" title="STM32L1" intro="" type="user" url="../stm32l1/html/modules.html" /><tab visible="yes" title="STM32L4" intro="" type="user" url="../stm32l4/html/modules.html" /><tab visible="yes" title="STM32G0" intro="" type="user" url="../stm32g0/html/modules.html" /><tab visible="yes" title="STM32G4" intro="" type="user" url="../stm32g4/html/modules.html" /><tab visible="yes" title="GD32F1X0" intro="" type="user" url="../gd32f1x0/html/modules.html" /><tab visible="yes" title="EFM32G" intro="" type="user" url="../efm32g/html/modules.html" /><tab visible="yes" title="EFM32GG" intro="" type="user" url="../efm32gg/html/modules.html" /><tab visible="yes" title="EFM32HG" intro="" type="user" url="../efm32hg/html/modules.html" /><tab visible="yes" title="EFM32LG" intro="" type="user" url="../efm32lg/html/modules.html" /><tab visible="yes" title="EFM32TG" intro="" type="user" url="../efm32tg/html/modules.html" /><tab visible="yes" title="EFM32WG" intro="" type="user" url="../efm32wg/html/modules.html" /><tab visible="yes" title="EFM32EZR32WG" intro="" type="user" url="../efm32ezr32wg/html/modules.html" /><tab visible="yes" title="LM3S" intro="" type="user" url="../lm3s/html/modules.html" /><tab visible="yes" title="LM4F" intro="" type="user" url="../lm4f/html/modules.html" /><tab visible="yes" title="MSP432E4" intro="" type="user" url="../msp432e4/html/modules.html" /><tab visible="yes" title="LPC13XX" intro="" type="user" url="../lpc13xx/html/modules.html" /><tab visible="yes" title="LPC17XX" intro="" type="user" url="../lpc17xx/html/modules.html" /><tab visible="yes" title="LPC43XX" intro="" type="user" url="../lpc43xx/html/modules.html" /><tab visible="yes" title="SAM3A" intro="" type="user" url="../sam3a/html/modules.html" /><tab visible="yes" title="SAM3N" intro="" type="user" url="../sam3n/html/modules.html" /><tab visible="yes" title="SAM3S" intro="" type="user" url="../sam3s/html/modules.html" /><tab visible="yes" title="SAM3U" intro="" type="user" url="../sam3u/html/modules.html" /><tab visible="yes" title="SAM3X" intro="" type="user" url="../sam3x/html/modules.html" /><tab visible="yes" title="SAMD" intro="" type="user" url="../samd/html/modules.html" /><tab visible="yes" title="SAM4L" intro="" type="user" url="../sam4l/html/modules.html" /><tab visible="yes" title="VF6XX" intro="" type="user" url="../vf6xx/html/modules.html" /><tab visible="yes" title="SWM050" intro="" type="user" url="../swm050/html/modules.html" /><tab visible="yes" title="PAC55XX" intro="" type="user" url="../pac55xx/html/modules.html" /><tab type="namespaces" visible="yes" title=""> | ||
<tab type="namespaces" visible="yes" title="" intro="" /> | ||
<tab type="namespacemembers" visible="yes" title="" intro="" /> | ||
</tab> | ||
</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> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,106 @@ | ||
libopencm3 Documentation | ||
12 October 2012 (C) K Sarkies | ||
----------------------------- | ||
|
||
Each family and subfamily of devices has a separate directory and configuration | ||
files. Doxygen is run independently on each of these and the result is | ||
integrated under a single HTML page. | ||
Due to relative referencing used in the files, the directory | ||
structure is important and should be maintained. | ||
The Makefile will automatically generate the list of input files based on the | ||
current library makefiles, so you _must_ have run built the library itself first. | ||
|
||
Each of the subdirectories has a configuration file, a layout file and | ||
subdirectories for the documentation. Doxygen is intended to be run inside | ||
these subdirectories. The Makefile will handle this in the appropriate | ||
order. | ||
|
||
Markup | ||
------ | ||
|
||
Each family has been given a group name that will allow subgrouping of API | ||
functions and defines in the documentation. | ||
|
||
The header and source files for each peripheral in each family must have a | ||
heading section in which an @defgroup defines the group name for the particular | ||
peripheral. This group name will be the same across all families as each one | ||
is documented separately. Thus for a peripheral xxx the header will have a | ||
group name xxx_defines and the source file will have xxx_file. This will allow | ||
the group to appear separately. An @ingroup must be provided to place the group | ||
as a subgroup of the appropriate family grouping. Note that @file is not used. | ||
|
||
The heading section must include the version number and date and authors names | ||
plus a license reference. Any documentation specific to the family can be | ||
included here. If there are common files included then their documentation will | ||
appear in a separate section. | ||
|
||
Common header and source files that are included into a number of families must | ||
have an @addgroup to include its documentation into the appropriate peripheral | ||
group. These headings may include authors and any specific descriptions but the | ||
date and version number must be omitted as it will be included from the family | ||
files. There must not be any reference to family groupings as these common files | ||
will be incorporated into multiple family groups. | ||
|
||
The common files should not be included in an application explicitly. Also the | ||
doxygen preprocessor must be enabled to ensure that all macros and defines are | ||
included. This means that common header files need to have a section at the top | ||
of the file of the type (eg for gpio_common_f24.h): | ||
|
||
/** @cond */ | ||
#ifdef LIBOPENCM3_GPIO_H | ||
/** @endcond */ | ||
|
||
and at the end of the file: | ||
|
||
/** @cond */ | ||
#else | ||
#warning "gpio_common_f24.h should not be included explicitly, only via gpio.h" | ||
#endif | ||
/** @endcond */ | ||
|
||
This will stop the compiler preprocessor from including the common header file | ||
unless the device family header file has also been included. The doxygen | ||
conditional clauses are needed to stop the doxygen preprocessor seeing this | ||
statement and so excluding processing of the common file contents. | ||
|
||
/** @cond */ | ||
#if defined(LIBOPENCM3_GPIO_H) || defined(LIBOPENCM3_GPIO_COMMON_F24_H) | ||
/** @endcond */ | ||
|
||
Each helper function must have a header with an @brief, and where appropriate | ||
additional description, @parameter and @return elements. These latter must | ||
describe the allowable parameter ranges preferably with reference to a suitable | ||
define in the corresponding header file. | ||
|
||
The Doxyfile for a family must include input files from the header and source | ||
subdirectories, as well as all needed common files. The common files can be | ||
added separately or as an entire directory with exclusions of inappropriate | ||
files. | ||
|
||
Doxyfiles | ||
--------- | ||
|
||
Doxyfile_common holds global settings. | ||
|
||
OUTPUT_DIRECTORY blank so that the output is placed in the current directory. | ||
RECURSIVE = NO | ||
EXTERNAL_GROUPS = NO | ||
|
||
Each Doxyfile_include for a processor family has: | ||
|
||
@INCLUDE = ../Doxyfile_common | ||
INPUT = specific directories needed, including /include/libopencm3/cm3 | ||
in top directory to set the top level page and GNU license. | ||
LAYOUT_FILE = DoxygenLayout_$processor.xml | ||
WARN_LOGFILE = doxygen_$processor.log | ||
TAGFILES = ../cm3/cm3.tag=../../cm3/html | ||
GENERATE_TAGFILE = $processor.tag | ||
PREDEFINED = list of macro definitions | ||
|
||
For the top level Doxyfile | ||
|
||
INPUT = ../include/libopencm3/docmain.dox to add in the main page text | ||
LAYOUT_FILE = DoxygenLayout.xml | ||
WARN_LOGFILE = doxygen.log | ||
TAGFILES = cm3/cm3.tag=../cm3/html plus all families to be included. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
# Makefile to build libopencm3 documentation | ||
|
||
# 14 September 2012 | ||
# (C) Ken Sarkies <ksarkies@internode.on.net> | ||
|
||
# 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/h7 \ | ||
stm32/l0 stm32/l1 stm32/l4 \ | ||
stm32/g0 stm32/g4 \ | ||
gd32/f1x0 \ | ||
efm32/g efm32/gg efm32/hg efm32/lg efm32/tg \ | ||
efm32/wg efm32/ezr32wg \ | ||
lm3s lm4f \ | ||
msp432/e4 \ | ||
lpc13xx lpc17xx lpc43xx \ | ||
sam/3a sam/3n sam/3s sam/3u sam/3x \ | ||
sam/d sam/4l \ | ||
vf6xx \ | ||
swm050 \ | ||
pac55xx | ||
|
||
|
||
TARGETS_DIRS = $(subst /,,$(TARGETS)) | ||
|
||
doc: html | ||
|
||
|
||
DoxygenLayout.xml: templates/DoxygenLayout_Root.xml | ||
../scripts/gendoxylayout.py --template $< --out $@ $(TARGETS_DIRS) | ||
|
||
define gen_DOC_TARGET | ||
DOC_TARGETS += doc_$(1) | ||
CLEAN_TARGETS += clean_$(1) | ||
|
||
$(1)/: | ||
@mkdir -p $$@ | ||
|
||
$(1)/doxy.sourcelist: $(1)/ | ||
@../scripts/gendoxylist ../lib/$(TARGET_SRC_DIR) $(1) | ||
|
||
$(1)/Doxyfile: templates/Doxyfile_Device | $(1)/ | ||
@cat $$< | sed 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) | ||
|
||
clean_$(1): | ||
@$(RM) -rf $(1)/doxy.sourcelist $(1)/Doxyfile $(1)/DoxygenLayout_$1.xml $(1)/doxygen_$(1).log $(1)/html $(1)/$(1).tag | ||
|
||
endef | ||
|
||
$(foreach TARGET_SRC_DIR, $(TARGETS), $(eval $(call gen_DOC_TARGET,$(subst /,,$(TARGET_SRC_DIR))))) | ||
|
||
html: $(DOC_TARGETS) DoxygenLayout.xml | ||
doxygen | ||
|
||
clean: $(CLEAN_TARGETS) | ||
@rm -rf html/ DoxygenLayout.xml doxygen.log | ||
|
||
.PHONY: doc html $(DOC_TARGETS) $(CLEAN_TARGETS) | ||
|
Oops, something went wrong.