From ff83a1ae1c0764aff11d8cd50f1f0f8a27ea4757 Mon Sep 17 00:00:00 2001 From: Ken Sarkies Date: Sat, 15 Sep 2012 12:51:46 +0930 Subject: Setup to document entire project using doxygen. New doc directory with config files and generated html, LaTeX/pdf. Makefile provided for autogeneration and explanatory README. The project structure is hostile to doxygen, which can't cope with functions of the same name. Doxygen is run for each family separately, and separately for LaTeX generation. Customized layout files sort of "integrate" HTML, and separate pdfs are generated for each family. Not ideal but seems the best solution until doxygen changes, if at all. --- include/libopencm3/docmain.dox | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 include/libopencm3/docmain.dox (limited to 'include/libopencm3/docmain.dox') diff --git a/include/libopencm3/docmain.dox b/include/libopencm3/docmain.dox new file mode 100644 index 0000000..f85aeb8 --- /dev/null +++ b/include/libopencm3/docmain.dox @@ -0,0 +1,21 @@ +/** @mainpage libopencm3 Developer Documentation + +@version 1.0.0 + +@date 7 September 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, + * Atmel SAM3U, NXP LPC1000 and others. + * + * @par "" + * + * See the libopencm3 wiki for + * more information. + +LGPL License Terms @ref lgpl_license +*/ + + + -- cgit v1.2.3