libopencm3

History

Frantisek Burian 9fce73a014 [Doxygen] Strip out architectures from Makefile dependencies This commit shrinks the Makefile of the doxygen and makes easy error-prone addition of the new supported platforms. The user should modify only one line at start of file to add new supported family to the build process. The calling format is preserved and is compatible with old version of the makefile.		2014-10-15 19:50:08 +02:00
..
cm3	[stm32l0] Integrate the L0 architecture to the doxygen documentation	2014-10-15 19:33:20 +02:00
efm32g	[stm32l0] Integrate the L0 architecture to the doxygen documentation	2014-10-15 19:33:20 +02:00
efm32gg	[stm32l0] Integrate the L0 architecture to the doxygen documentation	2014-10-15 19:33:20 +02:00
efm32lg	[stm32l0] Integrate the L0 architecture to the doxygen documentation	2014-10-15 19:33:20 +02:00
efm32tg	[stm32l0] Integrate the L0 architecture to the doxygen documentation	2014-10-15 19:33:20 +02:00
lm3s	[stm32l0] Integrate the L0 architecture to the doxygen documentation	2014-10-15 19:33:20 +02:00
lm4f	[stm32l0] Integrate the L0 architecture to the doxygen documentation	2014-10-15 19:33:20 +02:00
lpc13xx	[stm32l0] Integrate the L0 architecture to the doxygen documentation	2014-10-15 19:33:20 +02:00
lpc17xx	[stm32l0] Integrate the L0 architecture to the doxygen documentation	2014-10-15 19:33:20 +02:00
lpc43xx	[stm32l0] Integrate the L0 architecture to the doxygen documentation	2014-10-15 19:33:20 +02:00
sam3a	[stm32l0] Integrate the L0 architecture to the doxygen documentation	2014-10-15 19:33:20 +02:00
sam3n	[stm32l0] Integrate the L0 architecture to the doxygen documentation	2014-10-15 19:33:20 +02:00
sam3s	[stm32l0] Integrate the L0 architecture to the doxygen documentation	2014-10-15 19:33:20 +02:00
sam3u	[stm32l0] Integrate the L0 architecture to the doxygen documentation	2014-10-15 19:33:20 +02:00
sam3x	[stm32l0] Integrate the L0 architecture to the doxygen documentation	2014-10-15 19:33:20 +02:00
stm32f0	[stm32l0] Integrate the L0 architecture to the doxygen documentation	2014-10-15 19:33:20 +02:00
stm32f1	[stm32l0] Integrate the L0 architecture to the doxygen documentation	2014-10-15 19:33:20 +02:00
stm32f2	[stm32l0] Integrate the L0 architecture to the doxygen documentation	2014-10-15 19:33:20 +02:00
stm32f3	[stm32l0] Integrate the L0 architecture to the doxygen documentation	2014-10-15 19:33:20 +02:00
stm32f4	[stm32l0] Integrate the L0 architecture to the doxygen documentation	2014-10-15 19:33:20 +02:00
stm32l0	[stm32l0] Integrate the L0 architecture to the doxygen documentation	2014-10-15 19:33:20 +02:00
stm32l1	[stm32l0] Integrate the L0 architecture to the doxygen documentation	2014-10-15 19:33:20 +02:00
usb	[stm32l0] Integrate the L0 architecture to the doxygen documentation	2014-10-15 19:33:20 +02:00
vf6xx	vf6xx: doc: initial commit	2014-10-15 19:31:02 +02:00
Doxyfile	Fix a number of top level doxygen issues.	2014-01-15 22:19:52 +01:00
Doxyfile_common	Strip the BEGIN_DECLS definition from the first function in a module documentation.	2013-07-07 16:12:03 -07:00
DoxygenLayout.xml	[stm32l0] Integrate the L0 architecture to the doxygen documentation	2014-10-15 19:33:20 +02:00
HACKING	Fix a number of top level doxygen issues.	2014-01-15 22:19:52 +01:00
Makefile	[Doxygen] Strip out architectures from Makefile dependencies	2014-10-15 19:50:08 +02:00
README	docs: note dependencies for PDF generation	2014-02-12 15:21:09 +00:00
index.html	[DOXYGEN] Add links to the HTML pages for easy debugging of pages	2013-08-24 14:20:13 +02:00

README

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