aboutsummaryrefslogtreecommitdiff
path: root/include/libopencm3/cm3
diff options
context:
space:
mode:
authorUwe Hermann2011-11-11 21:17:48 +0100
committerUwe Hermann2011-11-11 21:23:30 +0100
commit23a6f154cd6594ce94dfbf1e30affacc0150cc39 (patch)
treee0bd5e05551e5c65043329595c1394da1f31a292 /include/libopencm3/cm3
parentef908e0725c447d749dcf6ca40cb8819dfc41559 (diff)
common.h: Add Doxygen main page text.
Diffstat (limited to 'include/libopencm3/cm3')
-rw-r--r--include/libopencm3/cm3/common.h16
1 files changed, 16 insertions, 0 deletions
diff --git a/include/libopencm3/cm3/common.h b/include/libopencm3/cm3/common.h
index 08f553f..8cd64f2 100644
--- a/include/libopencm3/cm3/common.h
+++ b/include/libopencm3/cm3/common.h
@@ -38,4 +38,20 @@ 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