libopencm3

Files

T

Ken Sarkies 0af6d06eda Deduplication of flash code for STM32F0 and F1.

Extension of code for STM32F1 to allow for dual bank series XL.
Small changes to documentation for F2, F4 and L1 to add a parameter reference.

Tested with STM32F103RBT6
(note: tests show that the PG bit must be cleared after programming, otherwise
a subsequent erase attempt fails. This has been added to flash_program_half_word
for F0 and F1 only. A fix for the other families is not included in this PR.)

2014-02-06 00:52:42 +01:00

cm3

Fix a number of top level doxygen issues.

2014-01-15 22:19:52 +01:00

efm32g

Fix a number of top level doxygen issues.

2014-01-15 22:19:52 +01:00

efm32gg

Fix a number of top level doxygen issues.

2014-01-15 22:19:52 +01:00

efm32lg

Fix a number of top level doxygen issues.

2014-01-15 22:19:52 +01:00

efm32tg

Fix a number of top level doxygen issues.

2014-01-15 22:19:52 +01:00

lm3s

Fix a number of top level doxygen issues.

2014-01-15 22:19:52 +01:00

lm4f

Fix a number of top level doxygen issues.

2014-01-15 22:19:52 +01:00

lpc13xx

Fix a number of top level doxygen issues.

2014-01-15 22:19:52 +01:00

lpc17xx

Fix a number of top level doxygen issues.

2014-01-15 22:19:52 +01:00

lpc43xx

Fix a number of top level doxygen issues.

2014-01-15 22:19:52 +01:00

stm32f0

Fix a number of top level doxygen issues.

2014-01-15 22:19:52 +01:00

stm32f1

Fix a number of top level doxygen issues.

2014-01-15 22:19:52 +01:00

stm32f2

Deduplication of flash code for STM32F0 and F1.

2014-02-06 00:52:42 +01:00

stm32f3

Deduplication of flash code for STM32F0 and F1.

2014-02-06 00:52:42 +01:00

stm32f4

Deduplication of flash code for STM32F0 and F1.

2014-02-06 00:52:42 +01:00

stm32l1

Fix a number of top level doxygen issues.

2014-01-15 22:19:52 +01:00

usb

Fix a number of top level doxygen issues.

2014-01-15 22:19:52 +01:00

Doxyfile

Fix a number of top level doxygen issues.

2014-01-15 22:19:52 +01:00

Doxyfile_common

Strip the BEGIN_DECLS definition from the first function in a module documentation.

2013-07-07 16:12:03 -07:00

DoxygenLayout.xml

[DOXYGEN] EFM32 link typo bugfix

2013-08-24 16:43:03 +02:00

HACKING

Fix a number of top level doxygen issues.

2014-01-15 22:19:52 +01:00

index.html

[DOXYGEN] Add links to the HTML pages for easy debugging of pages

2013-08-24 14:20:13 +02:00

Makefile

[DOXYGEN] Correct generating docs for STM32F0 and STM32F3

2013-08-24 14:20:13 +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.