[STM32F3:doc] Add doxygen documentation page to output

This commit is contained in:
BuFran
2013-07-11 19:21:31 +02:00
committed by Piotr Esden-Tempski
parent f797c50b6a
commit d63bf5ac64
24 changed files with 566 additions and 13 deletions

View File

@@ -1,3 +1,16 @@
/** @defgroup adc_defines ADC Defines
*
* @brief <b>Defined Constants and Types for the STM32F3xx Analog to Digital
* converter</b>
*
* @ingroup STM32F3xx_defines
*
* @version 1.0.0
*
* @date 11 July 2013
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
@@ -485,7 +498,7 @@
/****************************************************************************/
/* ADC_SMPR1 ADC Sample Time Selection for Channels */
/** @defgroup adc_sample_r1 ADC Sample Time Selection for ADC1
@ingroup STM32F4xx_adc_defines
@ingroup adc_defines
@{*/
#define ADC_SMPR1_SMP_1DOT5CYC 0x0

View File

@@ -1,7 +1,6 @@
/** @defgroup crc_defines CRC Defines
*
* @brief <b>libopencm3 Defined Constants and Types for the STM32F3xx CRC
* Generator </b>
* @brief <b>Defined Constants and Types for the STM32F3xx CRC Generator </b>
*
* @ingroup STM32F3xx_defines
*

View File

@@ -2,7 +2,7 @@
*
* @ingroup STM32F3xx_defines
*
* @brief Defined Constants and Types for the STM32F3xx DMA Controller
* @brief <b>Defined Constants and Types for the STM32F3xx DMA Controller</b>
*
* @version 1.0.0
*

View File

@@ -0,0 +1,32 @@
/** @mainpage libopencm3 STM32F3
*
* @version 1.0.0
*
* @date 11 July 2013
*
* API documentation for ST Microelectronics STM32F3 Cortex M3 series.
*
* LGPL License Terms @ref lgpl_license
*/
/** @defgroup STM32F3xx STM32F3xx
* Libraries for ST Microelectronics STM32F3xx series.
*
* @version 1.0.0
*
* @date 11 July 2013
*
* LGPL License Terms @ref lgpl_license
*/
/** @defgroup STM32F3xx_defines STM32F3xx Defines
*
* @brief Defined Constants and Types for the STM32F3xx series
*
* @version 1.0.0
*
* @date 11 July 2013
*
* LGPL License Terms @ref lgpl_license
*/

View File

@@ -1,3 +1,16 @@
/** @defgroup exti_defines EXTI Defines
*
* @brief <b>Defined Constants and Types for the STM32F3xx External Interrupts
* </b>
*
* @ingroup STM32F3xx_defines
*
* @version 1.0.0
*
* @date 11 July 2013
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*

View File

@@ -1,3 +1,16 @@
/** @defgroup flash_defines FLASH Defines
*
* @brief <b>Defined Constants and Types for the STM32F3xx Flash
* controller </b>
*
* @ingroup STM32F3xx_defines
*
* @version 1.0.0
*
* @date 11 July 2013
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*

View File

@@ -1,8 +1,8 @@
/** @defgroup i2c_defines I2C Defines
*
* @brief <b>Defined Constants and Types for the STM32F4xx I2C </b>
* @brief <b>Defined Constants and Types for the STM32F3xx I2C </b>
*
* @ingroup STM32F4xx_defines
* @ingroup STM32F3xx_defines
*
* @version 1.0.0
*

View File

@@ -1,3 +1,15 @@
/** @defgroup pwr_defines PWR Defines
*
* @brief <b>Defined Constants and Types for the STM32F3xx Power control </b>
*
* @ingroup STM32F3xx_defines
*
* @version 1.0.0
*
* @date 11 July 2013
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*

View File

@@ -1,3 +1,16 @@
/** @defgroup rcc_defines RCC Defines
*
* @brief <b>Defined Constants and Types for the STM32F3xx Reset and Clock
* control</b>
*
* @ingroup STM32F3xx_defines
*
* @version 1.0.0
*
* @date 11 July 2013
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*

View File

@@ -1,6 +1,6 @@
/** @defgroup timer_defines Timer Defines
*
* @brief <b>libopencm3 Defined Constants and Types for the STM32F3xx Timers</b>
* @brief <b>Defined Constants and Types for the STM32F3xx Timers</b>
*
* @ingroup STM32F3xx_defines
*