aboutsummaryrefslogtreecommitdiff
path: root/include/libopencm3/stm32/doc-stm32f.h
diff options
context:
space:
mode:
authorKen Sarkies2012-09-15 12:51:46 +0930
committerKen Sarkies2012-09-15 12:51:46 +0930
commitff83a1ae1c0764aff11d8cd50f1f0f8a27ea4757 (patch)
tree030d15b829c2c76f1b97891a92cfc697d73aed3b /include/libopencm3/stm32/doc-stm32f.h
parentdcd98dde86c68340e950d12b078d24fd30bef625 (diff)
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.
Diffstat (limited to 'include/libopencm3/stm32/doc-stm32f.h')
-rw-r--r--include/libopencm3/stm32/doc-stm32f.h23
1 files changed, 14 insertions, 9 deletions
diff --git a/include/libopencm3/stm32/doc-stm32f.h b/include/libopencm3/stm32/doc-stm32f.h
index b0532de..7b0a1a3 100644
--- a/include/libopencm3/stm32/doc-stm32f.h
+++ b/include/libopencm3/stm32/doc-stm32f.h
@@ -1,24 +1,29 @@
-/** @defgroup STM32F_defines STM32F Top Level Defines
+/** @mainpage libopencm3 STM32 Common
-@brief Defined Constants and Types for the STM32F series
+@version 1.0.0
-@ingroup STM32F
+@date 7 September 2012
-@author @htmlonly © @endhtmlonly 2012 Ken Sarkies ksarkies@internode.on.net
+API documentation for common files for ST Microelectronics STM32 Cortex M3 series.
-@version 1.0.0
+LGPL License Terms @ref lgpl_license
+*/
-@date 18 August 2012
+/** @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 Top Level Files
+/** @defgroup STM32F_files STM32F Common Files
@brief Common Files for ST Microelectronics STM32F series.
-@ingroup STM32F
+@version 1.0.0
-*/
+@date 7 September 2012
+LGPL License Terms @ref lgpl_license
+*/