aboutsummaryrefslogtreecommitdiff
path: root/include/libopencm3/stm32/common
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/common
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/common')
-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
15 files changed, 82 insertions, 16 deletions
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.
*