aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKen Sarkies2012-08-18 13:32:48 +0930
committerKen Sarkies2012-08-18 13:32:48 +0930
commit70b2376c9f8e008f7e5e8967206b73a2fe7926f9 (patch)
tree1c6e8ba03af2fb3c306483a6fce061e8c0d833a5
parent0e5e451e2287c61e4ca046561b8daedd412a6bc8 (diff)
Update to doxygen comments to fix promiscuity problem (see later)
-rw-r--r--include/libopencm3/stm32/f1/nvic_f1.h14
-rw-r--r--include/libopencm3/stm32/nvic.h6
-rw-r--r--lib/stm32/nvic.c11
3 files changed, 24 insertions, 7 deletions
diff --git a/include/libopencm3/stm32/f1/nvic_f1.h b/include/libopencm3/stm32/f1/nvic_f1.h
index 99594ee..bb0e03d 100644
--- a/include/libopencm3/stm32/f1/nvic_f1.h
+++ b/include/libopencm3/stm32/f1/nvic_f1.h
@@ -1,3 +1,17 @@
+/** @defgroup STM32F_nvic_f1_defines STM32F NVIC Defines
+
+@brief <b>Defined Constants and Types for the STM32F1xx Nested Vectored Interrupt Controller</b>
+
+@ingroup STM32F_defines
+
+@version 1.0.0
+
+@author @htmlonly &copy; @endhtmlonly 2010 Thomas Otto <tommi@viadmin.org>
+
+@date 18 August 2012
+
+LGPL License Terms @ref lgpl_license
+ */
/*
* This file is part of the libopencm3 project.
*
diff --git a/include/libopencm3/stm32/nvic.h b/include/libopencm3/stm32/nvic.h
index f974483..f6a6075 100644
--- a/include/libopencm3/stm32/nvic.h
+++ b/include/libopencm3/stm32/nvic.h
@@ -1,9 +1,9 @@
-/** @file
-
-@ingroup STM32F
+/** @defgroup STM32F_nvic_defines STM32F NVIC Defines
@brief <b>libopencm3 STM32F Nested Vectored Interrupt Controller</b>
+@ingroup STM32F_defines
+
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2010 Piotr Esden-Tempski <piotr@esden.net>
diff --git a/lib/stm32/nvic.c b/lib/stm32/nvic.c
index 9fda91c..e17e78c 100644
--- a/lib/stm32/nvic.c
+++ b/lib/stm32/nvic.c
@@ -1,6 +1,6 @@
-/** @file
+/** @defgroup STM32F-nvic-file NVIC
-@ingroup STM32F
+@ingroup STM32F-files
@brief <b>libopencm3 STM32F Nested Vectored Interrupt Controller</b>
@@ -9,7 +9,7 @@
@author @htmlonly &copy; @endhtmlonly 2010 Thomas Otto <tommi@viadmin.org>
@author @htmlonly &copy; @endhtmlonly 2012 Fergus Noble <fergusnoble@gmail.com>
-@date 14 August 2012
+@date 18 August 2012
The STM32F series provides up to 68 maskable user interrupts for the STM32F10x
series, and 87 for the STM32F2xx and STM32F4xx series.
@@ -19,7 +19,6 @@ additional limitations
@see Cortex-M3 Devices Generic User Guide
@see STM32F10xxx Cortex-M3 programming manual
-
LGPL License Terms @ref lgpl_license
*/
/*
@@ -42,6 +41,8 @@ LGPL License Terms @ref lgpl_license
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
+/**@{*/
+
#include <libopencm3/stm32/nvic.h>
/*-----------------------------------------------------------------------------*/
@@ -169,3 +170,5 @@ void nvic_generate_software_interrupt(u16 irqn)
if (irqn <= 239)
NVIC_STIR |= irqn;
}
+/**@}*/
+