HackRF-Treasure-Chest/Software/portapack-mayhem/hackrf/firmware/libopencm3/doc
2022-09-22 09:26:57 -07:00
..
cm3 Add software 2022-09-22 09:26:57 -07:00
efm32g Add software 2022-09-22 09:26:57 -07:00
efm32gg Add software 2022-09-22 09:26:57 -07:00
efm32lg Add software 2022-09-22 09:26:57 -07:00
efm32tg Add software 2022-09-22 09:26:57 -07:00
lm3s Add software 2022-09-22 09:26:57 -07:00
lm4f Add software 2022-09-22 09:26:57 -07:00
lpc13xx Add software 2022-09-22 09:26:57 -07:00
lpc17xx Add software 2022-09-22 09:26:57 -07:00
lpc43xx Add software 2022-09-22 09:26:57 -07:00
stm32f0 Add software 2022-09-22 09:26:57 -07:00
stm32f1 Add software 2022-09-22 09:26:57 -07:00
stm32f2 Add software 2022-09-22 09:26:57 -07:00
stm32f3 Add software 2022-09-22 09:26:57 -07:00
stm32f4 Add software 2022-09-22 09:26:57 -07:00
stm32l1 Add software 2022-09-22 09:26:57 -07:00
usb Add software 2022-09-22 09:26:57 -07:00
Doxyfile Add software 2022-09-22 09:26:57 -07:00
Doxyfile_common Add software 2022-09-22 09:26:57 -07:00
DoxygenLayout.xml Add software 2022-09-22 09:26:57 -07:00
HACKING Add software 2022-09-22 09:26:57 -07:00
index.html Add software 2022-09-22 09:26:57 -07:00
Makefile Add software 2022-09-22 09:26:57 -07:00
README Add software 2022-09-22 09:26:57 -07: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.