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.
This commit is contained in:
Ken Sarkies
2012-09-15 12:51:46 +09:30
parent dcd98dde86
commit ff83a1ae1c
51 changed files with 3330 additions and 208 deletions
+22
View File
@@ -0,0 +1,22 @@
/** @mainpage libopencm3 Core CM3
@version 1.0.0
@date 14 September 2012
API documentation for Cortex M3 core features.
LGPL License Terms @ref lgpl_license
*/
/** @defgroup CM3_defines CM3 Defines
@brief Defined Constants and Types for Cortex M3 core features
@version 1.0.0
@date 14 September 2012
LGPL License Terms @ref lgpl_license
*/
-70
View File
@@ -1,70 +0,0 @@
/**
* @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,
* 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 LM3S
Libraries for Texas instruments LM3S series.
*/
/** @defgroup LPC13xx LPC13xx
Libraries for NXP Semiconductor LPC13xx series.
*/
/** @defgroup LPC17xx LPC17xx
Libraries for NXP Semiconductor LPC17xx series.
*/
/** @defgroup STM32F STM32F
Libraries for ST Microelectronics STM32F series.
*/
/** @defgroup STM32F1xx STM32F1xx
@ingroup STM32F
Libraries for ST Microelectronics STM32F1xx series.
*/
/** @defgroup STM32F2xx STM32F2xx
@ingroup STM32F
Libraries for ST Microelectronics STM32F2xx series.
*/
/** @defgroup STM32F4xx STM32F4xx
@ingroup STM32F
Libraries for ST Microelectronics STM32F4xx series.
*/