Documentation updates
This commit is contained in:
Ken Sarkies
parent
971a295d43
commit
35c0863a75
2
Makefile
2
Makefile
|
|
@ -90,7 +90,7 @@ install: lib
|
|||
$(Q)$(INSTALL) -m 0644 scripts/* $(SHAREDIR)
|
||||
|
||||
doc:
|
||||
$(Q)$(MAKE) -C doc doc
|
||||
$(Q)$(MAKE) -C doc html
|
||||
|
||||
# Bleh http://www.makelinux.net/make3/make3-CHP-6-SECT-1#make3-CHP-6-SECT-1
|
||||
clean: cleanheaders
|
||||
|
|
|
|||
|
|
@ -536,7 +536,7 @@ GENERATE_BUGLIST = YES
|
|||
# disable (NO) the deprecated list. This list is created by putting
|
||||
# \deprecated commands in the documentation.
|
||||
|
||||
GENERATE_DEPRECATEDLIST= YES
|
||||
GENERATE_DEPRECATEDLIST= NO
|
||||
|
||||
# The ENABLED_SECTIONS tag can be used to enable conditional
|
||||
# documentation sections, marked by \if sectionname ... \endif.
|
||||
|
|
|
|||
|
|
@ -5,14 +5,18 @@
|
|||
<tab type="pages" visible="yes" title="General Information" intro=""/>
|
||||
<tab type="user" visible="yes" url="../html/index.html" title="Top Level" intro=""/>
|
||||
<tab type="user" visible="yes" url="../cm3/html/modules.html" title="CM3 Core" intro=""/>
|
||||
<tab type="user" visible="yes" url="../stm32/html/modules.html" title="STM32 Common" 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="../stm32f4/html/modules.html" title="STM32F4" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/>
|
||||
<tab type="user" visible="yes" url="../lm3s/html/modules.html" title="LM3S" 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="../../emf32g/html/modules.html" title="EMF32 Gecko" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../emf32gg/html/modules.html" title="EMF32 Giant Gecko" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../emf32lg/html/modules.html" title="EMF32 Leopard Gecko" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../emf32tg/html/modules.html" title="EMF32 Tiny Gecko" intro=""/>
|
||||
<tab type="namespaces" visible="yes" title="">
|
||||
<tab type="namespaces" visible="yes" title="" intro=""/>
|
||||
<tab type="namespacemembers" visible="yes" title="" intro=""/>
|
||||
|
|
|
|||
|
|
@ -0,0 +1,89 @@
|
|||
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. LaTeX and pdf files are produced
|
||||
separately. Due to relative referencing used in the files, the directory
|
||||
structure is important and should be maintained.
|
||||
|
||||
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. Tag files are generated and used by other doxygen runs to resolve links.
|
||||
|
||||
Tagfiles
|
||||
--------
|
||||
|
||||
Tagfiles contain all information about the document, and are used to resolve
|
||||
references in other documents. The groups defined in these external documents
|
||||
are not shown when EXTERNAL_GROUPS = NO. The high level tagfiles must be
|
||||
generated before any others so order is important.
|
||||
|
||||
As well as the processor families, a "cm3" subdirectory is used to generate
|
||||
a tagfile to integrate the CM3 common core defines.
|
||||
|
||||
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 family must have a heading section
|
||||
in which an @defgroup defines the group names. 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.
|
||||
|
||||
Common header and source files must have an @addgroup to include its
|
||||
documentation into the appropriate peripheral group. These must not have any
|
||||
reference to family groupings to allow them to be incorporated into multiple
|
||||
family groups.
|
||||
|
||||
Each function must have a header with an @brief, and where appropriate
|
||||
@parameter and @return elements. These must describe the allowable parameter
|
||||
ranges preferably with reference to a suitable define.
|
||||
|
||||
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
|
||||
|
||||
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.
|
||||
|
||||
Generation of PDF
|
||||
-----------------
|
||||
|
||||
The needs for pdf documents differ from HTML so separate Doxyfile_latex
|
||||
files are provided.
|
||||
|
||||
@INCLUDE = ../Doxyfile_common
|
||||
GENERATE_LATEX = YES
|
||||
GENERATE_HTML = NO
|
||||
|
||||
39
doc/Makefile
39
doc/Makefile
|
|
@ -5,7 +5,7 @@
|
|||
|
||||
doc: html latex
|
||||
|
||||
html: cm3 stm32 stm32f1 stm32f2 stm32f4 lm3s lpc13 lpc17 lpc43 top
|
||||
html: cm3 stm32l1 stm32f1 stm32f2 stm32f4 efm32g efm32gg efm32lg efm32tg lm3s lpc13 lpc17 lpc43 top
|
||||
|
||||
cm3:
|
||||
cd cm3/; doxygen
|
||||
|
|
@ -13,6 +13,18 @@ cm3:
|
|||
lm3s:
|
||||
cd lm3s/; doxygen
|
||||
|
||||
efm32g:
|
||||
cd efm32g/; doxygen
|
||||
|
||||
efm32gg:
|
||||
cd efm32gg/; doxygen
|
||||
|
||||
efm32lg:
|
||||
cd efm32lg/; doxygen
|
||||
|
||||
efm32tg:
|
||||
cd efm32tg/; doxygen
|
||||
|
||||
lpc13:
|
||||
cd lpc13xx/; doxygen
|
||||
|
||||
|
|
@ -22,9 +34,6 @@ lpc17:
|
|||
lpc43:
|
||||
cd lpc43xx/; doxygen
|
||||
|
||||
stm32:
|
||||
cd stm32/; doxygen
|
||||
|
||||
stm32f1:
|
||||
cd stm32f1/; doxygen
|
||||
|
||||
|
|
@ -34,10 +43,16 @@ stm32f2:
|
|||
stm32f4:
|
||||
cd stm32f4/; doxygen
|
||||
|
||||
stm32l1:
|
||||
cd stm32l1/; doxygen
|
||||
|
||||
top:
|
||||
doxygen
|
||||
|
||||
latex: stm32f1.pdf stm32f2.pdf stm32f4.pdf lm3s.pdf lpc13.pdf lpc17.pdf lpc43.pdf
|
||||
latex: stm32l1.pdf stm32f1.pdf stm32f2.pdf stm32f4.pdf lm3s.pdf lpc13.pdf lpc17.pdf lpc43.pdf efm32g.pdf efm32gg.pdf efm32lg.pdf efm32tg.pdf
|
||||
|
||||
stm32l1.pdf:
|
||||
cd stm32l1/; doxygen Doxyfile_latex; cd latex/; $(MAKE); cp refman.pdf ../../stm32l1.pdf
|
||||
|
||||
stm32f1.pdf:
|
||||
cd stm32f1/; doxygen Doxyfile_latex; cd latex/; $(MAKE); cp refman.pdf ../../stm32f1.pdf
|
||||
|
|
@ -60,8 +75,20 @@ lpc17.pdf:
|
|||
lpc43.pdf:
|
||||
cd lpc43xx/; doxygen Doxyfile_latex; cd latex/; $(MAKE); cp refman.pdf ../../lpc43.pdf
|
||||
|
||||
efm32g.pdf:
|
||||
cd efm32g/; doxygen Doxyfile_latex; cd latex/; $(MAKE); cp refman.pdf ../../efm32g.pdf
|
||||
|
||||
efm32gg.pdf:
|
||||
cd efm32gg/; doxygen Doxyfile_latex; cd latex/; $(MAKE); cp refman.pdf ../../efm32gg.pdf
|
||||
|
||||
efm32lg.pdf:
|
||||
cd efm32lg/; doxygen Doxyfile_latex; cd latex/; $(MAKE); cp refman.pdf ../../efm32lg.pdf
|
||||
|
||||
efm32tg.pdf:
|
||||
cd efm32tg/; doxygen Doxyfile_latex; cd latex/; $(MAKE); cp refman.pdf ../../efm32tg.pdf
|
||||
|
||||
clean:
|
||||
@rm -rf html/ */html/ */latex/ *.pdf */*.tag
|
||||
|
||||
.PHONY: doc html cm3 lm3s lpc13 lpc17 lpc43 stm32 stm32f1 stm32f2 stm32f4 top latex
|
||||
.PHONY: doc html cm3 lm3s lpc13 lpc17 lpc43 stm32l1 stm32f1 stm32f2 stm32f4 efm32g efm32gg efm32lg efm32tg top latex
|
||||
|
||||
|
|
|
|||
63
doc/README
63
doc/README
|
|
@ -1,68 +1,27 @@
|
|||
libopencm3 Documentation
|
||||
14 September 2012 (C) K Sarkies
|
||||
------------------------
|
||||
-------------------------------
|
||||
|
||||
To generate documentation run 'make doc' in the doc directory. This
|
||||
runs doxygen for each of the processor families then integrates the whole.
|
||||
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 is produced.
|
||||
HTML, LaTeX, and pdf output can be produced.
|
||||
|
||||
Generation of HTML
|
||||
------------------
|
||||
|
||||
To view HTML, point a browser to doc/html/index.html.
|
||||
|
||||
The directory structure is important and should be maintained.
|
||||
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. Tag files are generated and used by other doxygen runs to resolve links.
|
||||
|
||||
Tagfiles contain all information about the document, and are used to resolve
|
||||
references in other documents. The groups defined in these external documents
|
||||
are not shown when EXTERNAL_GROUPS = NO. The high level tagfiles must be generated
|
||||
before any others.
|
||||
|
||||
As well as the processor families, a "cm3" subdirectory is used to generate
|
||||
a tagfile to integrate the CM3 common core defines.
|
||||
|
||||
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
|
||||
|
||||
For the STM32 subfamilies, to include the common files references, add
|
||||
TAGFILES += ../stm32/stm32.tag=../../stm32/html
|
||||
|
||||
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.
|
||||
To view HTML, point a browser to libopencm3/doc/html/index.html.
|
||||
|
||||
Generation of PDF
|
||||
-----------------
|
||||
|
||||
The pdf is generated via LaTeX. The needs for the documents differ from HTML
|
||||
so separate Doxyfile_latex are provided. The pdf files are placed in the
|
||||
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.
|
||||
|
||||
@INCLUDE = ../Doxyfile_common
|
||||
GENERATE_LATEX = YES
|
||||
GENERATE_HTML = NO
|
||||
features. The resulting files are huge.
|
||||
|
||||
|
|
|
|||
|
|
@ -8,10 +8,15 @@
|
|||
<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="../../stm32f4/html/modules.html" title="STM32F4" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../lm3s/html/modules.html" title="LM3S" 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="../../emf32g/html/modules.html" title="EMF32 Gecko" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../emf32gg/html/modules.html" title="EMF32 Giant Gecko" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../emf32lg/html/modules.html" title="EMF32 Leopard Gecko" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../emf32tg/html/modules.html" title="EMF32 Tiny Gecko" intro=""/>
|
||||
<tab type="namespaces" visible="yes" title="">
|
||||
<tab type="namespaces" visible="yes" title="" intro=""/>
|
||||
<tab type="namespacemembers" visible="yes" title="" intro=""/>
|
||||
|
|
|
|||
|
|
@ -0,0 +1,29 @@
|
|||
# HTML Documentation for efm32 code level
|
||||
|
||||
# 11 November 2012
|
||||
# (C) Ken Sarkies <ksarkies@internode.on.net>
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Common Include File
|
||||
#---------------------------------------------------------------------------
|
||||
|
||||
@INCLUDE = ../Doxyfile_common
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Local settings
|
||||
#---------------------------------------------------------------------------
|
||||
|
||||
WARN_LOGFILE = doxygen_efm32g.log
|
||||
|
||||
INPUT = ../../include/libopencm3/license.dox \
|
||||
../../include/libopencm3/efm32/efm32g \
|
||||
../../lib/efm32/efm32g
|
||||
|
||||
EXCLUDE =
|
||||
|
||||
LAYOUT_FILE = DoxygenLayout_efm32g.xml
|
||||
|
||||
TAGFILES = ../cm3/cm3.tag=../../cm3/html \
|
||||
|
||||
GENERATE_TAGFILE = efm32g.tag
|
||||
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
# LaTeX Documentation for efm32 code level
|
||||
|
||||
# 12 November 2012
|
||||
# (C) Ken Sarkies <ksarkies@internode.on.net>
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Common Include File
|
||||
#---------------------------------------------------------------------------
|
||||
|
||||
@INCLUDE = ../Doxyfile_common
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Local settings
|
||||
#---------------------------------------------------------------------------
|
||||
|
||||
WARN_LOGFILE = doxygen_efm32g_latex.log
|
||||
|
||||
INPUT = ../../include/libopencm3/docmain.dox \
|
||||
../../include/libopencm3/license.dox \
|
||||
../../include/libopencm3/efm32/efm32g \
|
||||
../../lib/efm32/efm32g
|
||||
|
||||
EXCLUDE = ../../include/libopencm3/efm32/doc-efm32g.h
|
||||
|
||||
LAYOUT_FILE = DoxygenLayout_efm32g.xml
|
||||
|
||||
GENERATE_HTML = NO
|
||||
|
||||
GENERATE_LATEX = YES
|
||||
|
||||
LATEX_HEADER = header_efm32g.tex
|
||||
|
||||
|
|
@ -0,0 +1,197 @@
|
|||
<doxygenlayout version="1.0">
|
||||
<!-- Navigation index tabs for HTML output -->
|
||||
<navindex>
|
||||
<tab type="mainpage" visible="yes" title="libopencm3"/>
|
||||
<tab type="pages" visible="yes" title="General Information" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../html/index.html" title="Back to Top" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../cm3/html/modules.html" title="CM3 Core" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../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="../../stm32f4/html/modules.html" title="STM32F4" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../lm3s/html/modules.html" title="LM3S" 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="modules" visible="yes" title="EFM32 Gecko" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../emf32gg/html/modules.html" title="EMF32 Giant Gecko" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../emf32lg/html/modules.html" title="EMF32 Leopard Gecko" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../emf32tg/html/modules.html" title="EMF32 Tiny Gecko" 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>
|
||||
|
|
@ -0,0 +1,61 @@
|
|||
\documentclass{book}
|
||||
\usepackage[a4paper,top=2.5cm,bottom=2.5cm,left=2.5cm,right=2.5cm]{geometry}
|
||||
\usepackage{makeidx}
|
||||
\usepackage{natbib}
|
||||
\usepackage{graphicx}
|
||||
\usepackage{multicol}
|
||||
\usepackage{float}
|
||||
\usepackage{listings}
|
||||
\usepackage{color}
|
||||
\usepackage{ifthen}
|
||||
\usepackage[table]{xcolor}
|
||||
\usepackage{textcomp}
|
||||
\usepackage{alltt}
|
||||
\usepackage{ifpdf}
|
||||
\ifpdf
|
||||
\usepackage[pdftex,
|
||||
pagebackref=true,
|
||||
colorlinks=true,
|
||||
linkcolor=blue,
|
||||
unicode
|
||||
]{hyperref}
|
||||
\else
|
||||
\usepackage[ps2pdf,
|
||||
pagebackref=true,
|
||||
colorlinks=true,
|
||||
linkcolor=blue,
|
||||
unicode
|
||||
]{hyperref}
|
||||
\usepackage{pspicture}
|
||||
\fi
|
||||
\usepackage[utf8]{inputenc}
|
||||
\usepackage{mathptmx}
|
||||
\usepackage[scaled=.90]{helvet}
|
||||
\usepackage{courier}
|
||||
\usepackage{sectsty}
|
||||
\usepackage{amssymb}
|
||||
\usepackage[titles]{tocloft}
|
||||
\usepackage{doxygen}
|
||||
\lstset{language=C++,inputencoding=utf8,basicstyle=\footnotesize,breaklines=true,breakatwhitespace=true,tabsize=4,numbers=left }
|
||||
\makeindex
|
||||
\setcounter{tocdepth}{3}
|
||||
\renewcommand{\footrulewidth}{0.4pt}
|
||||
\renewcommand{\familydefault}{\sfdefault}
|
||||
\hfuzz=15pt
|
||||
\setlength{\emergencystretch}{15pt}
|
||||
\hbadness=750
|
||||
\tolerance=750
|
||||
\begin{document}
|
||||
\hypersetup{pageanchor=false,citecolor=blue}
|
||||
\begin{titlepage}
|
||||
\vspace*{7cm}
|
||||
\begin{center}
|
||||
{\Huge libopencm3: API Reference\\ EFM32 Gecko ARM Cortex M3 Series}\\
|
||||
\vspace*{1cm}
|
||||
{\large Generated by Doxygen 1.8.2}\\
|
||||
\vspace*{0.5cm}
|
||||
{\small Thu Sep 13 2012 23:26:45}\\
|
||||
\end{center}
|
||||
\end{titlepage}
|
||||
\pagenumbering{arabic}
|
||||
\hypersetup{pageanchor=true,citecolor=blue}
|
||||
|
|
@ -0,0 +1,29 @@
|
|||
# HTML Documentation for efm32 code level
|
||||
|
||||
# 11 November 2012
|
||||
# (C) Ken Sarkies <ksarkies@internode.on.net>
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Common Include File
|
||||
#---------------------------------------------------------------------------
|
||||
|
||||
@INCLUDE = ../Doxyfile_common
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Local settings
|
||||
#---------------------------------------------------------------------------
|
||||
|
||||
WARN_LOGFILE = doxygen_efm32gg.log
|
||||
|
||||
INPUT = ../../include/libopencm3/license.dox \
|
||||
../../include/libopencm3/efm32/efm32gg \
|
||||
../../lib/efm32/efm32gg
|
||||
|
||||
EXCLUDE =
|
||||
|
||||
LAYOUT_FILE = DoxygenLayout_efm32gg.xml
|
||||
|
||||
TAGFILES = ../cm3/cm3.tag=../../cm3/html \
|
||||
|
||||
GENERATE_TAGFILE = efm32gg.tag
|
||||
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
# LaTeX Documentation for efm32 code level
|
||||
|
||||
# 12 November 2012
|
||||
# (C) Ken Sarkies <ksarkies@internode.on.net>
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Common Include File
|
||||
#---------------------------------------------------------------------------
|
||||
|
||||
@INCLUDE = ../Doxyfile_common
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Local settings
|
||||
#---------------------------------------------------------------------------
|
||||
|
||||
WARN_LOGFILE = doxygen_efm32gg_latex.log
|
||||
|
||||
INPUT = ../../include/libopencm3/docmain.dox \
|
||||
../../include/libopencm3/license.dox \
|
||||
../../include/libopencm3/efm32/efm32gg \
|
||||
../../lib/efm32/efm32gg
|
||||
|
||||
EXCLUDE = ../../include/libopencm3/efm32/doc-efm32gg.h
|
||||
|
||||
LAYOUT_FILE = DoxygenLayout_efm32gg.xml
|
||||
|
||||
GENERATE_HTML = NO
|
||||
|
||||
GENERATE_LATEX = YES
|
||||
|
||||
LATEX_HEADER = header_efm32gg.tex
|
||||
|
||||
|
|
@ -0,0 +1,197 @@
|
|||
<doxygenlayout version="1.0">
|
||||
<!-- Navigation index tabs for HTML output -->
|
||||
<navindex>
|
||||
<tab type="mainpage" visible="yes" title="libopencm3"/>
|
||||
<tab type="pages" visible="yes" title="General Information" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../html/index.html" title="Back to Top" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../cm3/html/modules.html" title="CM3 Core" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../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="../../stm32f4/html/modules.html" title="STM32F4" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../lm3s/html/modules.html" title="LM3S" 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="../../emf32g/html/modules.html" title="EMF32 Gecko" intro=""/>
|
||||
<tab type="modules" visible="yes" title="EFM32 Giant Gecko" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../emf32lg/html/modules.html" title="EMF32 Leopard Gecko" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../emf32tg/html/modules.html" title="EMF32 Tiny Gecko" 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>
|
||||
|
|
@ -0,0 +1,61 @@
|
|||
\documentclass{book}
|
||||
\usepackage[a4paper,top=2.5cm,bottom=2.5cm,left=2.5cm,right=2.5cm]{geometry}
|
||||
\usepackage{makeidx}
|
||||
\usepackage{natbib}
|
||||
\usepackage{graphicx}
|
||||
\usepackage{multicol}
|
||||
\usepackage{float}
|
||||
\usepackage{listings}
|
||||
\usepackage{color}
|
||||
\usepackage{ifthen}
|
||||
\usepackage[table]{xcolor}
|
||||
\usepackage{textcomp}
|
||||
\usepackage{alltt}
|
||||
\usepackage{ifpdf}
|
||||
\ifpdf
|
||||
\usepackage[pdftex,
|
||||
pagebackref=true,
|
||||
colorlinks=true,
|
||||
linkcolor=blue,
|
||||
unicode
|
||||
]{hyperref}
|
||||
\else
|
||||
\usepackage[ps2pdf,
|
||||
pagebackref=true,
|
||||
colorlinks=true,
|
||||
linkcolor=blue,
|
||||
unicode
|
||||
]{hyperref}
|
||||
\usepackage{pspicture}
|
||||
\fi
|
||||
\usepackage[utf8]{inputenc}
|
||||
\usepackage{mathptmx}
|
||||
\usepackage[scaled=.90]{helvet}
|
||||
\usepackage{courier}
|
||||
\usepackage{sectsty}
|
||||
\usepackage{amssymb}
|
||||
\usepackage[titles]{tocloft}
|
||||
\usepackage{doxygen}
|
||||
\lstset{language=C++,inputencoding=utf8,basicstyle=\footnotesize,breaklines=true,breakatwhitespace=true,tabsize=4,numbers=left }
|
||||
\makeindex
|
||||
\setcounter{tocdepth}{3}
|
||||
\renewcommand{\footrulewidth}{0.4pt}
|
||||
\renewcommand{\familydefault}{\sfdefault}
|
||||
\hfuzz=15pt
|
||||
\setlength{\emergencystretch}{15pt}
|
||||
\hbadness=750
|
||||
\tolerance=750
|
||||
\begin{document}
|
||||
\hypersetup{pageanchor=false,citecolor=blue}
|
||||
\begin{titlepage}
|
||||
\vspace*{7cm}
|
||||
\begin{center}
|
||||
{\Huge libopencm3: API Reference\\ EFM32 Giant Gecko ARM Cortex M3 Series}\\
|
||||
\vspace*{1cm}
|
||||
{\large Generated by Doxygen 1.8.2}\\
|
||||
\vspace*{0.5cm}
|
||||
{\small Thu Sep 13 2012 23:26:45}\\
|
||||
\end{center}
|
||||
\end{titlepage}
|
||||
\pagenumbering{arabic}
|
||||
\hypersetup{pageanchor=true,citecolor=blue}
|
||||
|
|
@ -0,0 +1,29 @@
|
|||
# HTML Documentation for efm32 code level
|
||||
|
||||
# 11 November 2012
|
||||
# (C) Ken Sarkies <ksarkies@internode.on.net>
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Common Include File
|
||||
#---------------------------------------------------------------------------
|
||||
|
||||
@INCLUDE = ../Doxyfile_common
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Local settings
|
||||
#---------------------------------------------------------------------------
|
||||
|
||||
WARN_LOGFILE = doxygen_efm32lg.log
|
||||
|
||||
INPUT = ../../include/libopencm3/license.dox \
|
||||
../../include/libopencm3/efm32/efm32lg \
|
||||
../../lib/efm32/efm32lg
|
||||
|
||||
EXCLUDE =
|
||||
|
||||
LAYOUT_FILE = DoxygenLayout_efm32lg.xml
|
||||
|
||||
TAGFILES = ../cm3/cm3.tag=../../cm3/html \
|
||||
|
||||
GENERATE_TAGFILE = efm32lg.tag
|
||||
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
# LaTeX Documentation for efm32 code level
|
||||
|
||||
# 12 November 2012
|
||||
# (C) Ken Sarkies <ksarkies@internode.on.net>
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Common Include File
|
||||
#---------------------------------------------------------------------------
|
||||
|
||||
@INCLUDE = ../Doxyfile_common
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Local settings
|
||||
#---------------------------------------------------------------------------
|
||||
|
||||
WARN_LOGFILE = doxygen_efm32lg_latex.log
|
||||
|
||||
INPUT = ../../include/libopencm3/docmain.dox \
|
||||
../../include/libopencm3/license.dox \
|
||||
../../include/libopencm3/efm32/efm32lg \
|
||||
../../lib/efm32/efm32lg
|
||||
|
||||
EXCLUDE = ../../include/libopencm3/efm32/doc-efm32lg.h
|
||||
|
||||
LAYOUT_FILE = DoxygenLayout_efm32lg.xml
|
||||
|
||||
GENERATE_HTML = NO
|
||||
|
||||
GENERATE_LATEX = YES
|
||||
|
||||
LATEX_HEADER = header_efm32lg.tex
|
||||
|
||||
|
|
@ -0,0 +1,197 @@
|
|||
<doxygenlayout version="1.0">
|
||||
<!-- Navigation index tabs for HTML output -->
|
||||
<navindex>
|
||||
<tab type="mainpage" visible="yes" title="libopencm3"/>
|
||||
<tab type="pages" visible="yes" title="General Information" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../html/index.html" title="Back to Top" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../cm3/html/modules.html" title="CM3 Core" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../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="../../stm32f4/html/modules.html" title="STM32F4" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../lm3s/html/modules.html" title="LM3S" 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="../../emf32g/html/modules.html" title="EMF32 Gecko" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../emf32gg/html/modules.html" title="EMF32 Giant Gecko" intro=""/>
|
||||
<tab type="modules" visible="yes" title="EFM32 Leopard Gecko" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../emf32tg/html/modules.html" title="EMF32 Tiny Gecko" 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>
|
||||
|
|
@ -0,0 +1,61 @@
|
|||
\documentclass{book}
|
||||
\usepackage[a4paper,top=2.5cm,bottom=2.5cm,left=2.5cm,right=2.5cm]{geometry}
|
||||
\usepackage{makeidx}
|
||||
\usepackage{natbib}
|
||||
\usepackage{graphicx}
|
||||
\usepackage{multicol}
|
||||
\usepackage{float}
|
||||
\usepackage{listings}
|
||||
\usepackage{color}
|
||||
\usepackage{ifthen}
|
||||
\usepackage[table]{xcolor}
|
||||
\usepackage{textcomp}
|
||||
\usepackage{alltt}
|
||||
\usepackage{ifpdf}
|
||||
\ifpdf
|
||||
\usepackage[pdftex,
|
||||
pagebackref=true,
|
||||
colorlinks=true,
|
||||
linkcolor=blue,
|
||||
unicode
|
||||
]{hyperref}
|
||||
\else
|
||||
\usepackage[ps2pdf,
|
||||
pagebackref=true,
|
||||
colorlinks=true,
|
||||
linkcolor=blue,
|
||||
unicode
|
||||
]{hyperref}
|
||||
\usepackage{pspicture}
|
||||
\fi
|
||||
\usepackage[utf8]{inputenc}
|
||||
\usepackage{mathptmx}
|
||||
\usepackage[scaled=.90]{helvet}
|
||||
\usepackage{courier}
|
||||
\usepackage{sectsty}
|
||||
\usepackage{amssymb}
|
||||
\usepackage[titles]{tocloft}
|
||||
\usepackage{doxygen}
|
||||
\lstset{language=C++,inputencoding=utf8,basicstyle=\footnotesize,breaklines=true,breakatwhitespace=true,tabsize=4,numbers=left }
|
||||
\makeindex
|
||||
\setcounter{tocdepth}{3}
|
||||
\renewcommand{\footrulewidth}{0.4pt}
|
||||
\renewcommand{\familydefault}{\sfdefault}
|
||||
\hfuzz=15pt
|
||||
\setlength{\emergencystretch}{15pt}
|
||||
\hbadness=750
|
||||
\tolerance=750
|
||||
\begin{document}
|
||||
\hypersetup{pageanchor=false,citecolor=blue}
|
||||
\begin{titlepage}
|
||||
\vspace*{7cm}
|
||||
\begin{center}
|
||||
{\Huge libopencm3: API Reference\\ EFM32 Leopard Gecko ARM Cortex M3 Series}\\
|
||||
\vspace*{1cm}
|
||||
{\large Generated by Doxygen 1.8.2}\\
|
||||
\vspace*{0.5cm}
|
||||
{\small Thu Sep 13 2012 23:26:45}\\
|
||||
\end{center}
|
||||
\end{titlepage}
|
||||
\pagenumbering{arabic}
|
||||
\hypersetup{pageanchor=true,citecolor=blue}
|
||||
|
|
@ -0,0 +1,29 @@
|
|||
# HTML Documentation for efm32 code level
|
||||
|
||||
# 11 November 2012
|
||||
# (C) Ken Sarkies <ksarkies@internode.on.net>
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Common Include File
|
||||
#---------------------------------------------------------------------------
|
||||
|
||||
@INCLUDE = ../Doxyfile_common
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Local settings
|
||||
#---------------------------------------------------------------------------
|
||||
|
||||
WARN_LOGFILE = doxygen_efm32tg.log
|
||||
|
||||
INPUT = ../../include/libopencm3/license.dox \
|
||||
../../include/libopencm3/efm32/efm32tg \
|
||||
../../lib/efm32/efm32tg
|
||||
|
||||
EXCLUDE =
|
||||
|
||||
LAYOUT_FILE = DoxygenLayout_efm32tg.xml
|
||||
|
||||
TAGFILES = ../cm3/cm3.tag=../../cm3/html \
|
||||
|
||||
GENERATE_TAGFILE = efm32tg.tag
|
||||
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
# LaTeX Documentation for efm32 code level
|
||||
|
||||
# 12 November 2012
|
||||
# (C) Ken Sarkies <ksarkies@internode.on.net>
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Common Include File
|
||||
#---------------------------------------------------------------------------
|
||||
|
||||
@INCLUDE = ../Doxyfile_common
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Local settings
|
||||
#---------------------------------------------------------------------------
|
||||
|
||||
WARN_LOGFILE = doxygen_efm32tg_latex.log
|
||||
|
||||
INPUT = ../../include/libopencm3/docmain.dox \
|
||||
../../include/libopencm3/license.dox \
|
||||
../../include/libopencm3/efm32/efm32tg \
|
||||
../../lib/efm32/efm32tg
|
||||
|
||||
EXCLUDE = ../../include/libopencm3/efm32/doc-efm32tg.h
|
||||
|
||||
LAYOUT_FILE = DoxygenLayout_efm32tg.xml
|
||||
|
||||
GENERATE_HTML = NO
|
||||
|
||||
GENERATE_LATEX = YES
|
||||
|
||||
LATEX_HEADER = header_efm32tg.tex
|
||||
|
||||
|
|
@ -5,14 +5,17 @@
|
|||
<tab type="pages" visible="yes" title="General Information" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../html/index.html" title="Back to Top" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../cm3/html/modules.html" title="CM3 Core" intro=""/>
|
||||
<tab type="modules" visible="yes" title="STM32 Common" 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="../../stm32f4/html/modules.html" title="STM32F4" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../lm3s/html/modules.html" title="LM3S" 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="../../emf32g/html/modules.html" title="EMF32 Gecko" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../emf32gg/html/modules.html" title="EMF32 Giant Gecko" intro=""/>
|
||||
<tab type="modules" visible="yes" title="EFM32 Tiny Gecko" intro=""/>
|
||||
<tab type="namespaces" visible="yes" title="">
|
||||
<tab type="namespaces" visible="yes" title="" intro=""/>
|
||||
<tab type="namespacemembers" visible="yes" title="" intro=""/>
|
||||
|
|
@ -0,0 +1,61 @@
|
|||
\documentclass{book}
|
||||
\usepackage[a4paper,top=2.5cm,bottom=2.5cm,left=2.5cm,right=2.5cm]{geometry}
|
||||
\usepackage{makeidx}
|
||||
\usepackage{natbib}
|
||||
\usepackage{graphicx}
|
||||
\usepackage{multicol}
|
||||
\usepackage{float}
|
||||
\usepackage{listings}
|
||||
\usepackage{color}
|
||||
\usepackage{ifthen}
|
||||
\usepackage[table]{xcolor}
|
||||
\usepackage{textcomp}
|
||||
\usepackage{alltt}
|
||||
\usepackage{ifpdf}
|
||||
\ifpdf
|
||||
\usepackage[pdftex,
|
||||
pagebackref=true,
|
||||
colorlinks=true,
|
||||
linkcolor=blue,
|
||||
unicode
|
||||
]{hyperref}
|
||||
\else
|
||||
\usepackage[ps2pdf,
|
||||
pagebackref=true,
|
||||
colorlinks=true,
|
||||
linkcolor=blue,
|
||||
unicode
|
||||
]{hyperref}
|
||||
\usepackage{pspicture}
|
||||
\fi
|
||||
\usepackage[utf8]{inputenc}
|
||||
\usepackage{mathptmx}
|
||||
\usepackage[scaled=.90]{helvet}
|
||||
\usepackage{courier}
|
||||
\usepackage{sectsty}
|
||||
\usepackage{amssymb}
|
||||
\usepackage[titles]{tocloft}
|
||||
\usepackage{doxygen}
|
||||
\lstset{language=C++,inputencoding=utf8,basicstyle=\footnotesize,breaklines=true,breakatwhitespace=true,tabsize=4,numbers=left }
|
||||
\makeindex
|
||||
\setcounter{tocdepth}{3}
|
||||
\renewcommand{\footrulewidth}{0.4pt}
|
||||
\renewcommand{\familydefault}{\sfdefault}
|
||||
\hfuzz=15pt
|
||||
\setlength{\emergencystretch}{15pt}
|
||||
\hbadness=750
|
||||
\tolerance=750
|
||||
\begin{document}
|
||||
\hypersetup{pageanchor=false,citecolor=blue}
|
||||
\begin{titlepage}
|
||||
\vspace*{7cm}
|
||||
\begin{center}
|
||||
{\Huge libopencm3: API Reference\\ EFM32 Tiny Gecko ARM Cortex M3 Series}\\
|
||||
\vspace*{1cm}
|
||||
{\large Generated by Doxygen 1.8.2}\\
|
||||
\vspace*{0.5cm}
|
||||
{\small Thu Sep 13 2012 23:26:45}\\
|
||||
\end{center}
|
||||
\end{titlepage}
|
||||
\pagenumbering{arabic}
|
||||
\hypersetup{pageanchor=true,citecolor=blue}
|
||||
|
|
@ -17,7 +17,6 @@ WARN_LOGFILE = doxygen_lm3s_latex.log
|
|||
|
||||
INPUT = ../../include/libopencm3/docmain.dox \
|
||||
../../include/libopencm3/license.dox \
|
||||
../../include/libopencm3/cm3/ \
|
||||
../../include/libopencm3/lm3s \
|
||||
../../lib/lm3s
|
||||
|
||||
|
|
|
|||
|
|
@ -5,14 +5,18 @@
|
|||
<tab type="pages" visible="yes" title="General Information" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../html/index.html" title="Back to Top" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../cm3/html/modules.html" title="CM3 Core" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../stm32/html/modules.html" title="STM32" 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="../../stm32f4/html/modules.html" title="STM32F4" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/>
|
||||
<tab type="modules" visible="yes" title="LM3S" 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="../../emf32g/html/modules.html" title="EMF32 Gecko" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../emf32gg/html/modules.html" title="EMF32 Giant Gecko" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../emf32lg/html/modules.html" title="EMF32 Leopard Gecko" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../emf32tg/html/modules.html" title="EMF32 Tiny Gecko" intro=""/>
|
||||
<tab type="namespaces" visible="yes" title="">
|
||||
<tab type="namespaces" visible="yes" title="" intro=""/>
|
||||
<tab type="namespacemembers" visible="yes" title="" intro=""/>
|
||||
|
|
|
|||
|
|
@ -17,7 +17,6 @@ WARN_LOGFILE = doxygen_lpc13xx_latex.log
|
|||
|
||||
INPUT = ../../include/libopencm3/docmain.dox \
|
||||
../../include/libopencm3/license.dox \
|
||||
../../include/libopencm3/cm3/ \
|
||||
../../include/libopencm3/lpc13xx/ \
|
||||
../../lib/lpc13xx
|
||||
|
||||
|
|
|
|||
|
|
@ -5,14 +5,18 @@
|
|||
<tab type="pages" visible="yes" title="General Information" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../html/index.html" title="Back to Top" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../cm3/html/modules.html" title="CM3 Core" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../stm32/html/modules.html" title="STM32" 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="../../stm32f4/html/modules.html" title="STM32F4" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../lm3s/html/modules.html" title="LM3S" intro=""/>
|
||||
<tab type="modules" visible="yes" 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="../../emf32g/html/modules.html" title="EMF32 Gecko" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../emf32gg/html/modules.html" title="EMF32 Giant Gecko" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../emf32lg/html/modules.html" title="EMF32 Leopard Gecko" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../emf32tg/html/modules.html" title="EMF32 Tiny Gecko" intro=""/>
|
||||
<tab type="namespaces" visible="yes" title="">
|
||||
<tab type="namespaces" visible="yes" title="" intro=""/>
|
||||
<tab type="namespacemembers" visible="yes" title="" intro=""/>
|
||||
|
|
|
|||
|
|
@ -17,7 +17,6 @@ WARN_LOGFILE = doxygen_lpc17xx_latex.log
|
|||
|
||||
INPUT = ../../include/libopencm3/docmain.dox \
|
||||
../../include/libopencm3/license.dox \
|
||||
../../include/libopencm3/cm3/ \
|
||||
../../include/libopencm3/lpc17xx/ \
|
||||
../../lib/lpc17xx
|
||||
|
||||
|
|
|
|||
|
|
@ -5,14 +5,18 @@
|
|||
<tab type="pages" visible="yes" title="General Information" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../html/index.html" title="Back to Top" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../cm3/html/modules.html" title="CM3 Core" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../stm32/html/modules.html" title="STM32" 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="../../stm32f4/html/modules.html" title="STM32F4" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../lm3s/html/modules.html" title="LM3S" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../lpc13xx/html/modules.html" title="LPC13" intro=""/>
|
||||
<tab type="modules" visible="yes" title="LPC17" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../lpc43xx/html/modules.html" title="LPC43" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../emf32g/html/modules.html" title="EMF32 Gecko" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../emf32gg/html/modules.html" title="EMF32 Giant Gecko" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../emf32lg/html/modules.html" title="EMF32 Leopard Gecko" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../emf32tg/html/modules.html" title="EMF32 Tiny Gecko" intro=""/>
|
||||
<tab type="namespaces" visible="yes" title="">
|
||||
<tab type="namespaces" visible="yes" title="" intro=""/>
|
||||
<tab type="namespacemembers" visible="yes" title="" intro=""/>
|
||||
|
|
|
|||
|
|
@ -17,7 +17,6 @@ WARN_LOGFILE = doxygen_lpc43xx_latex.log
|
|||
|
||||
INPUT = ../../include/libopencm3/docmain.dox \
|
||||
../../include/libopencm3/license.dox \
|
||||
../../include/libopencm3/cm3/ \
|
||||
../../include/libopencm3/lpc43xx/ \
|
||||
../../lib/lpc43xx
|
||||
|
||||
|
|
|
|||
|
|
@ -5,14 +5,18 @@
|
|||
<tab type="pages" visible="yes" title="General Information" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../html/index.html" title="Back to Top" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../cm3/html/modules.html" title="CM3 Core" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../stm32/html/modules.html" title="STM32" 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="../../stm32f4/html/modules.html" title="STM32F4" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../lm3s/html/modules.html" title="LM3S" 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="modules" visible="yes" title="LPC43" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../emf32g/html/modules.html" title="EMF32 Gecko" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../emf32gg/html/modules.html" title="EMF32 Giant Gecko" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../emf32lg/html/modules.html" title="EMF32 Leopard Gecko" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../emf32tg/html/modules.html" title="EMF32 Tiny Gecko" intro=""/>
|
||||
<tab type="namespaces" visible="yes" title="">
|
||||
<tab type="namespaces" visible="yes" title="" intro=""/>
|
||||
<tab type="namespacemembers" visible="yes" title="" intro=""/>
|
||||
|
|
|
|||
|
|
@ -1,30 +0,0 @@
|
|||
# HTML Documentation for STM32 code level
|
||||
|
||||
# 14 September 2012
|
||||
# (C) Ken Sarkies <ksarkies@internode.on.net>
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Common Include File
|
||||
#---------------------------------------------------------------------------
|
||||
|
||||
@INCLUDE = ../Doxyfile_common
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Local settings
|
||||
#---------------------------------------------------------------------------
|
||||
|
||||
WARN_LOGFILE = doxygen_stm32.log
|
||||
|
||||
INPUT = ../../include/libopencm3/license.dox \
|
||||
../../include/libopencm3/stm32/ \
|
||||
../../include/libopencm3/stm32/f1/nvic_f1.h \
|
||||
../../include/libopencm3/stm32/f2/nvic_f2.h \
|
||||
../../include/libopencm3/stm32/f4/nvic_f4.h \
|
||||
../../lib/stm32/
|
||||
|
||||
LAYOUT_FILE = DoxygenLayout_stm32.xml
|
||||
|
||||
TAGFILES = ../cm3/cm3.tag=../../cm3/html
|
||||
|
||||
GENERATE_TAGFILE = stm32.tag
|
||||
|
||||
|
|
@ -17,16 +17,19 @@ WARN_LOGFILE = doxygen_stm32f1.log
|
|||
|
||||
INPUT = ../../include/libopencm3/license.dox \
|
||||
../../include/libopencm3/stm32/f1 \
|
||||
../../lib/stm32/f1
|
||||
../../include/libopencm3/stm32/common \
|
||||
../../lib/stm32/f1 \
|
||||
../../lib/stm32/common
|
||||
|
||||
EXCLUDE = ../../include/libopencm3/stm32/f1/usb.h \
|
||||
../../include/libopencm3/stm32/f1/usb_desc.h \
|
||||
../../include/libopencm3/stm32/f1/nvic_f1.h
|
||||
|
||||
EXCLUDE_PATTERNS = *_common_f24.h *_common_f24.c
|
||||
|
||||
LAYOUT_FILE = DoxygenLayout_stm32f1.xml
|
||||
|
||||
TAGFILES = ../cm3/cm3.tag=../../cm3/html \
|
||||
../stm32/stm32.tag=../../stm32/html
|
||||
|
||||
GENERATE_TAGFILE = stm32f1.tag
|
||||
|
||||
|
|
|
|||
|
|
@ -17,16 +17,17 @@ WARN_LOGFILE = doxygen_stm32f1_latex.log
|
|||
|
||||
INPUT = ../../include/libopencm3/docmain.dox \
|
||||
../../include/libopencm3/license.dox \
|
||||
../../include/libopencm3/cm3/ \
|
||||
../../include/libopencm3/stm32/ \
|
||||
../../include/libopencm3/stm32/f1 \
|
||||
../../lib/stm32/ \
|
||||
../../lib/stm32/f1
|
||||
../../include/libopencm3/stm32/common \
|
||||
../../lib/stm32/f1 \
|
||||
../../lib/stm32/common
|
||||
|
||||
EXCLUDE = ../../include/libopencm3/stm32/f1/doc-stm32f1.h \
|
||||
../../include/libopencm3/stm32/doc-stm32f.h \
|
||||
../../include/libopencm3/stm32/f1/usb.h \
|
||||
../../include/libopencm3/stm32/f1/usb_desc.h \
|
||||
../../include/libopencm3/stm32/f1/nvic_f1.h
|
||||
|
||||
EXCLUDE_PATTERNS = *_common_f24.h *_common_f24.c
|
||||
|
||||
LAYOUT_FILE = DoxygenLayout_stm32f1.xml
|
||||
|
||||
|
|
|
|||
|
|
@ -5,14 +5,18 @@
|
|||
<tab type="pages" visible="yes" title="General Information" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../html/index.html" title="Back to Top" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../cm3/html/modules.html" title="CM3 Core" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../stm32/html/modules.html" title="STM32" intro=""/>
|
||||
<tab type="modules" visible="yes" title="STM32F1" intro=""/>
|
||||
<tab type="modules" visible="yes" title="STMF1" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../stm32f2/html/modules.html" title="STM32F2" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../stm32f4/html/modules.html" title="STM32F4" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../lm3s/html/modules.html" title="LM3S" 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="../../emf32g/html/modules.html" title="EMF32 Gecko" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../emf32gg/html/modules.html" title="EMF32 Giant Gecko" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../emf32lg/html/modules.html" title="EMF32 Leopard Gecko" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../emf32tg/html/modules.html" title="EMF32 Tiny Gecko" intro=""/>
|
||||
<tab type="namespaces" visible="yes" title="">
|
||||
<tab type="namespaces" visible="yes" title="" intro=""/>
|
||||
<tab type="namespacemembers" visible="yes" title="" intro=""/>
|
||||
|
|
|
|||
|
|
@ -17,14 +17,15 @@ WARN_LOGFILE = doxygen_stm32f2.log
|
|||
|
||||
INPUT = ../../include/libopencm3/license.dox \
|
||||
../../include/libopencm3/stm32/f2 \
|
||||
../../lib/stm32/f2
|
||||
../../include/libopencm3/stm32/common \
|
||||
../../lib/stm32/f2 \
|
||||
../../lib/stm32/common
|
||||
|
||||
EXCLUDE = ../../include/libopencm3/stm32/f2/nvic_f2.h
|
||||
EXCLUDE =
|
||||
|
||||
LAYOUT_FILE = DoxygenLayout_stm32f2.xml
|
||||
|
||||
TAGFILES = ../cm3/cm3.tag=../../cm3/html \
|
||||
../stm32/stm32.tag=../../stm32/html
|
||||
|
||||
GENERATE_TAGFILE = stm32f2.tag
|
||||
|
||||
|
|
|
|||
|
|
@ -16,15 +16,13 @@
|
|||
WARN_LOGFILE = doxygen_stm32f2_latex.log
|
||||
|
||||
INPUT = ../../include/libopencm3/docmain.dox \
|
||||
../../include/libopencm3/license.dox \
|
||||
../../include/libopencm3/cm3/ \
|
||||
../../include/libopencm3/stm32/ \
|
||||
../../include/libopencm3/license.dox \
|
||||
../../include/libopencm3/stm32/f2 \
|
||||
../../lib/stm32/ \
|
||||
../../lib/stm32/f2
|
||||
../../include/libopencm3/stm32/common \
|
||||
../../lib/stm32/f2 \
|
||||
../../lib/stm32/common
|
||||
|
||||
EXCLUDE = ../../include/libopencm3/stm32/f2/doc-stm32f2.h \
|
||||
../../include/libopencm3/stm32/doc-stm32f.h
|
||||
EXCLUDE = ../../include/libopencm3/stm32/f2/doc-stm32f2.h
|
||||
|
||||
LAYOUT_FILE = DoxygenLayout_stm32f2.xml
|
||||
|
||||
|
|
|
|||
|
|
@ -5,14 +5,18 @@
|
|||
<tab type="pages" visible="yes" title="General Information" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../html/index.html" title="Back to Top" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../cm3/html/modules.html" title="CM3 Core" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../stm32/html/modules.html" title="STM32" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../stm32f1/html/modules.html" title="STM32F1" intro=""/>
|
||||
<tab type="modules" visible="yes" title="STM32F2" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../stm32f4/html/modules.html" title="STM32F4" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../lm3s/html/modules.html" title="LM3S" 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="../../emf32g/html/modules.html" title="EMF32 Gecko" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../emf32gg/html/modules.html" title="EMF32 Giant Gecko" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../emf32lg/html/modules.html" title="EMF32 Leopard Gecko" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../emf32tg/html/modules.html" title="EMF32 Tiny Gecko" intro=""/>
|
||||
<tab type="namespaces" visible="yes" title="">
|
||||
<tab type="namespaces" visible="yes" title="" intro=""/>
|
||||
<tab type="namespacemembers" visible="yes" title="" intro=""/>
|
||||
|
|
|
|||
|
|
@ -17,14 +17,15 @@ WARN_LOGFILE = doxygen_stm32f4.log
|
|||
|
||||
INPUT = ../../include/libopencm3/license.dox \
|
||||
../../include/libopencm3/stm32/f4 \
|
||||
../../lib/stm32/f4
|
||||
../../include/libopencm3/stm32/common \
|
||||
../../lib/stm32/f4 \
|
||||
../../lib/stm32/common
|
||||
|
||||
EXCLUDE = ../../include/libopencm3/stm32/f4/nvic_f4.h
|
||||
EXCLUDE =
|
||||
|
||||
LAYOUT_FILE = DoxygenLayout_stm32f4.xml
|
||||
|
||||
TAGFILES = ../cm3/cm3.tag=../../cm3/html \
|
||||
../stm32/stm32.tag=../../stm32/html
|
||||
|
||||
GENERATE_TAGFILE = stm32f4.tag
|
||||
|
||||
|
|
|
|||
|
|
@ -16,15 +16,13 @@
|
|||
WARN_LOGFILE = doxygen_stm32f4_latex.log
|
||||
|
||||
INPUT = ../../include/libopencm3/docmain.dox \
|
||||
../../include/libopencm3/license.dox \
|
||||
../../include/libopencm3/cm3/ \
|
||||
../../include/libopencm3/stm32/ \
|
||||
../../include/libopencm3/license.dox \
|
||||
../../include/libopencm3/stm32/f4 \
|
||||
../../lib/stm32/ \
|
||||
../../lib/stm32/f4
|
||||
../../include/libopencm3/stm32/common \
|
||||
../../lib/stm32/f4 \
|
||||
../../lib/stm32/common
|
||||
|
||||
EXCLUDE = ../../include/libopencm3/stm32/f4/doc-stm32f4.h \
|
||||
../../include/libopencm3/stm32/doc-stm32f.h
|
||||
EXCLUDE = ../../include/libopencm3/stm32/f4/doc-stm32f4.h
|
||||
|
||||
LAYOUT_FILE = DoxygenLayout_stm32f4.xml
|
||||
|
||||
|
|
|
|||
|
|
@ -5,14 +5,18 @@
|
|||
<tab type="pages" visible="yes" title="General Information" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../html/index.html" title="Back to Top" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../cm3/html/modules.html" title="CM3 Core" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../stm32/html/modules.html" title="STM32" 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="modules" visible="yes" title="STM32F4" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../lm3s/html/modules.html" title="LM3S" 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="../../emf32g/html/modules.html" title="EMF32 Gecko" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../emf32gg/html/modules.html" title="EMF32 Giant Gecko" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../emf32lg/html/modules.html" title="EMF32 Leopard Gecko" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../emf32tg/html/modules.html" title="EMF32 Tiny Gecko" intro=""/>
|
||||
<tab type="namespaces" visible="yes" title="">
|
||||
<tab type="namespaces" visible="yes" title="" intro=""/>
|
||||
<tab type="namespacemembers" visible="yes" title="" intro=""/>
|
||||
|
|
|
|||
|
|
@ -50,7 +50,7 @@
|
|||
\begin{titlepage}
|
||||
\vspace*{7cm}
|
||||
\begin{center}
|
||||
{\Huge libopencm3: API Reference\\ STM STM32F4 ARM Cortex M3 Series}\\
|
||||
{\Huge libopencm3: API Reference\\ STM STM32F4 ARM Cortex M4 Series}\\
|
||||
\vspace*{1cm}
|
||||
{\large Generated by Doxygen 1.8.2}\\
|
||||
\vspace*{0.5cm}
|
||||
|
|
|
|||
|
|
@ -0,0 +1,33 @@
|
|||
# HTML Documentation for STM32F1 code level
|
||||
|
||||
# 14 September 2012
|
||||
# (C) Ken Sarkies <ksarkies@internode.on.net>
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Common Include File
|
||||
#---------------------------------------------------------------------------
|
||||
|
||||
@INCLUDE = ../Doxyfile_common
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Local settings
|
||||
#---------------------------------------------------------------------------
|
||||
|
||||
WARN_LOGFILE = doxygen_stm32l1.log
|
||||
|
||||
INPUT = ../../include/libopencm3/license.dox \
|
||||
../../include/libopencm3/stm32/l1 \
|
||||
../../include/libopencm3/stm32/common \
|
||||
../../lib/stm32/l1 \
|
||||
../../lib/stm32/common
|
||||
|
||||
EXCLUDE =
|
||||
|
||||
EXCLUDE_PATTERNS = *_common_f24.h
|
||||
|
||||
LAYOUT_FILE = DoxygenLayout_stm32l1.xml
|
||||
|
||||
TAGFILES = ../cm3/cm3.tag=../../cm3/html \
|
||||
|
||||
GENERATE_TAGFILE = stm32l1.tag
|
||||
|
||||
|
|
@ -0,0 +1,36 @@
|
|||
# LaTeX Documentation for STM32L1 code level
|
||||
|
||||
# 14 September 2012
|
||||
# (C) Ken Sarkies <ksarkies@internode.on.net>
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Common Include File
|
||||
#---------------------------------------------------------------------------
|
||||
|
||||
@INCLUDE = ../Doxyfile_common
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Local settings
|
||||
#---------------------------------------------------------------------------
|
||||
|
||||
WARN_LOGFILE = doxygen_stm32l1_latex.log
|
||||
|
||||
INPUT = ../../include/libopencm3/docmain.dox \
|
||||
../../include/libopencm3/license.dox \
|
||||
../../include/libopencm3/stm32/l1 \
|
||||
../../include/libopencm3/stm32/common \
|
||||
../../lib/stm32/l1 \
|
||||
../../lib/stm32/common
|
||||
|
||||
EXCLUDE = ../../include/libopencm3/stm32/l1/doc-stm32l1.h
|
||||
|
||||
EXCLUDE_PATTERNS = *_common_f24.h
|
||||
|
||||
LAYOUT_FILE = DoxygenLayout_stm32l1.xml
|
||||
|
||||
GENERATE_HTML = NO
|
||||
|
||||
GENERATE_LATEX = YES
|
||||
|
||||
LATEX_HEADER = header_stm32l1.tex
|
||||
|
||||
|
|
@ -0,0 +1,197 @@
|
|||
<doxygenlayout version="1.0">
|
||||
<!-- Navigation index tabs for HTML output -->
|
||||
<navindex>
|
||||
<tab type="mainpage" visible="yes" title="libopencm3"/>
|
||||
<tab type="pages" visible="yes" title="General Information" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../html/index.html" title="Back to Top" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../cm3/html/modules.html" title="CM3 Core" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../stm32f1/html/modules.html" title="STM32F2" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../stm32f2/html/modules.html" title="STM32F2" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../stm32f4/html/modules.html" title="STM32F4" intro=""/>
|
||||
<tab type="modules" visible="yes" title="STM32L1" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../lm3s/html/modules.html" title="LM3S" 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="../../emf32g/html/modules.html" title="EMF32 Gecko" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../emf32gg/html/modules.html" title="EMF32 Giant Gecko" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../emf32lg/html/modules.html" title="EMF32 Leopard Gecko" intro=""/>
|
||||
<tab type="user" visible="yes" url="../../emf32tg/html/modules.html" title="EMF32 Tiny Gecko" 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>
|
||||
|
|
@ -0,0 +1,61 @@
|
|||
\documentclass{book}
|
||||
\usepackage[a4paper,top=2.5cm,bottom=2.5cm,left=2.5cm,right=2.5cm]{geometry}
|
||||
\usepackage{makeidx}
|
||||
\usepackage{natbib}
|
||||
\usepackage{graphicx}
|
||||
\usepackage{multicol}
|
||||
\usepackage{float}
|
||||
\usepackage{listings}
|
||||
\usepackage{color}
|
||||
\usepackage{ifthen}
|
||||
\usepackage[table]{xcolor}
|
||||
\usepackage{textcomp}
|
||||
\usepackage{alltt}
|
||||
\usepackage{ifpdf}
|
||||
\ifpdf
|
||||
\usepackage[pdftex,
|
||||
pagebackref=true,
|
||||
colorlinks=true,
|
||||
linkcolor=blue,
|
||||
unicode
|
||||
]{hyperref}
|
||||
\else
|
||||
\usepackage[ps2pdf,
|
||||
pagebackref=true,
|
||||
colorlinks=true,
|
||||
linkcolor=blue,
|
||||
unicode
|
||||
]{hyperref}
|
||||
\usepackage{pspicture}
|
||||
\fi
|
||||
\usepackage[utf8]{inputenc}
|
||||
\usepackage{mathptmx}
|
||||
\usepackage[scaled=.90]{helvet}
|
||||
\usepackage{courier}
|
||||
\usepackage{sectsty}
|
||||
\usepackage{amssymb}
|
||||
\usepackage[titles]{tocloft}
|
||||
\usepackage{doxygen}
|
||||
\lstset{language=C++,inputencoding=utf8,basicstyle=\footnotesize,breaklines=true,breakatwhitespace=true,tabsize=4,numbers=left }
|
||||
\makeindex
|
||||
\setcounter{tocdepth}{3}
|
||||
\renewcommand{\footrulewidth}{0.4pt}
|
||||
\renewcommand{\familydefault}{\sfdefault}
|
||||
\hfuzz=15pt
|
||||
\setlength{\emergencystretch}{15pt}
|
||||
\hbadness=750
|
||||
\tolerance=750
|
||||
\begin{document}
|
||||
\hypersetup{pageanchor=false,citecolor=blue}
|
||||
\begin{titlepage}
|
||||
\vspace*{7cm}
|
||||
\begin{center}
|
||||
{\Huge libopencm3: API Reference\\ STM STM32L1 ARM Cortex M3 Series}\\
|
||||
\vspace*{1cm}
|
||||
{\large Generated by Doxygen 1.8.2}\\
|
||||
\vspace*{0.5cm}
|
||||
{\small Thu Sep 13 2012 23:26:45}\\
|
||||
\end{center}
|
||||
\end{titlepage}
|
||||
\pagenumbering{arabic}
|
||||
\hypersetup{pageanchor=true,citecolor=blue}
|
||||
|
|
@ -122,4 +122,6 @@ void nvic_generate_software_interrupt(u16 irqn);
|
|||
|
||||
END_DECLS
|
||||
|
||||
/**@}*/
|
||||
|
||||
#endif
|
||||
|
|
|
|||
|
|
@ -0,0 +1,32 @@
|
|||
/** @mainpage libopencm3 EFM32 Gecko
|
||||
|
||||
@version 1.0.0
|
||||
|
||||
@date 11 November 2012
|
||||
|
||||
API documentation for Energy Micro EFM32 Gecko Cortex M3 series.
|
||||
|
||||
LGPL License Terms @ref lgpl_license
|
||||
*/
|
||||
|
||||
/** @defgroup EFM32G EFM32 Gecko
|
||||
Libraries for Energy Micro EFM32 Gecko series.
|
||||
|
||||
@version 1.0.0
|
||||
|
||||
@date 11 November 2012
|
||||
|
||||
LGPL License Terms @ref lgpl_license
|
||||
*/
|
||||
|
||||
/** @defgroup EFM32G_defines EFM32 Gecko Defines
|
||||
|
||||
@brief Defined Constants and Types for the Energy Micro EFM32 Gecko series
|
||||
|
||||
@version 1.0.0
|
||||
|
||||
@date 11 November 2012
|
||||
|
||||
LGPL License Terms @ref lgpl_license
|
||||
*/
|
||||
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
/** @mainpage libopencm3 EFM32 Giant Gecko
|
||||
|
||||
@version 1.0.0
|
||||
|
||||
@date 11 November 2012
|
||||
|
||||
API documentation for Energy Micro EFM32 Giant Gecko Cortex M3 series.
|
||||
|
||||
LGPL License Terms @ref lgpl_license
|
||||
*/
|
||||
|
||||
/** @defgroup EFM32GG EFM32 Giant Gecko
|
||||
Libraries for Energy Micro EFM32 Giant Gecko series.
|
||||
|
||||
@version 1.0.0
|
||||
|
||||
@date 11 November 2012
|
||||
|
||||
LGPL License Terms @ref lgpl_license
|
||||
*/
|
||||
|
||||
/** @defgroup EFM32GG_defines EFM32 Giant Gecko Defines
|
||||
|
||||
@brief Defined Constants and Types for the Energy Micro EFM32 Giant Gecko series
|
||||
|
||||
@version 1.0.0
|
||||
|
||||
@date 11 November 2012
|
||||
|
||||
LGPL License Terms @ref lgpl_license
|
||||
*/
|
||||
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
/** @mainpage libopencm3 STM32L1
|
||||
|
||||
@version 1.0.0
|
||||
|
||||
@date 12 November 2012
|
||||
|
||||
API documentation for ST Microelectronics STM32L1 Cortex M3 series.
|
||||
|
||||
LGPL License Terms @ref lgpl_license
|
||||
*/
|
||||
|
||||
/** @defgroup STM32L1xx STM32L1xx
|
||||
Libraries for ST Microelectronics STM32L1xx series.
|
||||
|
||||
@version 1.0.0
|
||||
|
||||
@date 12 November 2012
|
||||
|
||||
LGPL License Terms @ref lgpl_license
|
||||
*/
|
||||
|
||||
/** @defgroup STM32L1xx_defines STM32L1xx Defines
|
||||
|
||||
@brief Defined Constants and Types for the STM32L1xx series
|
||||
|
||||
@version 1.0.0
|
||||
|
||||
@date 12 November 2012
|
||||
|
||||
LGPL License Terms @ref lgpl_license
|
||||
*/
|
||||
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
/** @file
|
||||
/** @defgroup STM32L1xx_rcc_defines RCC Defines
|
||||
|
||||
@ingroup STM32L1xx
|
||||
@ingroup STM32L1xx_defines
|
||||
|
||||
@brief <b>libopencm3 STM32L1xx Reset and Clock Control</b>
|
||||
|
||||
|
|
@ -10,19 +10,11 @@
|
|||
@author @htmlonly © @endhtmlonly 2009 Uwe Hermann <uwe@hermann-uwe.de>
|
||||
@author @htmlonly © @endhtmlonly 2012 Karl Palsson <karlp@tweak.net.au>
|
||||
|
||||
@date 18 May 2012
|
||||
@date 11 November 2012
|
||||
|
||||
LGPL License Terms @ref lgpl_license
|
||||
*/
|
||||
/** @defgroup STM32L1xx_rcc_defines
|
||||
|
||||
@brief Defined Constants and Types for the STM32L1xx Reset and Clock Control
|
||||
|
||||
@ingroup STM32L1xx_defines
|
||||
|
||||
LGPL License Terms @ref lgpl_license
|
||||
|
||||
*/
|
||||
/*
|
||||
* This file is part of the libopencm3 project.
|
||||
*
|
||||
|
|
@ -47,6 +39,8 @@ LGPL License Terms @ref lgpl_license
|
|||
* TODO: very incomplete still!
|
||||
*/
|
||||
|
||||
/**@{*/
|
||||
|
||||
#ifndef LIBOPENCM3_RCC_H
|
||||
#define LIBOPENCM3_RCC_H
|
||||
|
||||
|
|
@ -405,4 +399,6 @@ void rcc_clock_setup_in_hse_12mhz_out_72mhz(void);
|
|||
void rcc_clock_setup_in_hse_16mhz_out_72mhz(void);
|
||||
void rcc_backupdomain_reset(void);
|
||||
|
||||
/**@}*/
|
||||
|
||||
#endif
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
/** @defgroup STM32F1xx_pwr_defines PWR Defines
|
||||
/** @defgroup STM32F_pwr_defines PWR Defines
|
||||
|
||||
@ingroup STM32F_defines
|
||||
|
||||
|
|
|
|||
|
|
@ -80,7 +80,7 @@ The interrupt flag for the channel is cleared. More than one interrupt for the
|
|||
same channel may be cleared by using the logical OR of the interrupt flags.
|
||||
|
||||
@param[in] dma unsigned int32. DMA controller base address: DMA1 or DMA2
|
||||
@param[in] channel unsigned int8. Channel number: @ref dma_st_number
|
||||
@param[in] channel unsigned int8. Channel number: @ref dma_ch
|
||||
@param[in] interrupts unsigned int32. Logical OR of interrupt numbers: @ref dma_if_offset
|
||||
*/
|
||||
|
||||
|
|
@ -97,8 +97,8 @@ void dma_clear_interrupt_flags(u32 dma, u8 channel, u32 interrupts)
|
|||
The interrupt flag for the channel is returned.
|
||||
|
||||
@param[in] dma unsigned int32. DMA controller base address: DMA1 or DMA2
|
||||
@param[in] channel unsigned int8. Channel number: @ref dma_st_number
|
||||
@param[in] interrupt unsigned int32. Interrupt number: @ref dma_st_number
|
||||
@param[in] channel unsigned int8. Channel number: @ref dma_ch
|
||||
@param[in] interrupt unsigned int32. Interrupt number: @ref dma_ch
|
||||
@returns bool interrupt flag is set.
|
||||
*/
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue