sksp2024-mcu/libopencm3/doc
2024-09-14 21:50:22 +02:00
..
efm32ezr32wg Imported libopencm3 2024-09-14 21:50:22 +02:00
efm32g Imported libopencm3 2024-09-14 21:50:22 +02:00
efm32gg Imported libopencm3 2024-09-14 21:50:22 +02:00
efm32hg Imported libopencm3 2024-09-14 21:50:22 +02:00
efm32lg Imported libopencm3 2024-09-14 21:50:22 +02:00
efm32tg Imported libopencm3 2024-09-14 21:50:22 +02:00
efm32wg Imported libopencm3 2024-09-14 21:50:22 +02:00
gd32f1x0 Imported libopencm3 2024-09-14 21:50:22 +02:00
lm3s Imported libopencm3 2024-09-14 21:50:22 +02:00
lm4f Imported libopencm3 2024-09-14 21:50:22 +02:00
lpc13xx Imported libopencm3 2024-09-14 21:50:22 +02:00
lpc17xx Imported libopencm3 2024-09-14 21:50:22 +02:00
lpc43xx Imported libopencm3 2024-09-14 21:50:22 +02:00
lpc43xxm0 Imported libopencm3 2024-09-14 21:50:22 +02:00
lpc43xxm4 Imported libopencm3 2024-09-14 21:50:22 +02:00
msp432e4 Imported libopencm3 2024-09-14 21:50:22 +02:00
nrf51 Imported libopencm3 2024-09-14 21:50:22 +02:00
nrf52 Imported libopencm3 2024-09-14 21:50:22 +02:00
pac55xx Imported libopencm3 2024-09-14 21:50:22 +02:00
sam3a Imported libopencm3 2024-09-14 21:50:22 +02:00
sam3n Imported libopencm3 2024-09-14 21:50:22 +02:00
sam3s Imported libopencm3 2024-09-14 21:50:22 +02:00
sam3u Imported libopencm3 2024-09-14 21:50:22 +02:00
sam3x Imported libopencm3 2024-09-14 21:50:22 +02:00
sam4l Imported libopencm3 2024-09-14 21:50:22 +02:00
samd Imported libopencm3 2024-09-14 21:50:22 +02:00
stm32f0 Imported libopencm3 2024-09-14 21:50:22 +02:00
stm32f1 Imported libopencm3 2024-09-14 21:50:22 +02:00
stm32f2 Imported libopencm3 2024-09-14 21:50:22 +02:00
stm32f3 Imported libopencm3 2024-09-14 21:50:22 +02:00
stm32f4 Imported libopencm3 2024-09-14 21:50:22 +02:00
stm32f7 Imported libopencm3 2024-09-14 21:50:22 +02:00
stm32g0 Imported libopencm3 2024-09-14 21:50:22 +02:00
stm32g4 Imported libopencm3 2024-09-14 21:50:22 +02:00
stm32h7 Imported libopencm3 2024-09-14 21:50:22 +02:00
stm32l0 Imported libopencm3 2024-09-14 21:50:22 +02:00
stm32l1 Imported libopencm3 2024-09-14 21:50:22 +02:00
stm32l4 Imported libopencm3 2024-09-14 21:50:22 +02:00
swm050 Imported libopencm3 2024-09-14 21:50:22 +02:00
templates Imported libopencm3 2024-09-14 21:50:22 +02:00
vf6xx Imported libopencm3 2024-09-14 21:50:22 +02:00
Doxyfile Imported libopencm3 2024-09-14 21:50:22 +02:00
Doxyfile_common Imported libopencm3 2024-09-14 21:50:22 +02:00
HACKING Imported libopencm3 2024-09-14 21:50:22 +02:00
index.html Imported libopencm3 2024-09-14 21:50:22 +02:00
Makefile Imported libopencm3 2024-09-14 21:50:22 +02:00
README Imported libopencm3 2024-09-14 21:50:22 +02:00

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