From 23a6f154cd6594ce94dfbf1e30affacc0150cc39 Mon Sep 17 00:00:00 2001 From: Uwe Hermann Date: Fri, 11 Nov 2011 21:17:48 +0100 Subject: [PATCH] common.h: Add Doxygen main page text. --- include/libopencm3/cm3/common.h | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/include/libopencm3/cm3/common.h b/include/libopencm3/cm3/common.h index 08f553ff..8cd64f27 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 libopencm3 wiki for + * more information. + */ + #endif