aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKen Sarkies2013-03-07 11:14:06 +1030
committerKen Sarkies2013-03-07 11:14:06 +1030
commite2022f588492d5c117743b6b13801940f4a4b03e (patch)
tree8c70e829e69094361afa51489ef097a5e663ea6c
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
-rw-r--r--doc/DoxygenLayout.xml10
-rw-r--r--doc/HACKING43
-rw-r--r--doc/cm3/DoxygenLayout_cm3.xml1
-rw-r--r--doc/stm32f2/Doxyfile2
-rw-r--r--doc/stm32f4/Doxyfile2
-rw-r--r--doc/stm32l1/DoxygenLayout_stm32l1.xml2
-rw-r--r--include/libopencm3/efm32/efm32lg/doc-efm32lg.h32
-rw-r--r--include/libopencm3/efm32/efm32tg/doc-efm32tg.h32
-rw-r--r--include/libopencm3/stm32/common/crc_common_all.h8
-rw-r--r--include/libopencm3/stm32/common/dac_common_all.h6
-rw-r--r--include/libopencm3/stm32/common/dma_common_f13.h8
-rw-r--r--include/libopencm3/stm32/common/dma_common_f24.h7
-rw-r--r--include/libopencm3/stm32/common/gpio_common_all.h7
-rw-r--r--include/libopencm3/stm32/common/gpio_common_f24.h7
-rw-r--r--include/libopencm3/stm32/common/i2c_common_all.h6
-rw-r--r--include/libopencm3/stm32/common/i2c_common_f24.h6
-rw-r--r--include/libopencm3/stm32/common/iwdg_common_all.h6
-rw-r--r--include/libopencm3/stm32/common/pwr_common_all.h6
-rw-r--r--include/libopencm3/stm32/common/rtc_common_bcd.h6
-rw-r--r--include/libopencm3/stm32/common/spi_common_all.h6
-rw-r--r--include/libopencm3/stm32/common/spi_common_f24.h6
-rw-r--r--include/libopencm3/stm32/common/usart_common_all.h6
-rw-r--r--include/libopencm3/stm32/common/usart_common_f24.h7
-rw-r--r--include/libopencm3/stm32/doc-stm32f.h29
-rw-r--r--include/libopencm3/stm32/f1/adc.h2
-rw-r--r--include/libopencm3/stm32/f1/crc.h2
-rw-r--r--include/libopencm3/stm32/f1/dac.h2
-rw-r--r--include/libopencm3/stm32/f1/dma.h5
-rw-r--r--include/libopencm3/stm32/f1/gpio.h4
-rw-r--r--include/libopencm3/stm32/f1/i2c.h3
-rw-r--r--include/libopencm3/stm32/f1/iwdg.h2
-rw-r--r--include/libopencm3/stm32/f1/pwr.h2
-rw-r--r--include/libopencm3/stm32/f1/rtc.h14
-rw-r--r--include/libopencm3/stm32/f1/spi.h2
-rw-r--r--include/libopencm3/stm32/f1/usart.h2
-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
-rw-r--r--include/libopencm3/stm32/f4/crc.h2
-rw-r--r--include/libopencm3/stm32/f4/dac.h2
-rw-r--r--include/libopencm3/stm32/f4/dma.h5
-rw-r--r--include/libopencm3/stm32/f4/gpio.h4
-rw-r--r--include/libopencm3/stm32/f4/i2c.h3
-rw-r--r--include/libopencm3/stm32/f4/iwdg.h2
-rw-r--r--include/libopencm3/stm32/f4/pwr.h2
-rw-r--r--include/libopencm3/stm32/f4/rtc.h2
-rw-r--r--include/libopencm3/stm32/f4/spi.h2
-rw-r--r--include/libopencm3/stm32/f4/usart.h2
-rw-r--r--include/libopencm3/stm32/l1/crc.h2
-rw-r--r--include/libopencm3/stm32/l1/dac.h2
-rw-r--r--include/libopencm3/stm32/l1/gpio.h4
-rw-r--r--include/libopencm3/stm32/l1/i2c.h3
-rw-r--r--include/libopencm3/stm32/l1/iwdg.h2
-rw-r--r--include/libopencm3/stm32/l1/rtc.h4
-rw-r--r--include/libopencm3/stm32/l1/spi.h2
-rw-r--r--include/libopencm3/stm32/l1/usart.h2
-rw-r--r--lib/lm4f/rcc.c2
-rw-r--r--lib/stm32/common/crc_common_all.c6
-rw-r--r--lib/stm32/common/dac_common_all.c6
-rw-r--r--lib/stm32/common/dma_common_f13.c6
-rw-r--r--lib/stm32/common/dma_common_f24.c10
-rw-r--r--lib/stm32/common/gpio_common_all.c6
-rw-r--r--lib/stm32/common/gpio_common_f24.c5
-rw-r--r--lib/stm32/common/i2c_common_all.c7
-rw-r--r--lib/stm32/common/iwdg_common_all.c7
-rw-r--r--lib/stm32/common/pwr_common_all.c14
-rw-r--r--lib/stm32/common/rtc_common_bcd.c6
-rw-r--r--lib/stm32/common/spi_common_all.c8
-rw-r--r--lib/stm32/common/usart_common_all.c8
-rw-r--r--lib/stm32/f1/crc.c5
-rw-r--r--lib/stm32/f1/dac.c5
-rw-r--r--lib/stm32/f1/dma.c5
-rw-r--r--lib/stm32/f1/i2c.c5
-rw-r--r--lib/stm32/f1/iwdg.c5
-rw-r--r--lib/stm32/f1/pwr.c177
-rw-r--r--lib/stm32/f1/rtc.c20
-rw-r--r--lib/stm32/f1/spi.c5
-rw-r--r--lib/stm32/f1/usart.c5
-rw-r--r--lib/stm32/f2/crc.c5
-rw-r--r--lib/stm32/f2/dac.c5
-rw-r--r--lib/stm32/f2/dma.c5
-rw-r--r--lib/stm32/f2/gpio.c5
-rw-r--r--lib/stm32/f2/i2c.c5
-rw-r--r--lib/stm32/f2/iwdg.c5
-rw-r--r--lib/stm32/f2/rtc.c5
-rw-r--r--lib/stm32/f2/spi.c5
-rw-r--r--lib/stm32/f2/usart.c5
-rw-r--r--lib/stm32/f4/crc.c5
-rw-r--r--lib/stm32/f4/dac.c5
-rw-r--r--lib/stm32/f4/dma.c5
-rw-r--r--lib/stm32/f4/gpio.c5
-rw-r--r--lib/stm32/f4/i2c.c5
-rw-r--r--lib/stm32/f4/iwdg.c5
-rw-r--r--lib/stm32/f4/pwr.c19
-rw-r--r--lib/stm32/f4/rtc.c5
-rw-r--r--lib/stm32/f4/spi.c5
-rw-r--r--lib/stm32/f4/usart.c5
-rw-r--r--lib/stm32/l1/crc.c5
-rw-r--r--lib/stm32/l1/dac.c5
-rw-r--r--lib/stm32/l1/gpio.c5
-rw-r--r--lib/stm32/l1/i2c.c5
-rw-r--r--lib/stm32/l1/iwdg.c5
-rw-r--r--lib/stm32/l1/pwr.c17
-rw-r--r--lib/stm32/l1/rtc.c5
-rw-r--r--lib/stm32/l1/spi.c5
-rw-r--r--lib/stm32/l1/usart.c5
113 files changed, 460 insertions, 406 deletions
diff --git a/doc/DoxygenLayout.xml b/doc/DoxygenLayout.xml
index a602652..c1a7744 100644
--- a/doc/DoxygenLayout.xml
+++ b/doc/DoxygenLayout.xml
@@ -8,16 +8,16 @@
<tab type="user" visible="yes" url="../stm32f1/html/modules.html" title="STM32F1" intro=""/>
<tab type="user" visible="yes" url="../stm32f2/html/modules.html" title="STM32F2" intro=""/>
<tab type="user" visible="yes" url="../stm32f4/html/modules.html" title="STM32F4" intro=""/>
- <tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/>
+ <tab type="user" visible="yes" url="../stm32l1/html/modules.html" title="STM32L1" intro=""/>
<tab type="user" visible="yes" url="../lm3s/html/modules.html" title="LM3S" intro=""/>
<tab type="user" visible="yes" url="../lm4f/html/modules.html" title="LM4F" intro=""/>
<tab type="user" visible="yes" url="../lpc13xx/html/modules.html" title="LPC13" intro=""/>
<tab type="user" visible="yes" url="../lpc17xx/html/modules.html" title="LPC17" intro=""/>
<tab type="user" visible="yes" url="../lpc43xx/html/modules.html" title="LPC43" intro=""/>
- <tab type="user" visible="yes" url="../../emf32g/html/modules.html" title="EMF32 Gecko" intro=""/>
- <tab type="user" visible="yes" url="../../emf32gg/html/modules.html" title="EMF32 Giant Gecko" intro=""/>
- <tab type="user" visible="yes" url="../../emf32lg/html/modules.html" title="EMF32 Leopard Gecko" intro=""/>
- <tab type="user" visible="yes" url="../../emf32tg/html/modules.html" title="EMF32 Tiny Gecko" intro=""/>
+ <tab type="user" visible="yes" url="../emf32g/html/modules.html" title="EMF32 Gecko" intro=""/>
+ <tab type="user" visible="yes" url="../emf32gg/html/modules.html" title="EMF32 Giant Gecko" intro=""/>
+ <tab type="user" visible="yes" url="../emf32lg/html/modules.html" title="EMF32 Leopard Gecko" intro=""/>
+ <tab type="user" visible="yes" url="../emf32tg/html/modules.html" title="EMF32 Tiny Gecko" intro=""/>
<tab type="namespaces" visible="yes" title="">
<tab type="namespaces" visible="yes" title="" intro=""/>
<tab type="namespacemembers" visible="yes" title="" intro=""/>
diff --git a/doc/HACKING b/doc/HACKING
index 07fb872..4863676 100644
--- a/doc/HACKING
+++ b/doc/HACKING
@@ -28,23 +28,32 @@ Markup
------
Each family has been given a group name that will allow subgrouping of API
-functions and defines in the documentation.
-
-The header and source files for each family must have a heading section
-in which an @defgroup defines the group names. For a peripheral xxx the
-header will have a group name xxx_defines and the source file will have
-xxx_file. This will allow the group to appear separately. An @ingroup must
-be provided to place the group as a subgroup of the appropriate family
-grouping. Note that @file is not used.
-
-Common header and source files must have an @addgroup to include its
-documentation into the appropriate peripheral group. These must not have any
-reference to family groupings to allow them to be incorporated into multiple
-family groups.
-
-Each function must have a header with an @brief, and where appropriate
-@parameter and @return elements. These must describe the allowable parameter
-ranges preferably with reference to a suitable define.
+functions and defines in the documentation.
+
+The header and source files for each peripheral in each family must have a
+heading section in which an @defgroup defines the group name for the particular
+peripheral. This group name will be the same across all families as each one
+is documented deparately. Thus for a peripheral xxx the header will have a
+group name xxx_defines and the source file will have xxx_file. This will allow
+the group to appear separately. An @ingroup must be provided to place the group
+as a subgroup of the appropriate family grouping. Note that @file is not used.
+
+The heading section must include the version number and date and authors names
+plus a license reference. Any documentation specific to the family can be
+included here. If there are common files included then their documentation will
+appear in a separate section.
+
+Common header and source files that are included into a number of families must
+have an @addgroup to include its documentation into the appropriate peripheral
+group. These headings may include authors and any specific descriptions but the
+date and version number must be omitted as it will be included from the family
+files. There must not be any reference to family groupings as these common files
+will be incorporated into multiple family groups.
+
+Each helper function must have a header with an @brief, and where appropriate
+additional description, @parameter and @return elements. These latter must
+describe the allowable parameter ranges preferably with reference to a suitable
+define in the corresponding header file.
The Doxyfile for a family must include input files from the header and source
subdirectories, as well as all needed common files. The common files can be
diff --git a/doc/cm3/DoxygenLayout_cm3.xml b/doc/cm3/DoxygenLayout_cm3.xml
index 66ed9f3..1206a19 100644
--- a/doc/cm3/DoxygenLayout_cm3.xml
+++ b/doc/cm3/DoxygenLayout_cm3.xml
@@ -4,7 +4,6 @@
<tab type="mainpage" visible="yes" title="libopencm3"/>
<tab type="user" visible="yes" url="../../html/index.html" title="Back to Top" intro=""/>
<tab type="modules" visible="yes" title="CM3 Core" intro=""/>
- <tab type="user" visible="yes" url="../../stm32/html/modules.html" title="STM32" intro=""/>
<tab type="user" visible="yes" url="../../stm32f1/html/modules.html" title="STM32F1" intro=""/>
<tab type="user" visible="yes" url="../../stm32f2/html/modules.html" title="STM32F2" intro=""/>
<tab type="user" visible="yes" url="../../stm32f4/html/modules.html" title="STM32F4" intro=""/>
diff --git a/doc/stm32f2/Doxyfile b/doc/stm32f2/Doxyfile
index bc0348e..cfe5dd5 100644
--- a/doc/stm32f2/Doxyfile
+++ b/doc/stm32f2/Doxyfile
@@ -24,7 +24,7 @@ INPUT += ../../lib/stm32/f2 \
EXCLUDE =
-EXCLUDE_PATTERNS =
+EXCLUDE_PATTERNS = *_common_f13.h *_common_f13.c
LAYOUT_FILE = DoxygenLayout_stm32f2.xml
diff --git a/doc/stm32f4/Doxyfile b/doc/stm32f4/Doxyfile
index eee41e9..c5016f4 100644
--- a/doc/stm32f4/Doxyfile
+++ b/doc/stm32f4/Doxyfile
@@ -24,6 +24,8 @@ INPUT += ../../lib/stm32/f4 \
EXCLUDE =
+EXCLUDE_PATTERNS = *_common_f13.h *_common_f13.c
+
LAYOUT_FILE = DoxygenLayout_stm32f4.xml
TAGFILES = ../cm3/cm3.tag=../../cm3/html
diff --git a/doc/stm32l1/DoxygenLayout_stm32l1.xml b/doc/stm32l1/DoxygenLayout_stm32l1.xml
index 86ee511..28837e1 100644
--- a/doc/stm32l1/DoxygenLayout_stm32l1.xml
+++ b/doc/stm32l1/DoxygenLayout_stm32l1.xml
@@ -5,7 +5,7 @@
<tab type="pages" visible="yes" title="General Information" intro=""/>
<tab type="user" visible="yes" url="../../html/index.html" title="Back to Top" intro=""/>
<tab type="user" visible="yes" url="../../cm3/html/modules.html" title="CM3 Core" intro=""/>
- <tab type="user" visible="yes" url="../../stm32f1/html/modules.html" title="STM32F2" intro=""/>
+ <tab type="user" visible="yes" url="../../stm32f1/html/modules.html" title="STM32F1" intro=""/>
<tab type="user" visible="yes" url="../../stm32f2/html/modules.html" title="STM32F2" intro=""/>
<tab type="user" visible="yes" url="../../stm32f4/html/modules.html" title="STM32F4" intro=""/>
<tab type="modules" visible="yes" title="STM32L1" intro=""/>
diff --git a/include/libopencm3/efm32/efm32lg/doc-efm32lg.h b/include/libopencm3/efm32/efm32lg/doc-efm32lg.h
new file mode 100644
index 0000000..cea52e5
--- /dev/null
+++ b/include/libopencm3/efm32/efm32lg/doc-efm32lg.h
@@ -0,0 +1,32 @@
+/** @mainpage libopencm3 EFM32 Leopard Gecko
+
+@version 1.0.0
+
+@date 4 March 2013
+
+API documentation for Energy Micro EFM32 Leopard Gecko Cortex M3 series.
+
+LGPL License Terms @ref lgpl_license
+*/
+
+/** @defgroup EFM32LG EFM32 LeopardGecko
+Libraries for Energy Micro EFM32 Leopard Gecko series.
+
+@version 1.0.0
+
+@date 4 March 2013
+
+LGPL License Terms @ref lgpl_license
+*/
+
+/** @defgroup EFM32LG_defines EFM32 Leopard Gecko Defines
+
+@brief Defined Constants and Types for the Energy Micro EFM32 Leopard Gecko series
+
+@version 1.0.0
+
+@date 4 March 2013
+
+LGPL License Terms @ref lgpl_license
+*/
+
diff --git a/include/libopencm3/efm32/efm32tg/doc-efm32tg.h b/include/libopencm3/efm32/efm32tg/doc-efm32tg.h
new file mode 100644
index 0000000..799048c
--- /dev/null
+++ b/include/libopencm3/efm32/efm32tg/doc-efm32tg.h
@@ -0,0 +1,32 @@
+/** @mainpage libopencm3 EFM32 Tiny Gecko
+
+@version 1.0.0
+
+@date 4 March 2013
+
+API documentation for Energy Micro EFM32 Tiny Gecko Cortex M3 series.
+
+LGPL License Terms @ref lgpl_license
+*/
+
+/** @defgroup EFM32TG EFM32 TinyGecko
+Libraries for Energy Micro EFM32 Tiny Gecko series.
+
+@version 1.0.0
+
+@date 4 March 2013
+
+LGPL License Terms @ref lgpl_license
+*/
+
+/** @defgroup EFM32TG_defines EFM32 Tiny Gecko Defines
+
+@brief Defined Constants and Types for the Energy Micro EFM32 Tiny Gecko series
+
+@version 1.0.0
+
+@date 4 March 2013
+
+LGPL License Terms @ref lgpl_license
+*/
+
diff --git a/include/libopencm3/stm32/common/crc_common_all.h b/include/libopencm3/stm32/common/crc_common_all.h
index 892f41b..209f19b 100644
--- a/include/libopencm3/stm32/common/crc_common_all.h
+++ b/include/libopencm3/stm32/common/crc_common_all.h
@@ -1,4 +1,8 @@
-/** @addtogroup crc_defines */
+/** @addtogroup crc_defines
+
+@author @htmlonly &copy; @endhtmlonly 2010 Thomas Otto <tommi@viadmin.org>
+
+*/
/*
* This file is part of the libopencm3 project.
@@ -19,7 +23,7 @@
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
-/* THIS FILE SHOULD NOT BE INCLUDED DIRECTLY, BUT ONLY VIA SPI.H */
+/* THIS FILE SHOULD NOT BE INCLUDED DIRECTLY, BUT ONLY VIA CRC.H */
#ifndef LIBOPENCM3_CRC_COMMON_ALL_H
#define LIBOPENCM3_CRC_COMMON_ALL_H
diff --git a/include/libopencm3/stm32/common/dac_common_all.h b/include/libopencm3/stm32/common/dac_common_all.h
index c843c55..94bf01b 100644
--- a/include/libopencm3/stm32/common/dac_common_all.h
+++ b/include/libopencm3/stm32/common/dac_common_all.h
@@ -1,4 +1,8 @@
-/** @addtogroup dac_defines */
+/** @addtogroup dac_defines
+
+@author @htmlonly &copy; @endhtmlonly 2012 Felix Held <felix-libopencm3@felixheld.de>
+
+*/
/*
* This file is part of the libopencm3 project.
diff --git a/include/libopencm3/stm32/common/dma_common_f13.h b/include/libopencm3/stm32/common/dma_common_f13.h
index 964bdf1..68ade00 100644
--- a/include/libopencm3/stm32/common/dma_common_f13.h
+++ b/include/libopencm3/stm32/common/dma_common_f13.h
@@ -1,4 +1,10 @@
-/** @addtogroup dma_defines */
+/** @addtogroup dma_defines
+
+@author @htmlonly &copy; @endhtmlonly 2010 Thomas Otto <tommi@viadmin.org>
+@author @htmlonly &copy; @endhtmlonly 2012 Piotr Esden-Tempski <piotr@esden.net>
+
+*/
+
/*
* This file is part of the libopencm3 project.
*
diff --git a/include/libopencm3/stm32/common/dma_common_f24.h b/include/libopencm3/stm32/common/dma_common_f24.h
index e7c5a16..ecf9fcf 100644
--- a/include/libopencm3/stm32/common/dma_common_f24.h
+++ b/include/libopencm3/stm32/common/dma_common_f24.h
@@ -1,4 +1,9 @@
-/** @addtogroup dma_defines */
+/** @addtogroup dma_defines
+
+@author @htmlonly &copy; @endhtmlonly 2011 Fergus Noble <fergusnoble@gmail.com>
+@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies <ksarkies@internode.on.net>
+
+*/
/*
* This file is part of the libopencm3 project.
*
diff --git a/include/libopencm3/stm32/common/gpio_common_all.h b/include/libopencm3/stm32/common/gpio_common_all.h
index 9b05fde..4d03db0 100644
--- a/include/libopencm3/stm32/common/gpio_common_all.h
+++ b/include/libopencm3/stm32/common/gpio_common_all.h
@@ -1,4 +1,9 @@
-/** @addtogroup gpio_defines */
+/** @addtogroup gpio_defines
+
+@author @htmlonly &copy; @endhtmlonly 2011 Fergus Noble <fergusnoble@gmail.com>
+@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies <ksarkies@internode.on.net>
+
+*/
/*
* This file is part of the libopencm3 project.
diff --git a/include/libopencm3/stm32/common/gpio_common_f24.h b/include/libopencm3/stm32/common/gpio_common_f24.h
index f8bd4fb..2ce0167 100644
--- a/include/libopencm3/stm32/common/gpio_common_f24.h
+++ b/include/libopencm3/stm32/common/gpio_common_f24.h
@@ -1,4 +1,9 @@
-/** @addtogroup gpio_defines */
+/** @addtogroup gpio_defines
+
+@author @htmlonly &copy; @endhtmlonly 2011 Fergus Noble <fergusnoble@gmail.com>
+@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies <ksarkies@internode.on.net>
+
+*/
/*
* This file is part of the libopencm3 project.
*
diff --git a/include/libopencm3/stm32/common/i2c_common_all.h b/include/libopencm3/stm32/common/i2c_common_all.h
index d5cc490..7f6d447 100644
--- a/include/libopencm3/stm32/common/i2c_common_all.h
+++ b/include/libopencm3/stm32/common/i2c_common_all.h
@@ -1,4 +1,8 @@
-/** @addtogroup i2c_defines */
+/** @addtogroup i2c_defines
+
+@author @htmlonly &copy; @endhtmlonly 2010 Thomas Otto <tommi@viadmin.org>
+
+*/
/*
* This file is part of the libopencm3 project.
diff --git a/include/libopencm3/stm32/common/i2c_common_f24.h b/include/libopencm3/stm32/common/i2c_common_f24.h
index 22a5733..c267bd8 100644
--- a/include/libopencm3/stm32/common/i2c_common_f24.h
+++ b/include/libopencm3/stm32/common/i2c_common_f24.h
@@ -1,4 +1,8 @@
-/** @addtogroup i2c_defines */
+/** @addtogroup i2c_defines
+
+@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies <ksarkies@internode.on.net>
+
+*/
/*
* This file is part of the libopencm3 project.
diff --git a/include/libopencm3/stm32/common/iwdg_common_all.h b/include/libopencm3/stm32/common/iwdg_common_all.h
index ea2ad16..b75e4d1 100644
--- a/include/libopencm3/stm32/common/iwdg_common_all.h
+++ b/include/libopencm3/stm32/common/iwdg_common_all.h
@@ -1,4 +1,8 @@
-/** @addtogroup iwdg_defines */
+/** @addtogroup iwdg_defines
+
+@author @htmlonly &copy; @endhtmlonly 2010 Thomas Otto <tommi@viadmin.org>
+
+*/
/*
* This file is part of the libopencm3 project.
*
diff --git a/include/libopencm3/stm32/common/pwr_common_all.h b/include/libopencm3/stm32/common/pwr_common_all.h
index cc9fd22..a6b38d8 100644
--- a/include/libopencm3/stm32/common/pwr_common_all.h
+++ b/include/libopencm3/stm32/common/pwr_common_all.h
@@ -1,4 +1,8 @@
-/** @addtogroup pwr_defines */
+/** @addtogroup pwr_defines
+
+@author @htmlonly &copy; @endhtmlonly 2010 Thomas Otto <tommi@viadmin.org>
+
+*/
/*
* This file is part of the libopencm3 project.
diff --git a/include/libopencm3/stm32/common/rtc_common_bcd.h b/include/libopencm3/stm32/common/rtc_common_bcd.h
index 69a46f5..41afe3f 100644
--- a/include/libopencm3/stm32/common/rtc_common_bcd.h
+++ b/include/libopencm3/stm32/common/rtc_common_bcd.h
@@ -1,4 +1,8 @@
-/** @addtogroup rtc_defines */
+/** @addtogroup rtc_defines
+
+@author @htmlonly &copy; @endhtmlonly 2012 Karl Palsson <karlp@tweak.net.au>
+
+*/
/*
* This file is part of the libopencm3 project.
*
diff --git a/include/libopencm3/stm32/common/spi_common_all.h b/include/libopencm3/stm32/common/spi_common_all.h
index 976d679..a337c37 100644
--- a/include/libopencm3/stm32/common/spi_common_all.h
+++ b/include/libopencm3/stm32/common/spi_common_all.h
@@ -1,4 +1,8 @@
-/** @addtogroup spi_defines */
+/** @addtogroup spi_defines
+
+@author @htmlonly &copy; @endhtmlonly 2009 Uwe Hermann <uwe@hermann-uwe.de>
+
+*/
/*
* This file is part of the libopencm3 project.
diff --git a/include/libopencm3/stm32/common/spi_common_f24.h b/include/libopencm3/stm32/common/spi_common_f24.h
index 6b3764e..0a5873d 100644
--- a/include/libopencm3/stm32/common/spi_common_f24.h
+++ b/include/libopencm3/stm32/common/spi_common_f24.h
@@ -1,4 +1,8 @@
-/** @addtogroup spi_defines */
+/** @addtogroup spi_defines
+
+@author @htmlonly &copy; @endhtmlonly 2011 Fergus Noble <fergusnoble@gmail.com>
+
+*/
/*
* This file is part of the libopencm3 project.
*
diff --git a/include/libopencm3/stm32/common/usart_common_all.h b/include/libopencm3/stm32/common/usart_common_all.h
index 553ba28..b7ab394 100644
--- a/include/libopencm3/stm32/common/usart_common_all.h
+++ b/include/libopencm3/stm32/common/usart_common_all.h
@@ -1,4 +1,8 @@
-/** @addtogroup usart_defines */
+/** @addtogroup usart_defines
+
+@author @htmlonly &copy; @endhtmlonly 2009 Uwe Hermann <uwe@hermann-uwe.de>
+
+*/
/*
* This file is part of the libopencm3 project.
diff --git a/include/libopencm3/stm32/common/usart_common_f24.h b/include/libopencm3/stm32/common/usart_common_f24.h
index 089a0c2..301eceb 100644
--- a/include/libopencm3/stm32/common/usart_common_f24.h
+++ b/include/libopencm3/stm32/common/usart_common_f24.h
@@ -1,4 +1,9 @@
-/** @addtogroup usart_defines */
+/** @addtogroup usart_defines
+
+@author @htmlonly &copy; @endhtmlonly 2011 Uwe Hermann <uwe@hermann-uwe.de>
+@author @htmlonly &copy; @endhtmlonly 2011 Stephen Caudle <scaudle@doceme.com>
+
+*/
/*
* This file is part of the libopencm3 project.
*
diff --git a/include/libopencm3/stm32/doc-stm32f.h b/include/libopencm3/stm32/doc-stm32f.h
deleted file mode 100644
index 7b0a1a3..0000000
--- a/include/libopencm3/stm32/doc-stm32f.h
+++ /dev/null
@@ -1,29 +0,0 @@
-/** @mainpage libopencm3 STM32 Common
-
-@version 1.0.0
-
-@date 7 September 2012
-
-API documentation for common files for ST Microelectronics STM32 Cortex M3 series.
-
-LGPL License Terms @ref lgpl_license
-*/
-
-/** @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 Common Files
-
-@brief Common Files for ST Microelectronics STM32F series.
-
-@version 1.0.0
-
-@date 7 September 2012
-
-LGPL License Terms @ref lgpl_license
-*/
-
diff --git a/include/libopencm3/stm32/f1/adc.h b/include/libopencm3/stm32/f1/adc.h
index a382be2..1121bb1 100644
--- a/include/libopencm3/stm32/f1/adc.h
+++ b/include/libopencm3/stm32/f1/adc.h
@@ -1,4 +1,4 @@
-/** @defgroup STM32F1xx_adc_defines ADC Defines
+/** @defgroup adc_defines ADC Defines
@brief <b>Defined Constants and Types for the STM32F1xx Analog to Digital Converters</b>
diff --git a/include/libopencm3/stm32/f1/crc.h b/include/libopencm3/stm32/f1/crc.h
index c3b9939..f31d4de 100644
--- a/include/libopencm3/stm32/f1/crc.h
+++ b/include/libopencm3/stm32/f1/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/f1/dac.h b/include/libopencm3/stm32/f1/dac.h
index 1e6ecfa..e68618b 100644
--- a/include/libopencm3/stm32/f1/dac.h
+++ b/include/libopencm3/stm32/f1/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/f1/dma.h b/include/libopencm3/stm32/f1/dma.h
index e0c55a6..bdffa52 100644
--- a/include/libopencm3/stm32/f1/dma.h
+++ b/include/libopencm3/stm32/f1/dma.h
@@ -1,4 +1,4 @@
-/** @defgroup STM32F1xx_dma_defines DMA Defines
+/** @defgroup dma_defines DMA Defines
@ingroup STM32F1xx_defines
@@ -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 30 November 2012
LGPL License Terms @ref lgpl_license
diff --git a/include/libopencm3/stm32/f1/gpio.h b/include/libopencm3/stm32/f1/gpio.h
index 1e97b73..fb6690c 100644
--- a/include/libopencm3/stm32/f1/gpio.h
+++ b/include/libopencm3/stm32/f1/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/f1/i2c.h b/include/libopencm3/stm32/f1/i2c.h
index 44d906a..8c6ab52 100644
--- a/include/libopencm3/stm32/f1/i2c.h
+++ b/include/libopencm3/stm32/f1/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/f1/iwdg.h b/include/libopencm3/stm32/f1/iwdg.h
index c8a1e85..5a42f08 100644
--- a/include/libopencm3/stm32/f1/iwdg.h
+++ b/include/libopencm3/stm32/f1/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/f1/pwr.h b/include/libopencm3/stm32/f1/pwr.h
index 2875492..1cabca3 100644
--- a/include/libopencm3/stm32/f1/pwr.h
+++ b/include/libopencm3/stm32/f1/pwr.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/f1/rtc.h b/include/libopencm3/stm32/f1/rtc.h
index a8a8966..4070919 100644
--- a/include/libopencm3/stm32/f1/rtc.h
+++ b/include/libopencm3/stm32/f1/rtc.h
@@ -1,3 +1,17 @@
+/** @defgroup rtc_defines RTC Defines
+
+@brief <b>Defined Constants and Types for the STM32F1xx Real Time Clock</b>
+
+@ingroup STM32F1xx_defines
+
+@author @htmlonly &copy; @endhtmlonly 2010 Uwe Hermann <uwe@hermann-uwe.de>
+
+@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/f1/spi.h b/include/libopencm3/stm32/f1/spi.h
index eb434a1..d2fe7c2 100644
--- a/include/libopencm3/stm32/f1/spi.h
+++ b/include/libopencm3/stm32/f1/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/f1/usart.h b/include/libopencm3/stm32/f1/usart.h
index 24a8137..f18d255 100644
--- a/include/libopencm3/stm32/f1/usart.h
+++ b/include/libopencm3/stm32/f1/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
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
diff --git a/include/libopencm3/stm32/f4/crc.h b/include/libopencm3/stm32/f4/crc.h
index 1c375fa..bab8a23 100644
--- a/include/libopencm3/stm32/f4/crc.h
+++ b/include/libopencm3/stm32/f4/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/f4/dac.h b/include/libopencm3/stm32/f4/dac.h
index 0961c30..1634fd7 100644
--- a/include/libopencm3/stm32/f4/dac.h
+++ b/include/libopencm3/stm32/f4/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/f4/dma.h b/include/libopencm3/stm32/f4/dma.h
index a3e9db1..1b308de 100644
--- a/include/libopencm3/stm32/f4/dma.h
+++ b/include/libopencm3/stm32/f4/dma.h
@@ -1,4 +1,4 @@
-/** @defgroup STM32F4xx_dma_defines DMA Defines
+/** @defgroup dma_defines DMA Defines
@ingroup STM32F4xx_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 30 November 2012
LGPL License Terms @ref lgpl_license
diff --git a/include/libopencm3/stm32/f4/gpio.h b/include/libopencm3/stm32/f4/gpio.h
index 4eedc6e..dae8b92 100644
--- a/include/libopencm3/stm32/f4/gpio.h
+++ b/include/libopencm3/stm32/f4/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/f4/i2c.h b/include/libopencm3/stm32/f4/i2c.h
index e1a41cf..4f61f40 100644
--- a/include/libopencm3/stm32/f4/i2c.h
+++ b/include/libopencm3/stm32/f4/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/f4/iwdg.h b/include/libopencm3/stm32/f4/iwdg.h
index d5baef4..d708fb5 100644
--- a/include/libopencm3/stm32/f4/iwdg.h
+++ b/include/libopencm3/stm32/f4/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/f4/pwr.h b/include/libopencm3/stm32/f4/pwr.h
index c9b27fd..e07d4d7 100644
--- a/include/libopencm3/stm32/f4/pwr.h
+++ b/include/libopencm3/stm32/f4/pwr.h
@@ -8,6 +8,8 @@
@author @htmlonly &copy; @endhtmlonly 2011 Stephen Caudle <scaudle@doceme.com>
+@date 4 March 2013
+
LGPL License Terms @ref lgpl_license
*/
/*
diff --git a/include/libopencm3/stm32/f4/rtc.h b/include/libopencm3/stm32/f4/rtc.h
index 55b5b23..752895b 100644
--- a/include/libopencm3/stm32/f4/rtc.h
+++ b/include/libopencm3/stm32/f4/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
diff --git a/include/libopencm3/stm32/f4/spi.h b/include/libopencm3/stm32/f4/spi.h
index 6589290..5e2c564 100644
--- a/include/libopencm3/stm32/f4/spi.h
+++ b/include/libopencm3/stm32/f4/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/f4/usart.h b/include/libopencm3/stm32/f4/usart.h
index 740f0a8..6669e6b 100644
--- a/include/libopencm3/stm32/f4/usart.h
+++ b/include/libopencm3/stm32/f4/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
diff --git a/include/libopencm3/stm32/l1/crc.h b/include/libopencm3/stm32/l1/crc.h
index 07370f2..8019453 100644
--- a/include/libopencm3/stm32/l1/crc.h
+++ b/include/libopencm3/stm32/l1/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/l1/dac.h b/include/libopencm3/stm32/l1/dac.h
index 7f7ea52..8a8854c 100644
--- a/include/libopencm3/stm32/l1/dac.h
+++ b/include/libopencm3/stm32/l1/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/l1/gpio.h b/include/libopencm3/stm32/l1/gpio.h
index 93850a2..c4ab65f 100644
--- a/include/libopencm3/stm32/l1/gpio.h
+++ b/include/libopencm3/stm32/l1/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 Karl Palsson <karlp@tweak.net.au>
-
@date 1 July 2012
LGPL License Terms @ref lgpl_license
diff --git a/include/libopencm3/stm32/l1/i2c.h b/include/libopencm3/stm32/l1/i2c.h
index 1fd419d..c2fd3ab 100644
--- a/include/libopencm3/stm32/l1/i2c.h
+++ b/include/libopencm3/stm32/l1/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/l1/iwdg.h b/include/libopencm3/stm32/l1/iwdg.h
index 8ba6c44..54c11eb 100644
--- a/include/libopencm3/stm32/l1/iwdg.h
+++ b/include/libopencm3/stm32/l1/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/l1/rtc.h b/include/libopencm3/stm32/l1/rtc.h
index d364fb5..95331d3 100644
--- a/include/libopencm3/stm32/l1/rtc.h
+++ b/include/libopencm3/stm32/l1/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/l1/spi.h b/include/libopencm3/stm32/l1/spi.h
index 0484956..92f96d6 100644
--- a/include/libopencm3/stm32/l1/spi.h
+++ b/include/libopencm3/stm32/l1/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/l1/usart.h b/include/libopencm3/stm32/l1/usart.h
index 5b67a5a..75bb049 100644
--- a/include/libopencm3/stm32/l1/usart.h
+++ b/include/libopencm3/stm32/l1/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
diff --git a/lib/lm4f/rcc.c b/lib/lm4f/rcc.c
index 48eb2a2..26c6c39 100644
--- a/lib/lm4f/rcc.c
+++ b/lib/lm4f/rcc.c
@@ -23,6 +23,8 @@
*
* @ingroup LM4F
*
+@author @htmlonly &copy; @endhtmlonly 2012 Alexandru Gagniuc <mr.nuke.me@gmail.com>
+
* \brief <b>libopencm3 LM4F Clock control API</b>
*
* The LM$F clock API provides functionaliity for manipulating the system clock,
diff --git a/lib/stm32/common/crc_common_all.c b/lib/stm32/common/crc_common_all.c
index d65d1b7..14b35eb 100644
--- a/lib/stm32/common/crc_common_all.c
+++ b/lib/stm32/common/crc_common_all.c
@@ -1,13 +1,9 @@
/** @addtogroup crc_file
-@version 1.0.0
-
@author @htmlonly &copy; @endhtmlonly 2012 Karl Palsson <karlp@remake.is>
-@date 15 October 2012
+*/
-LGPL License Terms @ref lgpl_license
- */
/*
* This file is part of the libopencm3 project.
*
diff --git a/lib/stm32/common/dac_common_all.c b/lib/stm32/common/dac_common_all.c
index a6be233..b20b9c3 100644
--- a/lib/stm32/common/dac_common_all.c
+++ b/lib/stm32/common/dac_common_all.c
@@ -1,10 +1,6 @@
/** @addtogroup dac_file
-@version 1.0.0
-
-@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies
-
-@date 18 August 2012
+@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies ksarkies@internode.on.net
This library supports the Digital to Analog Conversion System in the
STM32F series of ARM Cortex Microcontrollers by ST Microelectronics.
diff --git a/lib/stm32/common/dma_common_f13.c b/lib/stm32/common/dma_common_f13.c
index 35b9da6..9ef5b45 100644
--- a/lib/stm32/common/dma_common_f13.c
+++ b/lib/stm32/common/dma_common_f13.c
@@ -1,11 +1,7 @@
/** @addtogroup dma_file
-@version 1.0.0
-
@author @htmlonly &copy; @endhtmlonly 2010 Thomas Otto <tommi@viadmin.org>
-@date 18 August 2012
-
This library supports the DMA Control System in the STM32 series of ARM Cortex
Microcontrollers by ST Microelectronics.
@@ -42,7 +38,7 @@ LGPL License Terms @ref lgpl_license
/**@{*/
-#include <libopencm3/stm32/f1/dma.h>
+#include <libopencm3/stm32/dma.h>
/*-----------------------------------------------------------------------------*/
/** @brief DMA Channel Reset
diff --git a/lib/stm32/common/dma_common_f24.c b/lib/stm32/common/dma_common_f24.c
index 504c30e..aa20e39 100644
--- a/lib/stm32/common/dma_common_f24.c
+++ b/lib/stm32/common/dma_common_f24.c
@@ -1,11 +1,7 @@
/** @addtogroup dma_file
-@version 1.0.0
-
@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies <ksarkies@internode.on.net>
-@date 30 November 2012
-
This library supports the DMA Control System in the STM32F2 and STM32F4
series of ARM Cortex Microcontrollers by ST Microelectronics.
@@ -22,8 +18,8 @@ Each stream has access to a 4 word deep FIFO and can use double buffering
by means of two memory pointers. When using the FIFO it is possible to
configure transfers to occur in indivisible bursts.
-It is also possible to select a peripheral to control the flow of data rather
-than the DMA controller. This limits the functionality but is udeful when the
+It is also possible to select a peripheral instead of the DMA controller to
+control the flow of data. This limits the functionality but is useful when the
number of transfers is unknown.
LGPL License Terms @ref lgpl_license
@@ -49,7 +45,7 @@ LGPL License Terms @ref lgpl_license
/**@{*/
-#include <libopencm3/stm32/f4/dma.h>
+#include <libopencm3/stm32/dma.h>
/*-----------------------------------------------------------------------------*/
/** @brief DMA Stream Reset
diff --git a/lib/stm32/common/gpio_common_all.c b/lib/stm32/common/gpio_common_all.c
index d23e415..ef662e4 100644
--- a/lib/stm32/common/gpio_common_all.c
+++ b/lib/stm32/common/gpio_common_all.c
@@ -1,4 +1,8 @@
-/** @addtogroup gpio_file */
+/** @addtogroup gpio_file
+
+@author @htmlonly &copy; @endhtmlonly 2009 Uwe Hermann <uwe@hermann-uwe.de>
+
+*/
/*
* This file is part of the libopencm3 project.
diff --git a/lib/stm32/common/gpio_common_f24.c b/lib/stm32/common/gpio_common_f24.c
index 5b29693..63c18c3 100644
--- a/lib/stm32/common/gpio_common_f24.c
+++ b/lib/stm32/common/gpio_common_f24.c
@@ -1,12 +1,8 @@
/** @addtogroup gpio_file
-@version 1.0.0
-
@author @htmlonly &copy; @endhtmlonly 2009 Uwe Hermann <uwe@hermann-uwe.de>
@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies <ksarkies@internode.on.net>
-@date 18 August 2012
-
Each I/O port has 16 individually configurable bits. Many I/O pins share GPIO
functionality with a number of alternate functions and must be configured to the
alternate function mode if these are to be accessed. A feature is available to
@@ -50,7 +46,6 @@ Example 2: Digital input on port C12 with pullup
reg16 = gpio_port_read(GPIOC);
@endcode
-LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
diff --git a/lib/stm32/common/i2c_common_all.c b/lib/stm32/common/i2c_common_all.c
index 28ae199..337fe9d 100644
--- a/lib/stm32/common/i2c_common_all.c
+++ b/lib/stm32/common/i2c_common_all.c
@@ -1,12 +1,8 @@
/** @addtogroup i2c_file
-@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 15 October 2012
-
Devices can have up to two I2C peripherals. The peripherals support SMBus and
PMBus variants.
@@ -17,8 +13,7 @@ a multimaster contention is lost or a stop condition is generated.
@todo all sorts of lovely stuff like DMA, Interrupts, SMBus variant, Status
register access, Error conditions
-LGPL License Terms @ref lgpl_license
- */
+*/
/*
* This file is part of the libopencm3 project.
*
diff --git a/lib/stm32/common/iwdg_common_all.c b/lib/stm32/common/iwdg_common_all.c
index d3d9364..792adfe 100644
--- a/lib/stm32/common/iwdg_common_all.c
+++ b/lib/stm32/common/iwdg_common_all.c
@@ -1,11 +1,7 @@
/** @addtogroup iwdg_file
-@version 1.0.0
-
@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies ksarkies@internode.on.net
-@date 18 August 2012
-
This library supports the Independent Watchdog Timer System in the STM32F1xx
series of ARM Cortex Microcontrollers by ST Microelectronics.
@@ -20,8 +16,7 @@ relevant bit is not set, the IWDG timer must be enabled by software.
@note: Tested: CPU STM32F103RET6, Board ET-ARM Stamp STM32
-LGPL License Terms @ref lgpl_license
- */
+*/
/*
* This file is part of the libopencm3 project.
*
diff --git a/lib/stm32/common/pwr_common_all.c b/lib/stm32/common/pwr_common_all.c
index 451ed1c..a455664 100644
--- a/lib/stm32/common/pwr_common_all.c
+++ b/lib/stm32/common/pwr_common_all.c
@@ -1,19 +1,7 @@
-/** @defgroup STM32F1xx-pwr-file PWR
-
-@ingroup STM32F1xx
-
-@brief <b>libopencm3 STM32F1xx Power Control</b>
-
-@version 1.0.0
+/** @addtogroup pwr-file PWR
@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies <ksarkies@internode.on.net>
-@date 18 August 2012
-
-This library supports the power control system for the
-STM32F1 series of ARM Cortex Microcontrollers by ST Microelectronics.
-
-LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
diff --git a/lib/stm32/common/rtc_common_bcd.c b/lib/stm32/common/rtc_common_bcd.c
index cddfe9b..ff61a48 100644
--- a/lib/stm32/common/rtc_common_bcd.c
+++ b/lib/stm32/common/rtc_common_bcd.c
@@ -1,4 +1,8 @@
-/** @addtogroup rtc_file */
+/** @addtogroup rtc_file
+
+@author @htmlonly &copy; @endhtmlonly 2012 Karl Palsson <karlp@tweak.net.au>
+
+*/
/*
* This file is part of the libopencm3 project.
diff --git a/lib/stm32/common/spi_common_all.c b/lib/stm32/common/spi_common_all.c
index 184654e..2431d44 100644
--- a/lib/stm32/common/spi_common_all.c
+++ b/lib/stm32/common/spi_common_all.c
@@ -1,12 +1,8 @@
/** @addtogroup spi_file
-@version 1.0.0
-
@author @htmlonly &copy; @endhtmlonly 2009 Uwe Hermann <uwe@hermann-uwe.de>
@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies <ksarkies@internode.on.net>
-@date 15 October 2012
-
Devices can have up to three SPI peripherals. The common 4-wire full-duplex
mode of operation is supported, along with 3-wire variants using unidirectional
communication modes or half-duplex bidirectional communication. A variety of
@@ -32,8 +28,8 @@ LSB first.
@todo need additional functions to aid ISRs in retrieving status
-LGPL License Terms @ref lgpl_license
- */
+*/
+
/*
* This file is part of the libopencm3 project.
*
diff --git a/lib/stm32/common/usart_common_all.c b/lib/stm32/common/usart_common_all.c
index 0c3d302..b550ba4 100644
--- a/lib/stm32/common/usart_common_all.c
+++ b/lib/stm32/common/usart_common_all.c
@@ -1,18 +1,14 @@
/** @addtogroup usart_file
-@version 1.0.0
-
@author @htmlonly &copy; @endhtmlonly 2009 Uwe Hermann <uwe@hermann-uwe.de>
-@date 30 August 2012
-
This library supports the USART/UART in the STM32F series
of ARM Cortex Microcontrollers by ST Microelectronics.
Devices can have up to 3 USARTs and 2 UARTs.
-LGPL License Terms @ref lgpl_license
- */
+*/
+
/*
* This file is part of the libopencm3 project.
*
diff --git a/lib/stm32/f1/crc.c b/lib/stm32/f1/crc.c
index 505fb79..8c88052 100644
--- a/lib/stm32/f1/crc.c
+++ b/lib/stm32/f1/crc.c
@@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32F1xx CRC</b>
+@version 1.0.0
+
+@date 15 October 2012
+
+LGPL License Terms @ref lgpl_license
*/
/*
diff --git a/lib/stm32/f1/dac.c b/lib/stm32/f1/dac.c
index 90dc029..d0a2372 100644
--- a/lib/stm32/f1/dac.c
+++ b/lib/stm32/f1/dac.c
@@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32F1xx DAC</b>
+@version 1.0.0
+
+@date 18 August 2012
+
+LGPL License Terms @ref lgpl_license
*/
/*
diff --git a/lib/stm32/f1/dma.c b/lib/stm32/f1/dma.c
index f22baef..3156508 100644
--- a/lib/stm32/f1/dma.c
+++ b/lib/stm32/f1/dma.c
@@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32F1xx DMA</b>
+@version 1.0.0
+
+@date 18 August 2012
+
+LGPL License Terms @ref lgpl_license
*/
/*
diff --git a/lib/stm32/f1/i2c.c b/lib/stm32/f1/i2c.c
index 2d86bf3..1f7e7a5 100644
--- a/lib/stm32/f1/i2c.c
+++ b/lib/stm32/f1/i2c.c
@@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32F1xx I2C</b>
+@version 1.0.0
+
+@date 15 October 2012
+
+LGPL License Terms @ref lgpl_license
*/
/*
diff --git a/lib/stm32/f1/iwdg.c b/lib/stm32/f1/iwdg.c
index 85cf18c..f44a9e4 100644
--- a/lib/stm32/f1/iwdg.c
+++ b/lib/stm32/f1/iwdg.c
@@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32F1xx Independent Watchdog Timer</b>
+@version 1.0.0
+
+@date 18 August 2012
+
+LGPL License Terms @ref lgpl_license
*/
/*
diff --git a/lib/stm32/f1/pwr.c b/lib/stm32/f1/pwr.c
index 451ed1c..8e59bab 100644
--- a/lib/stm32/f1/pwr.c
+++ b/lib/stm32/f1/pwr.c
@@ -1,4 +1,4 @@
-/** @defgroup STM32F1xx-pwr-file PWR
+/** @defgroup pwr-file PWR
@ingroup STM32F1xx
@@ -38,180 +38,5 @@ LGPL License Terms @ref lgpl_license
#include <libopencm3/stm32/pwr.h>
-/*---------------------------------------------------------------------------*/
-/** @brief Disable Backup Domain Write Protection.
-
-This allows backup domain registers to be changed. These registers are write
-protected after a reset.
-*/
-
-void pwr_disable_backup_domain_write_protect(void)
-{
- PWR_CR |= PWR_CR_DBP;
-}
-
-/*---------------------------------------------------------------------------*/
-/** @brief Re-enable Backup Domain Write Protection.
-
-This protects backup domain registers from inadvertent change.
-*/
-
-void pwr_enable_backup_domain_write_protect(void)
-{
- PWR_CR &= ~PWR_CR_DBP;
-}
-
-/*---------------------------------------------------------------------------*/
-/** @brief Enable Power Voltage Detector.
-
-This provides voltage level threshold detection. The result of detection is
-provided in the power voltage detector output flag (see @ref pwr_voltage_high)
-or by setting the EXTI16 interrupt (see datasheet for configuration details).
-
-@param[in] pvd_level u32. Taken from @ref pwr_pls.
-*/
-
-void pwr_enable_power_voltage_detect(u32 pvd_level)
-{
- PWR_CR &= ~PWR_CR_PLS_MASK;
- PWR_CR |= (PWR_CR_PVDE | pvd_level);
-}
-
-/*---------------------------------------------------------------------------*/
-/** @brief Disable Power Voltage Detector.
-
-*/
-
-void pwr_disable_power_voltage_detect(void)
-{
- PWR_CR &= ~PWR_CR_PVDE;
-}
-
-/*---------------------------------------------------------------------------*/
-/** @brief Clear the Standby Flag.
-
-This is set when the processor returns from a standby mode.
-*/
-
-void pwr_clear_standby_flag(void)
-{
- PWR_CR |= PWR_CR_CSBF;
-}
-
-/*---------------------------------------------------------------------------*/
-/** @brief Clear the Wakeup Flag.
-
-This is set when the processor receives a wakeup signal.
-*/
-
-void pwr_clear_wakeup_flag(void)
-{
- PWR_CR |= PWR_CR_CWUF;
-}
-
-/*---------------------------------------------------------------------------*/
-/** @brief Set Standby Mode in Deep Sleep.
-
-*/
-
-void pwr_set_standby_mode(void)
-{
- PWR_CR |= PWR_CR_PDDS;
-}
-
-/*---------------------------------------------------------------------------*/
-/** @brief Set Stop Mode in Deep Sleep.
-
-*/
-
-void pwr_set_stop_mode(void)
-{
- PWR_CR &= ~PWR_CR_PDDS;
-}
-
-/*---------------------------------------------------------------------------*/
-/** @brief Voltage Regulator On in Stop Mode.
-
-*/
-
-void pwr_voltage_regulator_on_in_stop(void)
-{
- PWR_CR &= ~PWR_CR_LPDS;
-}
-
-/*---------------------------------------------------------------------------*/
-/** @brief Voltage Regulator Low Power in Stop Mode.
-
-*/
-
-void pwr_voltage_regulator_low_power_in_stop(void)
-{
- PWR_CR |= PWR_CR_LPDS;
-}
-
-/*---------------------------------------------------------------------------*/
-/** @brief Enable Wakeup Pin.
-
-The wakeup pin is used for waking the processor from standby mode.
-*/
-
-void pwr_enable_wakeup_pin(void)
-{
- PWR_CSR |= PWR_CSR_EWUP;
-}
-
-/*---------------------------------------------------------------------------*/
-/** @brief Release Wakeup Pin.
-
-The wakeup pin is used for general purpose I/O.
-*/
-
-void pwr_disable_wakeup_pin(void)
-{
- PWR_CSR &= ~PWR_CSR_EWUP;
-}
-
-/*---------------------------------------------------------------------------*/
-/** @brief Get Voltage Detector Output.
-
-The voltage detector threshold must be set when the power voltage detector is
-enabled, see @ref pwr_enable_power_voltage_detect.
-
-@returns boolean: TRUE if the power voltage is above the preset voltage
-threshold.
-*/
-
-bool pwr_voltage_high(void)
-{
- return (PWR_CSR & PWR_CSR_PVDO);
-}
-
-/*---------------------------------------------------------------------------*/
-/** @brief Get Standby Flag.
-
-The standby flag is set when the processor returns from a standby state. It is
-cleared by software (see @ref pwr_clear_standby_flag).
-
-@returns boolean: TRUE if the processor was in standby state.
-*/
-
-bool pwr_get_standby_flag(void)
-{
- return (PWR_CSR & PWR_CSR_SBF);
-}
-
-/*---------------------------------------------------------------------------*/
-/** @brief Get Wakeup Flag.
-
-The wakeup flag is set when a wakeup event has been received. It is
-cleared by software (see @ref pwr_clear_wakeup_flag).
-
-@returns boolean: TRUE if a wakeup event was received.
-*/
-
-bool pwr_get_wakeup_flag(void)
-{
- return (PWR_CSR & PWR_CSR_WUF);
-}
/**@}*/
diff --git a/lib/stm32/f1/rtc.c b/lib/stm32/f1/rtc.c
index cfc5f5b..24b19ce 100644
--- a/lib/stm32/f1/rtc.c
+++ b/lib/stm32/f1/rtc.c
@@ -1,3 +1,19 @@
+/** @defgroup rtc_file RTC
+
+@ingroup STM32F1xx
+
+@brief <b>libopencm3 STM32F1xx RTC</b>
+
+@author @htmlonly &copy; @endhtmlonly 2010 Uwe Hermann <uwe@hermann-uwe.de>
+@author @htmlonly &copy; @endhtmlonly 2010 Lord James <lordjames@y7mail.com>
+
+@version 1.0.0
+
+@date 4 March 2013
+
+LGPL License Terms @ref lgpl_license
+*/
+
/*
* This file is part of the libopencm3 project.
*
@@ -18,8 +34,8 @@
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
-#include <libopencm3/stm32/f1/rcc.h>
-#include <libopencm3/stm32/f1/rtc.h>
+#include <libopencm3/stm32/rcc.h>
+#include <libopencm3/stm32/rtc.h>
#include <libopencm3/stm32/pwr.h>
void rtc_awake_from_off(osc_t clock_source)
diff --git a/lib/stm32/f1/spi.c b/lib/stm32/f1/spi.c
index 3be5c23..f3f36e3 100644
--- a/lib/stm32/f1/spi.c
+++ b/lib/stm32/f1/spi.c
@@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32F1xx SPI</b>
+@version 1.0.0
+
+@date 15 October 2012
+
+LGPL License Terms @ref lgpl_license
*/
/*
diff --git a/lib/stm32/f1/usart.c b/lib/stm32/f1/usart.c
index ecf2b06..13e20b2 100644
--- a/lib/stm32/f1/usart.c
+++ b/lib/stm32/f1/usart.c
@@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32F1xx USART</b>
+@version 1.0.0
+
+@date 30 August 2012
+
+LGPL License Terms @ref lgpl_license
*/
/*
diff --git a/lib/stm32/f2/crc.c b/lib/stm32/f2/crc.c
index 5437f7c..df352d1 100644
--- a/lib/stm32/f2/crc.c
+++ b/lib/stm32/f2/crc.c
@@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32F2xx CRC</b>
+@version 1.0.0
+
+@date 15 October 2012
+
+LGPL License Terms @ref lgpl_license
*/
/*
diff --git a/lib/stm32/f2/dac.c b/lib/stm32/f2/dac.c
index 5d20703..ce9165b 100644
--- a/lib/stm32/f2/dac.c
+++ b/lib/stm32/f2/dac.c
@@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32F2xx DAC</b>
+@version 1.0.0
+
+@date 18 August 2012
+
+LGPL License Terms @ref lgpl_license
*/
/*
diff --git a/lib/stm32/f2/dma.c b/lib/stm32/f2/dma.c
index 8e8f702..c9374ff 100644
--- a/lib/stm32/f2/dma.c
+++ b/lib/stm32/f2/dma.c
@@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32F2xx DMA</b>
+@version 1.0.0
+
+@date 30 November 2012
+
+LGPL License Terms @ref lgpl_license
*/
/*
diff --git a/lib/stm32/f2/gpio.c b/lib/stm32/f2/gpio.c
index a2dfc88..370f59b 100644
--- a/lib/stm32/f2/gpio.c
+++ b/lib/stm32/f2/gpio.c
@@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32F2xx General Purpose I/O</b>
+@version 1.0.0
+
+@date 18 August 2012
+
+LGPL License Terms @ref lgpl_license
*/
/*
diff --git a/lib/stm32/f2/i2c.c b/lib/stm32/f2/i2c.c
index f20a840..df0fcff 100644
--- a/lib/stm32/f2/i2c.c
+++ b/lib/stm32/f2/i2c.c
@@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32F2xx I2C</b>
+@version 1.0.0
+
+@date 15 October 2012
+
+LGPL License Terms @ref lgpl_license
*/
/*
diff --git a/lib/stm32/f2/iwdg.c b/lib/stm32/f2/iwdg.c
index 0440d88..80a223d 100644
--- a/lib/stm32/f2/iwdg.c
+++ b/lib/stm32/f2/iwdg.c
@@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32F2xx Independent Watchdog Timer</b>
+@version 1.0.0
+
+@date 18 August 2012
+
+LGPL License Terms @ref lgpl_license
*/
/*
diff --git a/lib/stm32/f2/rtc.c b/lib/stm32/f2/rtc.c
index 461d0b1..310fe43 100644
--- a/lib/stm32/f2/rtc.c
+++ b/lib/stm32/f2/rtc.c
@@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32F2xx RTC</b>
+@version 1.0.0
+
+@date 4 March 2013
+
+LGPL License Terms @ref lgpl_license
*/
/*
diff --git a/lib/stm32/f2/spi.c b/lib/stm32/f2/spi.c
index bc4a4ee..ce157a5 100644
--- a/lib/stm32/f2/spi.c
+++ b/lib/stm32/f2/spi.c
@@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32F2xx SPI</b>
+@version 1.0.0
+
+@date 15 October 2012
+
+LGPL License Terms @ref lgpl_license
*/
/*
diff --git a/lib/stm32/f2/usart.c b/lib/stm32/f2/usart.c
index 225b706..09c0900 100644
--- a/lib/stm32/f2/usart.c
+++ b/lib/stm32/f2/usart.c
@@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32F2xx USART</b>
+@version 1.0.0
+
+@date 30 August 2012
+
+LGPL License Terms @ref lgpl_license
*/
/*
diff --git a/lib/stm32/f4/crc.c b/lib/stm32/f4/crc.c
index 90e6782..1814fcc 100644
--- a/lib/stm32/f4/crc.c
+++ b/lib/stm32/f4/crc.c
@@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32F4xx CRC</b>
+@version 1.0.0
+
+@date 15 October 2012
+
+LGPL License Terms @ref lgpl_license
*/
/*
diff --git a/lib/stm32/f4/dac.c b/lib/stm32/f4/dac.c
index 4776c41..19eaa4b 100644
--- a/lib/stm32/f4/dac.c
+++ b/lib/stm32/f4/dac.c
@@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32F4xx DAC</b>
+@version 1.0.0
+
+@date 18 August 2012
+
+LGPL License Terms @ref lgpl_license
*/
/*
diff --git a/lib/stm32/f4/dma.c b/lib/stm32/f4/dma.c
index c9f5db6..75271a1 100644
--- a/lib/stm32/f4/dma.c
+++ b/lib/stm32/f4/dma.c
@@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32F4xx DMA</b>
+@version 1.0.0
+
+@date 30 November 2012
+
+LGPL License Terms @ref lgpl_license
*/
/*
diff --git a/lib/stm32/f4/gpio.c b/lib/stm32/f4/gpio.c
index 96a6f45..db42e8d 100644
--- a/lib/stm32/f4/gpio.c
+++ b/lib/stm32/f4/gpio.c
@@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32F4xx General Purpose I/O</b>
+@version 1.0.0
+
+@date 18 August 2012
+
+LGPL License Terms @ref lgpl_license
*/
/*
diff --git a/lib/stm32/f4/i2c.c b/lib/stm32/f4/i2c.c
index 3250faa..ac6f117 100644
--- a/lib/stm32/f4/i2c.c
+++ b/lib/stm32/f4/i2c.c
@@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32F4xx I2C</b>
+@version 1.0.0
+
+@date 15 October 2012
+
+LGPL License Terms @ref lgpl_license
*/
/*
diff --git a/lib/stm32/f4/iwdg.c b/lib/stm32/f4/iwdg.c
index 9332fc4..67985d6 100644
--- a/lib/stm32/f4/iwdg.c
+++ b/lib/stm32/f4/iwdg.c
@@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32F4xx Independent Watchdog Timer</b>
+@version 1.0.0
+
+@date 18 August 2012
+
+LGPL License Terms @ref lgpl_license
*/
/*
diff --git a/lib/stm32/f4/pwr.c b/lib/stm32/f4/pwr.c
index 7be34f4..e492192 100644
--- a/lib/stm32/f4/pwr.c
+++ b/lib/stm32/f4/pwr.c
@@ -1,3 +1,20 @@
+/** @defgroup pwr-file PWR
+
+@ingroup STM32F4xx
+
+@brief <b>libopencm3 STM32F4xx Power Control</b>
+
+@version 1.0.0
+
+@author @htmlonly &copy; @endhtmlonly 2011 Stephen Caudle <scaudle@doceme.com>
+
+@date 4 March 2013
+
+This library supports the power control system for the
+STM32F4 series of ARM Cortex Microcontrollers by ST Microelectronics.
+
+LGPL License Terms @ref lgpl_license
+*/
/*
* This file is part of the libopencm3 project.
*
@@ -17,7 +34,7 @@
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
-#include <libopencm3/stm32/f4/pwr.h>
+#include <libopencm3/stm32/pwr.h>
void pwr_set_vos_scale(vos_scale_t scale)
{
diff --git a/lib/stm32/f4/rtc.c b/lib/stm32/f4/rtc.c
index 7e1b5ff..77f5631 100644
--- a/lib/stm32/f4/rtc.c
+++ b/lib/stm32/f4/rtc.c
@@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32F4xx RTC</b>
+@version 1.0.0
+
+@date 4 March 2013
+
+LGPL License Terms @ref lgpl_license
*/
/*
diff --git a/lib/stm32/f4/spi.c b/lib/stm32/f4/spi.c
index 40f5501..050d823 100644
--- a/lib/stm32/f4/spi.c
+++ b/lib/stm32/f4/spi.c
@@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32F4xx SPI</b>
+@version 1.0.0
+
+@date 15 October 2012
+
+LGPL License Terms @ref lgpl_license
*/
/*
diff --git a/lib/stm32/f4/usart.c b/lib/stm32/f4/usart.c
index e0f7be8..201ff5d 100644
--- a/lib/stm32/f4/usart.c
+++ b/lib/stm32/f4/usart.c
@@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32F4xx USART</b>
+@version 1.0.0
+
+@date 30 August 2012
+
+LGPL License Terms @ref lgpl_license
*/
/*
diff --git a/lib/stm32/l1/crc.c b/lib/stm32/l1/crc.c
index 7d51341..b85ecd5 100644
--- a/lib/stm32/l1/crc.c
+++ b/lib/stm32/l1/crc.c
@@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32L1xx CRC</b>
+@version 1.0.0
+
+@date 15 October 2012
+
+LGPL License Terms @ref lgpl_license
*/
/*
diff --git a/lib/stm32/l1/dac.c b/lib/stm32/l1/dac.c
index 534f9f1..b20457c 100644
--- a/lib/stm32/l1/dac.c
+++ b/lib/stm32/l1/dac.c
@@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32L1xx DAC</b>
+@version 1.0.0
+
+@date 18 August 2012
+
+LGPL License Terms @ref lgpl_license
*/
/*
diff --git a/lib/stm32/l1/gpio.c b/lib/stm32/l1/gpio.c
index 7fc2012..fd42ba8 100644
--- a/lib/stm32/l1/gpio.c
+++ b/lib/stm32/l1/gpio.c
@@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32L1xx General Purpose I/O</b>
+@version 1.0.0
+
+@date 18 August 2012
+
+LGPL License Terms @ref lgpl_license
*/
/*
diff --git a/lib/stm32/l1/i2c.c b/lib/stm32/l1/i2c.c
index 7a6fe84..00e9fa9 100644
--- a/lib/stm32/l1/i2c.c
+++ b/lib/stm32/l1/i2c.c
@@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32L1xx I2C</b>
+@version 1.0.0
+
+@date 15 October 2012
+
+LGPL License Terms @ref lgpl_license
*/
/*
diff --git a/lib/stm32/l1/iwdg.c b/lib/stm32/l1/iwdg.c
index 05ddf04..b0b9593 100644
--- a/lib/stm32/l1/iwdg.c
+++ b/lib/stm32/l1/iwdg.c
@@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32L1xx Independent Watchdog Timer</b>
+@version 1.0.0
+
+@date 18 August 2012
+
+LGPL License Terms @ref lgpl_license
*/
/*
diff --git a/lib/stm32/l1/pwr.c b/lib/stm32/l1/pwr.c
index 8541851..e712899 100644
--- a/lib/stm32/l1/pwr.c
+++ b/lib/stm32/l1/pwr.c
@@ -1,3 +1,20 @@
+/** @defgroup pwr-file PWR
+
+@ingroup STM32L1xx
+
+@brief <b>libopencm3 STM32L1xx Power Control</b>
+
+@version 1.0.0
+
+@author @htmlonly &copy; @endhtmlonly 2012 Karl Palsson <karlp@tweak.net.au>
+
+@date 4 March 2013
+
+This library supports the power control system for the
+STM32L1 series of ARM Cortex Microcontrollers by ST Microelectronics.
+
+LGPL License Terms @ref lgpl_license
+*/
/*
* This file is part of the libopencm3 project.
*
diff --git a/lib/stm32/l1/rtc.c b/lib/stm32/l1/rtc.c
index bc7f87f..1afd597 100644
--- a/lib/stm32/l1/rtc.c
+++ b/lib/stm32/l1/rtc.c
@@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32L1xx RTC</b>
+@version 1.0.0
+
+@date 4 March 2013
+
+LGPL License Terms @ref lgpl_license
*/
/*
diff --git a/lib/stm32/l1/spi.c b/lib/stm32/l1/spi.c
index 30c44dd..c6887dc 100644
--- a/lib/stm32/l1/spi.c
+++ b/lib/stm32/l1/spi.c
@@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32L1xx SPI</b>
+@version 1.0.0
+
+@date 15 October 2012
+
+LGPL License Terms @ref lgpl_license
*/
/*
diff --git a/lib/stm32/l1/usart.c b/lib/stm32/l1/usart.c
index 67fd674..3dc55c2 100644
--- a/lib/stm32/l1/usart.c
+++ b/lib/stm32/l1/usart.c
@@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32L1xx USART</b>
+@version 1.0.0
+
+@date 30 August 2012
+
+LGPL License Terms @ref lgpl_license
*/
/*