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.
This commit is contained in:
@@ -1,15 +1,32 @@
|
||||
/** @mainpage libopencm3 STM32F1
|
||||
|
||||
@version 1.0.0
|
||||
|
||||
@date 7 September 2012
|
||||
|
||||
API documentation for ST Microelectronics STM32F1 Cortex M3 series.
|
||||
|
||||
LGPL License Terms @ref lgpl_license
|
||||
*/
|
||||
|
||||
/** @defgroup STM32F1xx STM32F1xx
|
||||
Libraries for ST Microelectronics STM32F1xx series.
|
||||
|
||||
@version 1.0.0
|
||||
|
||||
@date 7 September 2012
|
||||
|
||||
LGPL License Terms @ref lgpl_license
|
||||
*/
|
||||
|
||||
/** @defgroup STM32F1xx_defines STM32F1xx Defines
|
||||
|
||||
@brief Defined Constants and Types for the STM32F1xx series
|
||||
|
||||
@ingroup STM32F1xx
|
||||
|
||||
@author @htmlonly © @endhtmlonly 2012 Ken Sarkies ksarkies@internode.on.net
|
||||
|
||||
@version 1.0.0
|
||||
|
||||
@date 18 August 2012
|
||||
@date 7 September 2012
|
||||
|
||||
LGPL License Terms @ref lgpl_license
|
||||
*/
|
||||
*/
|
||||
|
||||
|
||||
Reference in New Issue
Block a user