aboutsummaryrefslogtreecommitdiff
path: root/include/libopencm3/cm3/docmain.h
diff options
context:
space:
mode:
authorKen Sarkies2012-08-20 17:19:20 +0930
committerKen Sarkies2012-08-20 17:19:20 +0930
commit52533a6e3d2e3a1936ce76692774557a354d3569 (patch)
tree6f6670d0e80882175befff2e3aa0da7e279f8595 /include/libopencm3/cm3/docmain.h
parenta2c5b6391d82684838e923c6d7437367110f5480 (diff)
STM32F1xx: Changed markup to get more control over documentation, each
file having its own group module rather than using @file. No code changes except for the following: gpio: Added function to map the eventout signal plus two Remap functions dma: Prevent changing base addresses while channel enabled (see datasheet) pwr: Added pwr.c (new file) timer: Removed the last function that I introduced recently; there is already an equivalent function present. Changed some parameter names for consistency.
Diffstat (limited to 'include/libopencm3/cm3/docmain.h')
-rw-r--r--include/libopencm3/cm3/docmain.h22
1 files changed, 14 insertions, 8 deletions
diff --git a/include/libopencm3/cm3/docmain.h b/include/libopencm3/cm3/docmain.h
index 865b6ea..9407ceb 100644
--- a/include/libopencm3/cm3/docmain.h
+++ b/include/libopencm3/cm3/docmain.h
@@ -1,6 +1,12 @@
/**
* @mainpage libopencm3 Developer Documentation
- *
+
+@version 1.0.0
+
+@author @htmlonly © @endhtmlonly 2012 Ken Sarkies ksarkies@internode.on.net
+
+@date 18 August 2012
+
* The libopencm3 project (previously known as libopenstm32) aims to create
* a free/libre/open-source (GPL v3, or later) firmware library for various
* ARM Cortex-M3 microcontrollers, including ST STM32, Toshiba TX03,
@@ -31,33 +37,33 @@ program. If not, see <http://www.gnu.org/licenses/>.
*/
-/** @defgroup LM3S
+/** @defgroup LM3S LM3S
Libraries for Texas instruments LM3S series.
*/
-/** @defgroup LPC13xx
+/** @defgroup LPC13xx LPC13xx
Libraries for NXP Semiconductor LPC13xx series.
*/
-/** @defgroup LPC17xx
+/** @defgroup LPC17xx LPC17xx
Libraries for NXP Semiconductor LPC17xx series.
*/
-/** @defgroup STM32F
+/** @defgroup STM32F STM32F
Libraries for ST Microelectronics STM32F series.
*/
-/** @defgroup STM32F1xx
+/** @defgroup STM32F1xx STM32F1xx
@ingroup STM32F
Libraries for ST Microelectronics STM32F1xx series.
*/
-/** @defgroup STM32F2xx
+/** @defgroup STM32F2xx STM32F2xx
@ingroup STM32F
Libraries for ST Microelectronics STM32F2xx series.
*/
-/** @defgroup STM32F4xx
+/** @defgroup STM32F4xx STM32F4xx
@ingroup STM32F
Libraries for ST Microelectronics STM32F4xx series.
*/