aboutsummaryrefslogtreecommitdiff
path: root/include/libopencm3/stm32/f1
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/f1
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/f1')
-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
11 files changed, 16 insertions, 24 deletions
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