libopencm3

History

Ken Sarkies 84fe022609 Add usb to main index		2013-04-19 10:26:01 +09:30
..
cm3	Repair to documentation (most documented files)	2013-03-07 11:14:06 +10:30
efm32g	Documentation structures added to place the non-STM32 families into the documentation tree.	2013-04-14 15:30:02 +02:00
efm32gg	Documentation structures added to place the non-STM32 families into the documentation tree.	2013-04-14 15:30:02 +02:00
efm32lg	Documentation structures added to place the non-STM32 families into the documentation tree.	2013-04-14 15:30:02 +02:00
efm32tg	Documentation structures added to place the non-STM32 families into the documentation tree.	2013-04-14 15:30:02 +02:00
lm3s	Documentation structures added to place the non-STM32 families into the documentation tree.	2013-04-14 15:30:02 +02:00
lm4f	Documentation structures added to place the non-STM32 families into the documentation tree.	2013-04-14 15:30:02 +02:00
lpc13xx	Documentation structures added to place the non-STM32 families into the documentation tree.	2013-04-14 15:30:02 +02:00
lpc17xx	Documentation structures added to place the non-STM32 families into the documentation tree.	2013-04-14 15:30:02 +02:00
lpc43xx	Documentation structures added to place the non-STM32 families into the documentation tree.	2013-04-14 15:30:02 +02:00
stm32f1	Documentation structures added to place the non-STM32 families into the documentation tree.	2013-04-14 15:30:02 +02:00
stm32f2	Documentation structures added to place the non-STM32 families into the documentation tree.	2013-04-14 15:30:02 +02:00
stm32f4	Documentation structures added to place the non-STM32 families into the documentation tree.	2013-04-14 15:30:02 +02:00
stm32l1	Documentation structures added to place the non-STM32 families into the documentation tree.	2013-04-14 15:30:02 +02:00
usb	Place generic USB header and source files into the documentation tree.	2013-04-19 10:26:01 +09:30
Doxyfile	doc: Include LM4F files when creating documentation	2013-01-01 17:52:43 -06:00
Doxyfile_common	Documentation updates	2012-11-12 21:44:52 +10:30
DoxygenLayout.xml	Add usb to main index	2013-04-19 10:26:01 +09:30
HACKING	Repair to documentation (most documented files)	2013-03-07 11:14:06 +10:30
Makefile	Documentation structures added to place the non-STM32 families into the documentation tree.	2013-04-14 15:30:02 +02:00
README	Documentation updates	2012-11-12 21:44:52 +10:30

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.