mcu
/
libopencm3
mirror of https://github.com/libopencm3/libopencm3.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1505 Commits
2 Branches
1 Tag
21 MiB
 
 
 
 
 
Tree: 641fbffe9a
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '641fbffe9a'
${ noResults }
libopencm3/doc
Karl Palsson eb44e7c617
docs: note dependencies for PDF generation 		11 years ago
..
cm3 Fix a number of top level doxygen issues. 11 years ago
efm32g Fix a number of top level doxygen issues. 11 years ago
efm32gg Fix a number of top level doxygen issues. 11 years ago
efm32lg Fix a number of top level doxygen issues. 11 years ago
efm32tg Fix a number of top level doxygen issues. 11 years ago
lm3s Fix a number of top level doxygen issues. 11 years ago
lm4f Fix a number of top level doxygen issues. 11 years ago
lpc13xx Fix a number of top level doxygen issues. 11 years ago
lpc17xx Fix a number of top level doxygen issues. 11 years ago
lpc43xx Fix a number of top level doxygen issues. 11 years ago
stm32f0 Fix a number of top level doxygen issues. 11 years ago
stm32f1 Fix a number of top level doxygen issues. 11 years ago
stm32f2 Deduplication of flash code for STM32F0 and F1. 11 years ago
stm32f3 Deduplication of flash code for STM32F0 and F1. 11 years ago
stm32f4 Deduplication of flash code for STM32F0 and F1. 11 years ago
stm32l1 Fix a number of top level doxygen issues. 11 years ago
usb Fix a number of top level doxygen issues. 11 years ago
Doxyfile Fix a number of top level doxygen issues. 11 years ago
Doxyfile_common Strip the BEGIN_DECLS definition from the first function in a module documentation. 12 years ago
DoxygenLayout.xml [DOXYGEN] EFM32 link typo bugfix 11 years ago
HACKING Fix a number of top level doxygen issues. 11 years ago
Makefile [DOXYGEN] Correct generating docs for STM32F0 and STM32F3 11 years ago
README docs: note dependencies for PDF generation 11 years ago
index.html [DOXYGEN] Add links to the HTML pages for easy debugging of pages 11 years ago

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