aboutsummaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorKen Sarkies2012-11-12 21:44:52 +1030
committerKen Sarkies2012-11-12 21:44:52 +1030
commit35c0863a75c41f900514bb4dfbc654544723577a (patch)
treecbc247e10d50ab6a522d413a191b8cec760ae0c6 /include
parent971a295d436893ce731dd7e7e931fff34d748031 (diff)
Documentation updates
Diffstat (limited to 'include')
-rw-r--r--include/libopencm3/cm3/nvic.h2
-rw-r--r--include/libopencm3/efm32/efm32g/doc-efm32g.h32
-rw-r--r--include/libopencm3/efm32/efm32gg/doc-efm32gg.h32
-rw-r--r--include/libopencm3/stm32/l1/doc-stm32l1.h32
-rw-r--r--include/libopencm3/stm32/l1/rcc.h18
-rw-r--r--include/libopencm3/stm32/pwr.h2
6 files changed, 106 insertions, 12 deletions
diff --git a/include/libopencm3/cm3/nvic.h b/include/libopencm3/cm3/nvic.h
index 3f83285..b8c6535 100644
--- a/include/libopencm3/cm3/nvic.h
+++ b/include/libopencm3/cm3/nvic.h
@@ -122,4 +122,6 @@ void nvic_generate_software_interrupt(u16 irqn);
END_DECLS
+/**@}*/
+
#endif
diff --git a/include/libopencm3/efm32/efm32g/doc-efm32g.h b/include/libopencm3/efm32/efm32g/doc-efm32g.h
new file mode 100644
index 0000000..747cb51
--- /dev/null
+++ b/include/libopencm3/efm32/efm32g/doc-efm32g.h
@@ -0,0 +1,32 @@
+/** @mainpage libopencm3 EFM32 Gecko
+
+@version 1.0.0
+
+@date 11 November 2012
+
+API documentation for Energy Micro EFM32 Gecko Cortex M3 series.
+
+LGPL License Terms @ref lgpl_license
+*/
+
+/** @defgroup EFM32G EFM32 Gecko
+Libraries for Energy Micro EFM32 Gecko series.
+
+@version 1.0.0
+
+@date 11 November 2012
+
+LGPL License Terms @ref lgpl_license
+*/
+
+/** @defgroup EFM32G_defines EFM32 Gecko Defines
+
+@brief Defined Constants and Types for the Energy Micro EFM32 Gecko series
+
+@version 1.0.0
+
+@date 11 November 2012
+
+LGPL License Terms @ref lgpl_license
+*/
+
diff --git a/include/libopencm3/efm32/efm32gg/doc-efm32gg.h b/include/libopencm3/efm32/efm32gg/doc-efm32gg.h
new file mode 100644
index 0000000..aacb17b
--- /dev/null
+++ b/include/libopencm3/efm32/efm32gg/doc-efm32gg.h
@@ -0,0 +1,32 @@
+/** @mainpage libopencm3 EFM32 Giant Gecko
+
+@version 1.0.0
+
+@date 11 November 2012
+
+API documentation for Energy Micro EFM32 Giant Gecko Cortex M3 series.
+
+LGPL License Terms @ref lgpl_license
+*/
+
+/** @defgroup EFM32GG EFM32 Giant Gecko
+Libraries for Energy Micro EFM32 Giant Gecko series.
+
+@version 1.0.0
+
+@date 11 November 2012
+
+LGPL License Terms @ref lgpl_license
+*/
+
+/** @defgroup EFM32GG_defines EFM32 Giant Gecko Defines
+
+@brief Defined Constants and Types for the Energy Micro EFM32 Giant Gecko series
+
+@version 1.0.0
+
+@date 11 November 2012
+
+LGPL License Terms @ref lgpl_license
+*/
+
diff --git a/include/libopencm3/stm32/l1/doc-stm32l1.h b/include/libopencm3/stm32/l1/doc-stm32l1.h
new file mode 100644
index 0000000..96bea00
--- /dev/null
+++ b/include/libopencm3/stm32/l1/doc-stm32l1.h
@@ -0,0 +1,32 @@
+/** @mainpage libopencm3 STM32L1
+
+@version 1.0.0
+
+@date 12 November 2012
+
+API documentation for ST Microelectronics STM32L1 Cortex M3 series.
+
+LGPL License Terms @ref lgpl_license
+*/
+
+/** @defgroup STM32L1xx STM32L1xx
+Libraries for ST Microelectronics STM32L1xx series.
+
+@version 1.0.0
+
+@date 12 November 2012
+
+LGPL License Terms @ref lgpl_license
+*/
+
+/** @defgroup STM32L1xx_defines STM32L1xx Defines
+
+@brief Defined Constants and Types for the STM32L1xx series
+
+@version 1.0.0
+
+@date 12 November 2012
+
+LGPL License Terms @ref lgpl_license
+*/
+
diff --git a/include/libopencm3/stm32/l1/rcc.h b/include/libopencm3/stm32/l1/rcc.h
index 209d24f..d888d7c 100644
--- a/include/libopencm3/stm32/l1/rcc.h
+++ b/include/libopencm3/stm32/l1/rcc.h
@@ -1,6 +1,6 @@
-/** @file
+/** @defgroup STM32L1xx_rcc_defines RCC Defines
-@ingroup STM32L1xx
+@ingroup STM32L1xx_defines
@brief <b>libopencm3 STM32L1xx Reset and Clock Control</b>
@@ -10,19 +10,11 @@
@author @htmlonly &copy; @endhtmlonly 2009 Uwe Hermann <uwe@hermann-uwe.de>
@author @htmlonly &copy; @endhtmlonly 2012 Karl Palsson <karlp@tweak.net.au>
-@date 18 May 2012
+@date 11 November 2012
LGPL License Terms @ref lgpl_license
*/
-/** @defgroup STM32L1xx_rcc_defines
-
-@brief Defined Constants and Types for the STM32L1xx Reset and Clock Control
-@ingroup STM32L1xx_defines
-
-LGPL License Terms @ref lgpl_license
-
- */
/*
* This file is part of the libopencm3 project.
*
@@ -47,6 +39,8 @@ LGPL License Terms @ref lgpl_license
* TODO: very incomplete still!
*/
+/**@{*/
+
#ifndef LIBOPENCM3_RCC_H
#define LIBOPENCM3_RCC_H
@@ -405,4 +399,6 @@ void rcc_clock_setup_in_hse_12mhz_out_72mhz(void);
void rcc_clock_setup_in_hse_16mhz_out_72mhz(void);
void rcc_backupdomain_reset(void);
+/**@}*/
+
#endif
diff --git a/include/libopencm3/stm32/pwr.h b/include/libopencm3/stm32/pwr.h
index e709f3d..34b2407 100644
--- a/include/libopencm3/stm32/pwr.h
+++ b/include/libopencm3/stm32/pwr.h
@@ -1,4 +1,4 @@
-/** @defgroup STM32F1xx_pwr_defines PWR Defines
+/** @defgroup STM32F_pwr_defines PWR Defines
@ingroup STM32F_defines