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.
1222 Commits
2 Branches
1 Tag
21 MiB
 
 
 
 
 
Tree: fb5c86db07
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'fb5c86db07'
${ noResults }
libopencm3/doc
Ken Sarkies f5c9bdfe61
Changes to doxygen markup to solve a few problems that upset 		12 years ago
..
cm3 Repair to documentation (most documented files) 12 years ago
efm32g Documentation structures added to place the non-STM32 families into the documentation tree. 12 years ago
efm32gg Documentation structures added to place the non-STM32 families into the documentation tree. 12 years ago
efm32lg Documentation structures added to place the non-STM32 families into the documentation tree. 12 years ago
efm32tg Documentation structures added to place the non-STM32 families into the documentation tree. 12 years ago
lm3s Documentation structures added to place the non-STM32 families into the documentation tree. 12 years ago
lm4f Documentation structures added to place the non-STM32 families into the documentation tree. 12 years ago
lpc13xx Documentation structures added to place the non-STM32 families into the documentation tree. 12 years ago
lpc17xx Documentation structures added to place the non-STM32 families into the documentation tree. 12 years ago
lpc43xx Documentation structures added to place the non-STM32 families into the documentation tree. 12 years ago
stm32f1 Changes to doxygen markup to solve a few problems that upset 12 years ago
stm32f2 Changes to doxygen markup to solve a few problems that upset 12 years ago
stm32f4 Changes to doxygen markup to solve a few problems that upset 12 years ago
stm32l1 Changes to doxygen markup to solve a few problems that upset 12 years ago
usb Place generic USB header and source files into the documentation tree. 12 years ago
Doxyfile doc: Include LM4F files when creating documentation 12 years ago
Doxyfile_common Documentation updates 12 years ago
DoxygenLayout.xml Add usb to main index 12 years ago
HACKING Changes to doxygen markup to solve a few problems that upset 12 years ago
Makefile Documentation structures added to place the non-STM32 families into the documentation tree. 12 years ago
README Documentation updates 12 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.