aboutsummaryrefslogtreecommitdiff
path: root/include/libopencm3/cm3
diff options
context:
space:
mode:
authorKen Sarkies2012-05-28 21:38:55 +0930
committerKen Sarkies2012-05-28 21:38:55 +0930
commit06620040aacdc0e88ee2fcc3cfa379ceea2032a9 (patch)
tree422e133f6a0410c174924d14786370358653fcce /include/libopencm3/cm3
parent7011d47c70076f995e8470c59eeaa8f3efcc9f05 (diff)
Header files for Doxygen group structure, layout changes to headings, example markup in stm32f1/ rcc
Diffstat (limited to 'include/libopencm3/cm3')
-rw-r--r--include/libopencm3/cm3/common.h16
-rw-r--r--include/libopencm3/cm3/docmain.h64
2 files changed, 64 insertions, 16 deletions
diff --git a/include/libopencm3/cm3/common.h b/include/libopencm3/cm3/common.h
index dc3e433..0610258 100644
--- a/include/libopencm3/cm3/common.h
+++ b/include/libopencm3/cm3/common.h
@@ -38,20 +38,4 @@ typedef uint64_t u64;
#define MMIO32(addr) (*(volatile u32 *)(addr))
#define MMIO64(addr) (*(volatile u64 *)(addr))
-/* Main page for the doxygen-generated documentation: */
-
-/**
- * @mainpage libopencm3 Developer Documentation
- *
- * 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,
- * Atmel SAM3U, NXP LPC1000 and others.
- *
- * @par ""
- *
- * See the <a href="http://www.libopencm3.org">libopencm3 wiki</a> for
- * more information.
- */
-
#endif
diff --git a/include/libopencm3/cm3/docmain.h b/include/libopencm3/cm3/docmain.h
new file mode 100644
index 0000000..865b6ea
--- /dev/null
+++ b/include/libopencm3/cm3/docmain.h
@@ -0,0 +1,64 @@
+/**
+ * @mainpage libopencm3 Developer Documentation
+ *
+ * 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,
+ * Atmel SAM3U, NXP LPC1000 and others.
+ *
+ * @par ""
+ *
+ * See the <a href="http://www.libopencm3.org">libopencm3 wiki</a> for
+ * more information.
+
+LGPL License Terms @ref lgpl_license
+
+*/
+
+/** @page lgpl_license libopencm3 License
+
+libopencm3 is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by the Free
+Software Foundation, either version 3 of the License, or (at your option) any
+later version.
+
+libopencm3 is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License along with this
+program. If not, see <http://www.gnu.org/licenses/>.
+
+*/
+
+/** @defgroup LM3S
+Libraries for Texas instruments LM3S series.
+*/
+
+/** @defgroup LPC13xx
+Libraries for NXP Semiconductor LPC13xx series.
+*/
+
+/** @defgroup LPC17xx
+Libraries for NXP Semiconductor LPC17xx series.
+*/
+
+/** @defgroup STM32F
+Libraries for ST Microelectronics STM32F series.
+*/
+
+/** @defgroup STM32F1xx
+@ingroup STM32F
+Libraries for ST Microelectronics STM32F1xx series.
+*/
+
+/** @defgroup STM32F2xx
+@ingroup STM32F
+Libraries for ST Microelectronics STM32F2xx series.
+*/
+
+/** @defgroup STM32F4xx
+@ingroup STM32F
+Libraries for ST Microelectronics STM32F4xx series.
+*/
+