d002d9552f
Instead of the fragile and error prone attempts to specifically include/exclude files from doxygen by name and pattern, simply use the already generated .d files to provide accurate and up to date lists of all source files used. Pros: * Nothing left to worry about * Much more encouraging to actually _work_ on the documentation now that you can be sure the right docs will be generated instead of a confusing mix. Downsides/Upsides: * Automatically includes all CM3/USB in each device's page _as well_ now Downsides: * lpc43xx still manually listed. However, completely contained in it's own dir, so no problems * No attempt to carry this in latex. easy, but more tempted to drop latex support outright. (I don't think the generation there has even worked for a while now) * Due to the mismatch between lib directories and document roots, the sourcelist can't be magically created per directory. There has to be some sort of mapping between the two, so as this is doc generation only, a static list seems sane for maintennance. (Especially compared to the old method) * Source list generation probably doesn't work on windows.
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.
Requirements
------------
On Fedora 19, the following packages (at least!) are needed to build the pdf
output
texlive texlive-sectsty texlive-tocloft texlive-xtab texlive-multirow