aboutsummaryrefslogtreecommitdiff
path: root/include/libopencm3/stm32/f2
diff options
context:
space:
mode:
authorKen Sarkies2013-03-07 11:14:06 +1030
committerKen Sarkies2013-03-07 11:14:06 +1030
commite2022f588492d5c117743b6b13801940f4a4b03e (patch)
tree8c70e829e69094361afa51489ef097a5e663ea6c /include/libopencm3/stm32/f2
parent31aa3b6f5a9e9afa4d1bc8661cbaef147af55f74 (diff)
Repair to documentation (most documented files)
to remove errors, duplications and inconsistencies. File lib/stm32/f1/pwr.c - all code removed as it duplicates that in common/pwr_common.c Remaining changes do not affect code. Compiles OK. TODO efm32 has no code so generates no modules TODO F2 needs pwr.c TODO L1 needs dma.h and dma.c
Diffstat (limited to 'include/libopencm3/stm32/f2')
-rw-r--r--include/libopencm3/stm32/f2/crc.h2
-rw-r--r--include/libopencm3/stm32/f2/dac.h2
-rw-r--r--include/libopencm3/stm32/f2/dma.h5
-rw-r--r--include/libopencm3/stm32/f2/gpio.h4
-rw-r--r--include/libopencm3/stm32/f2/i2c.h3
-rw-r--r--include/libopencm3/stm32/f2/iwdg.h2
-rw-r--r--include/libopencm3/stm32/f2/pwr.h13
-rw-r--r--include/libopencm3/stm32/f2/rtc.h4
-rw-r--r--include/libopencm3/stm32/f2/spi.h2
-rw-r--r--include/libopencm3/stm32/f2/usart.h2
10 files changed, 15 insertions, 24 deletions
diff --git a/include/libopencm3/stm32/f2/crc.h b/include/libopencm3/stm32/f2/crc.h
index bf2d9fe..425eb61 100644
--- a/include/libopencm3/stm32/f2/crc.h
+++ b/include/libopencm3/stm32/f2/crc.h
@@ -6,8 +6,6 @@
@version 1.0.0
-@author @htmlonly &copy; @endhtmlonly 2010 Thomas Otto <tommi@viadmin.org>
-
@date 18 August 2012
LGPL License Terms @ref lgpl_license
diff --git a/include/libopencm3/stm32/f2/dac.h b/include/libopencm3/stm32/f2/dac.h
index f6e16e7..326706c 100644
--- a/include/libopencm3/stm32/f2/dac.h
+++ b/include/libopencm3/stm32/f2/dac.h
@@ -6,8 +6,6 @@
@version 1.0.0
-@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies <ksarkies@internode.on.net>
-
@date 5 December 2012
LGPL License Terms @ref lgpl_license
diff --git a/include/libopencm3/stm32/f2/dma.h b/include/libopencm3/stm32/f2/dma.h
index 0eb952c..5396bde 100644
--- a/include/libopencm3/stm32/f2/dma.h
+++ b/include/libopencm3/stm32/f2/dma.h
@@ -1,4 +1,4 @@
-/** @defgroup STM32F2xx_dma_defines DMA Defines
+/** @defgroup dma_defines DMA Defines
@ingroup STM32F2xx_defines
@@ -6,9 +6,6 @@
@version 1.0.0
-@author @htmlonly &copy; @endhtmlonly 2011 Fergus Noble <fergusnoble@gmail.com>
-@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies <ksarkies@internode.on.net>
-
@date 18 October 2012
LGPL License Terms @ref lgpl_license
diff --git a/include/libopencm3/stm32/f2/gpio.h b/include/libopencm3/stm32/f2/gpio.h
index 099fb38..f9f000a 100644
--- a/include/libopencm3/stm32/f2/gpio.h
+++ b/include/libopencm3/stm32/f2/gpio.h
@@ -6,10 +6,6 @@
@version 1.0.0
-@author @htmlonly &copy; @endhtmlonly 2009 Uwe Hermann <uwe@hermann-uwe.de>
-@author @htmlonly &copy; @endhtmlonly 2012 Piotr Esden-Tempski <piotr@esden.net>
-@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies <ksarkies@internode.on.net>
-
@date 1 July 2012
LGPL License Terms @ref lgpl_license
diff --git a/include/libopencm3/stm32/f2/i2c.h b/include/libopencm3/stm32/f2/i2c.h
index 3dc1652..7cc4bc8 100644
--- a/include/libopencm3/stm32/f2/i2c.h
+++ b/include/libopencm3/stm32/f2/i2c.h
@@ -6,9 +6,6 @@
@version 1.0.0
-@author @htmlonly &copy; @endhtmlonly 2010 Thomas Otto <tommi@viadmin.org>
-@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies <ksarkies@internode.on.net>
-
@date 12 October 2012
LGPL License Terms @ref lgpl_license
diff --git a/include/libopencm3/stm32/f2/iwdg.h b/include/libopencm3/stm32/f2/iwdg.h
index d15f9a9..d25398f 100644
--- a/include/libopencm3/stm32/f2/iwdg.h
+++ b/include/libopencm3/stm32/f2/iwdg.h
@@ -6,8 +6,6 @@
@version 1.0.0
-@author @htmlonly &copy; @endhtmlonly 2010 Thomas Otto <tommi@viadmin.org>
-
@date 18 August 2012
LGPL License Terms @ref lgpl_license
diff --git a/include/libopencm3/stm32/f2/pwr.h b/include/libopencm3/stm32/f2/pwr.h
index 7db223d..7c76505 100644
--- a/include/libopencm3/stm32/f2/pwr.h
+++ b/include/libopencm3/stm32/f2/pwr.h
@@ -1,3 +1,16 @@
+/** @defgroup pwr_defines PWR Defines
+
+@brief <b>Defined Constants and Types for the STM32F2xx PWR Control</b>
+
+@ingroup STM32F2xx_defines
+
+@version 1.0.0
+
+@date 4 March 2013
+
+LGPL License Terms @ref lgpl_license
+ */
+
/*
* This file is part of the libopencm3 project.
*
diff --git a/include/libopencm3/stm32/f2/rtc.h b/include/libopencm3/stm32/f2/rtc.h
index ebc0936..e78043c 100644
--- a/include/libopencm3/stm32/f2/rtc.h
+++ b/include/libopencm3/stm32/f2/rtc.h
@@ -6,8 +6,6 @@
@version 1.0.0
-@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies <ksarkies@internode.on.net>
-
@date 5 December 2012
LGPL License Terms @ref lgpl_license
@@ -36,4 +34,4 @@ LGPL License Terms @ref lgpl_license
#include <libopencm3/stm32/memorymap.h>
#include <libopencm3/stm32/common/rtc_common_bcd.h>
-#endif \ No newline at end of file
+#endif
diff --git a/include/libopencm3/stm32/f2/spi.h b/include/libopencm3/stm32/f2/spi.h
index c1a5f45..2c43428 100644
--- a/include/libopencm3/stm32/f2/spi.h
+++ b/include/libopencm3/stm32/f2/spi.h
@@ -6,8 +6,6 @@
@version 1.0.0
-@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies <ksarkies@internode.on.net>
-
@date 5 December 2012
LGPL License Terms @ref lgpl_license
diff --git a/include/libopencm3/stm32/f2/usart.h b/include/libopencm3/stm32/f2/usart.h
index 31314bc..8a4b54c 100644
--- a/include/libopencm3/stm32/f2/usart.h
+++ b/include/libopencm3/stm32/f2/usart.h
@@ -6,8 +6,6 @@
@version 1.0.0
-@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies <ksarkies@internode.on.net>
-
@date 5 December 2012
LGPL License Terms @ref lgpl_license