git subrepo clone https://github.com/libopencm3/libopencm3.git
subrepo: subdir: "libopencm3" merged: "88e91c9a7cce" upstream: origin: "https://github.com/libopencm3/libopencm3.git" branch: "master" commit: "88e91c9a7cce" git-subrepo: version: "0.4.3" origin: "???" commit: "???"
This commit is contained in:
21
libopencm3/doc/Doxyfile
Normal file
21
libopencm3/doc/Doxyfile
Normal file
@@ -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
|
||||
|
||||
1809
libopencm3/doc/Doxyfile_common
Normal file
1809
libopencm3/doc/Doxyfile_common
Normal file
File diff suppressed because it is too large
Load Diff
106
libopencm3/doc/HACKING
Normal file
106
libopencm3/doc/HACKING
Normal file
@@ -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.
|
||||
|
||||
65
libopencm3/doc/Makefile
Normal file
65
libopencm3/doc/Makefile
Normal file
@@ -0,0 +1,65 @@
|
||||
# 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 \
|
||||
nrf/51 nrf/52 \
|
||||
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)
|
||||
|
||||
34
libopencm3/doc/README
Normal file
34
libopencm3/doc/README
Normal file
@@ -0,0 +1,34 @@
|
||||
libopencm3 Documentation
|
||||
14 September 2012 (C) K Sarkies
|
||||
-------------------------------
|
||||
|
||||
To generate all documentation run 'make doc' in the doc directory, or
|
||||
for html documentation only run 'make html' (much faster). This runs doxygen
|
||||
for each of the processor families then integrates the whole.
|
||||
|
||||
Alternatively run 'make doc' in the top directory to make html documentation.
|
||||
LaTeX and pdf documentation is currently very large in size.
|
||||
|
||||
This requires doxygen v 1.8.2 or later.
|
||||
|
||||
HTML, LaTeX, and pdf output can be produced.
|
||||
|
||||
Generation of HTML
|
||||
------------------
|
||||
|
||||
To view HTML, point a browser to libopencm3/doc/html/index.html.
|
||||
|
||||
Generation of PDF
|
||||
-----------------
|
||||
|
||||
The pdf is generated via LaTeX. The pdf files are placed in the
|
||||
doc directory. Each file contains all documentation for the core and common
|
||||
features. The resulting files are huge.
|
||||
|
||||
|
||||
Requirements
|
||||
------------
|
||||
On Fedora 19, the following packages (at least!) are needed to build the pdf
|
||||
output
|
||||
|
||||
texlive texlive-sectsty texlive-tocloft texlive-xtab texlive-multirow
|
||||
1
libopencm3/doc/efm32ezr32wg/doxy.custom
Normal file
1
libopencm3/doc/efm32ezr32wg/doxy.custom
Normal file
@@ -0,0 +1 @@
|
||||
PREDEFINED += __ARM_ARCH_7EM__
|
||||
1
libopencm3/doc/efm32g/doxy.custom
Normal file
1
libopencm3/doc/efm32g/doxy.custom
Normal file
@@ -0,0 +1 @@
|
||||
PREDEFINED += __ARM_ARCH_7M__
|
||||
1
libopencm3/doc/efm32gg/doxy.custom
Normal file
1
libopencm3/doc/efm32gg/doxy.custom
Normal file
@@ -0,0 +1 @@
|
||||
PREDEFINED += __ARM_ARCH_7M__
|
||||
1
libopencm3/doc/efm32hg/doxy.custom
Normal file
1
libopencm3/doc/efm32hg/doxy.custom
Normal file
@@ -0,0 +1 @@
|
||||
PREDEFINED += __ARM_ARCH_6M__
|
||||
1
libopencm3/doc/efm32lg/doxy.custom
Normal file
1
libopencm3/doc/efm32lg/doxy.custom
Normal file
@@ -0,0 +1 @@
|
||||
PREDEFINED += __ARM_ARCH_7M__
|
||||
1
libopencm3/doc/efm32tg/doxy.custom
Normal file
1
libopencm3/doc/efm32tg/doxy.custom
Normal file
@@ -0,0 +1 @@
|
||||
PREDEFINED += __ARM_ARCH_7M__
|
||||
1
libopencm3/doc/efm32wg/doxy.custom
Normal file
1
libopencm3/doc/efm32wg/doxy.custom
Normal file
@@ -0,0 +1 @@
|
||||
PREDEFINED += __ARM_ARCH_7EM__
|
||||
1
libopencm3/doc/gd32f1x0/doxy.custom
Normal file
1
libopencm3/doc/gd32f1x0/doxy.custom
Normal file
@@ -0,0 +1 @@
|
||||
PREDEFINED += __ARM_ARCH_7M__
|
||||
8
libopencm3/doc/index.html
Normal file
8
libopencm3/doc/index.html
Normal file
@@ -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>
|
||||
1
libopencm3/doc/lm3s/doxy.custom
Normal file
1
libopencm3/doc/lm3s/doxy.custom
Normal file
@@ -0,0 +1 @@
|
||||
PREDEFINED += __ARM_ARCH_7M__
|
||||
1
libopencm3/doc/lm4f/doxy.custom
Normal file
1
libopencm3/doc/lm4f/doxy.custom
Normal file
@@ -0,0 +1 @@
|
||||
PREDEFINED += __ARM_ARCH_7EM__
|
||||
1
libopencm3/doc/lpc13xx/doxy.custom
Normal file
1
libopencm3/doc/lpc13xx/doxy.custom
Normal file
@@ -0,0 +1 @@
|
||||
PREDEFINED += __ARM_ARCH_7M__
|
||||
1
libopencm3/doc/lpc17xx/doxy.custom
Normal file
1
libopencm3/doc/lpc17xx/doxy.custom
Normal file
@@ -0,0 +1 @@
|
||||
PREDEFINED += __ARM_ARCH_7M__
|
||||
3
libopencm3/doc/lpc43xx/doxy.custom
Normal file
3
libopencm3/doc/lpc43xx/doxy.custom
Normal file
@@ -0,0 +1,3 @@
|
||||
# Empty file to satisfy doxygen include.
|
||||
# this directory is for shared code between m3 and m4 cores of lpc43xx
|
||||
# So needs no predefined arch macros
|
||||
1
libopencm3/doc/lpc43xxm0/doxy.custom
Normal file
1
libopencm3/doc/lpc43xxm0/doxy.custom
Normal file
@@ -0,0 +1 @@
|
||||
PREDEFINED += __ARM_ARCH_6M__
|
||||
1
libopencm3/doc/lpc43xxm4/doxy.custom
Normal file
1
libopencm3/doc/lpc43xxm4/doxy.custom
Normal file
@@ -0,0 +1 @@
|
||||
PREDEFINED += __ARM_ARCH_7EM__
|
||||
1
libopencm3/doc/msp432e4/doxy.custom
Normal file
1
libopencm3/doc/msp432e4/doxy.custom
Normal file
@@ -0,0 +1 @@
|
||||
PREDEFINED += __ARM_ARCH_7EM__
|
||||
1
libopencm3/doc/nrf51/doxy.custom
Normal file
1
libopencm3/doc/nrf51/doxy.custom
Normal file
@@ -0,0 +1 @@
|
||||
PREDEFINED += __ARM_ARCH_7EM__
|
||||
1
libopencm3/doc/nrf52/doxy.custom
Normal file
1
libopencm3/doc/nrf52/doxy.custom
Normal file
@@ -0,0 +1 @@
|
||||
PREDEFINED += __ARM_ARCH_7EM__
|
||||
1
libopencm3/doc/pac55xx/doxy.custom
Normal file
1
libopencm3/doc/pac55xx/doxy.custom
Normal file
@@ -0,0 +1 @@
|
||||
PREDEFINED += __ARM_ARCH_7EM__
|
||||
1
libopencm3/doc/sam3a/doxy.custom
Normal file
1
libopencm3/doc/sam3a/doxy.custom
Normal file
@@ -0,0 +1 @@
|
||||
PREDEFINED += __ARM_ARCH_7M__
|
||||
1
libopencm3/doc/sam3n/doxy.custom
Normal file
1
libopencm3/doc/sam3n/doxy.custom
Normal file
@@ -0,0 +1 @@
|
||||
PREDEFINED += __ARM_ARCH_7M__
|
||||
1
libopencm3/doc/sam3s/doxy.custom
Normal file
1
libopencm3/doc/sam3s/doxy.custom
Normal file
@@ -0,0 +1 @@
|
||||
PREDEFINED += __ARM_ARCH_7M__
|
||||
1
libopencm3/doc/sam3u/doxy.custom
Normal file
1
libopencm3/doc/sam3u/doxy.custom
Normal file
@@ -0,0 +1 @@
|
||||
PREDEFINED += __ARM_ARCH_7M__
|
||||
1
libopencm3/doc/sam3x/doxy.custom
Normal file
1
libopencm3/doc/sam3x/doxy.custom
Normal file
@@ -0,0 +1 @@
|
||||
PREDEFINED += __ARM_ARCH_7M__
|
||||
1
libopencm3/doc/sam4l/doxy.custom
Normal file
1
libopencm3/doc/sam4l/doxy.custom
Normal file
@@ -0,0 +1 @@
|
||||
PREDEFINED += __ARM_ARCH_7EM__
|
||||
1
libopencm3/doc/samd/doxy.custom
Normal file
1
libopencm3/doc/samd/doxy.custom
Normal file
@@ -0,0 +1 @@
|
||||
PREDEFINED += __ARM_ARCH_6M__
|
||||
1
libopencm3/doc/stm32f0/doxy.custom
Normal file
1
libopencm3/doc/stm32f0/doxy.custom
Normal file
@@ -0,0 +1 @@
|
||||
PREDEFINED += __ARM_ARCH_6M__
|
||||
1
libopencm3/doc/stm32f1/doxy.custom
Normal file
1
libopencm3/doc/stm32f1/doxy.custom
Normal file
@@ -0,0 +1 @@
|
||||
PREDEFINED += __ARM_ARCH_7M__
|
||||
1
libopencm3/doc/stm32f2/doxy.custom
Normal file
1
libopencm3/doc/stm32f2/doxy.custom
Normal file
@@ -0,0 +1 @@
|
||||
PREDEFINED += __ARM_ARCH_7M__
|
||||
1
libopencm3/doc/stm32f3/doxy.custom
Normal file
1
libopencm3/doc/stm32f3/doxy.custom
Normal file
@@ -0,0 +1 @@
|
||||
PREDEFINED += __ARM_ARCH_7EM__
|
||||
1
libopencm3/doc/stm32f4/doxy.custom
Normal file
1
libopencm3/doc/stm32f4/doxy.custom
Normal file
@@ -0,0 +1 @@
|
||||
PREDEFINED += __ARM_ARCH_7EM__
|
||||
1
libopencm3/doc/stm32f7/doxy.custom
Normal file
1
libopencm3/doc/stm32f7/doxy.custom
Normal file
@@ -0,0 +1 @@
|
||||
PREDEFINED += __ARM_ARCH_7EM__
|
||||
1
libopencm3/doc/stm32g0/doxy.custom
Normal file
1
libopencm3/doc/stm32g0/doxy.custom
Normal file
@@ -0,0 +1 @@
|
||||
PREDEFINED += __ARM_ARCH_6M__
|
||||
1
libopencm3/doc/stm32g4/doxy.custom
Normal file
1
libopencm3/doc/stm32g4/doxy.custom
Normal file
@@ -0,0 +1 @@
|
||||
PREDEFINED += __ARM_ARCH_7EM__
|
||||
1
libopencm3/doc/stm32h7/doxy.custom
Normal file
1
libopencm3/doc/stm32h7/doxy.custom
Normal file
@@ -0,0 +1 @@
|
||||
PREDEFINED += __ARM_ARCH_7EM__
|
||||
1
libopencm3/doc/stm32l0/doxy.custom
Normal file
1
libopencm3/doc/stm32l0/doxy.custom
Normal file
@@ -0,0 +1 @@
|
||||
PREDEFINED += __ARM_ARCH_6M__
|
||||
1
libopencm3/doc/stm32l1/doxy.custom
Normal file
1
libopencm3/doc/stm32l1/doxy.custom
Normal file
@@ -0,0 +1 @@
|
||||
PREDEFINED += __ARM_ARCH_7M__
|
||||
1
libopencm3/doc/stm32l4/doxy.custom
Normal file
1
libopencm3/doc/stm32l4/doxy.custom
Normal file
@@ -0,0 +1 @@
|
||||
PREDEFINED += __ARM_ARCH_7EM__
|
||||
1
libopencm3/doc/swm050/doxy.custom
Normal file
1
libopencm3/doc/swm050/doxy.custom
Normal file
@@ -0,0 +1 @@
|
||||
PREDEFINED += __ARM_ARCH_6M__
|
||||
8
libopencm3/doc/templates/Doxyfile_Device
vendored
Normal file
8
libopencm3/doc/templates/Doxyfile_Device
vendored
Normal file
@@ -0,0 +1,8 @@
|
||||
@INCLUDE = ../Doxyfile_common
|
||||
INPUT = ../../include/libopencm3/license.dox
|
||||
@INCLUDE = doxy.sourcelist
|
||||
@INCLUDE = doxy.custom
|
||||
WARN_LOGFILE = doxygen_#device#.log
|
||||
LAYOUT_FILE = DoxygenLayout_#device#.xml
|
||||
GENERATE_TAGFILE = #device#.tag
|
||||
ENABLE_PREPROCESSING = YES
|
||||
185
libopencm3/doc/templates/DoxygenLayout_Device.xml
vendored
Normal file
185
libopencm3/doc/templates/DoxygenLayout_Device.xml
vendored
Normal file
@@ -0,0 +1,185 @@
|
||||
<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=""/>
|
||||
<!-- #devices# -->
|
||||
<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>
|
||||
174
libopencm3/doc/templates/DoxygenLayout_Root.xml
vendored
Normal file
174
libopencm3/doc/templates/DoxygenLayout_Root.xml
vendored
Normal file
@@ -0,0 +1,174 @@
|
||||
<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=""/>
|
||||
<!-- #devices# -->
|
||||
<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>
|
||||
1
libopencm3/doc/vf6xx/doxy.custom
Normal file
1
libopencm3/doc/vf6xx/doxy.custom
Normal file
@@ -0,0 +1 @@
|
||||
PREDEFINED += __ARM_ARCH_7EM__
|
||||
Reference in New Issue
Block a user