libopencm3

History

Ken Sarkies e2022f5884 Repair to documentation (most documented files) to remove errors, duplications and inconsistencies. File lib/stm32/f1/pwr.c - all code removed as it duplicates that in common/pwr_common.c Remaining changes do not affect code. Compiles OK. TODO efm32 has no code so generates no modules TODO F2 needs pwr.c TODO L1 needs dma.h and dma.c		2013-03-07 11:14:06 +10:30
..
cm3	Repair to documentation (most documented files)	2013-03-07 11:14:06 +10:30
efm32g	doc: Include LM4F files when creating documentation	2013-01-01 17:52:43 -06:00
efm32gg	doc: Include LM4F files when creating documentation	2013-01-01 17:52:43 -06:00
efm32lg	doc: Include LM4F files when creating documentation	2013-01-01 17:52:43 -06:00
efm32tg	doc: Include LM4F files when creating documentation	2013-01-01 17:52:43 -06:00
lm3s	doc: Include LM4F files when creating documentation	2013-01-01 17:52:43 -06:00
lm4f	doc: Include LM4F files when creating documentation	2013-01-01 17:52:43 -06:00
lpc13xx	doc: Include LM4F files when creating documentation	2013-01-01 17:52:43 -06:00
lpc17xx	doc: Include LM4F files when creating documentation	2013-01-01 17:52:43 -06:00
lpc43xx	doc: Include LM4F files when creating documentation	2013-01-01 17:52:43 -06:00
stm32f1	Merging pull request #72 Doc	2013-01-09 01:05:37 -08:00
stm32f2	Repair to documentation (most documented files)	2013-03-07 11:14:06 +10:30
stm32f4	Repair to documentation (most documented files)	2013-03-07 11:14:06 +10:30
stm32l1	Repair to documentation (most documented files)	2013-03-07 11:14:06 +10: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	Repair to documentation (most documented files)	2013-03-07 11:14:06 +10:30
HACKING	Repair to documentation (most documented files)	2013-03-07 11:14:06 +10:30
Makefile	doc: Include LM4F files when creating documentation	2013-01-01 17:52:43 -06: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.