Ken Sarkies ff83a1ae1c Setup to document entire project using doxygen.
New doc directory with config files and generated html, LaTeX/pdf.
Makefile provided for autogeneration and explanatory README.

The project structure is hostile to doxygen, which can't cope with functions
of the same name. Doxygen is run for each family separately, and separately
for LaTeX generation. Customized layout files sort of "integrate" HTML, and
separate pdfs are generated for each family. Not ideal but seems the best
solution until doxygen changes, if at all.
2012-09-15 12:51:46 +09:30

30 lines
545 B
C

/** @mainpage libopencm3 STM32 Common
@version 1.0.0
@date 7 September 2012
API documentation for common files for ST Microelectronics STM32 Cortex M3 series.
LGPL License Terms @ref lgpl_license
*/
/** @defgroup STM32F_defines STM32F Common Defines
@brief Defined Constants and Types for the STM32F series
LGPL License Terms @ref lgpl_license
*/
/** @defgroup STM32F_files STM32F Common Files
@brief Common Files for ST Microelectronics STM32F series.
@version 1.0.0
@date 7 September 2012
LGPL License Terms @ref lgpl_license
*/