[Doxygen] Add complete documentation page to STM32F0

This commit is contained in:
BuFran
2013-07-22 17:55:03 +02:00
committed by Piotr Esden-Tempski
parent 4ff19fa2b4
commit 81982916e2
45 changed files with 813 additions and 11 deletions

View File

@@ -1,3 +1,16 @@
/** @defgroup adc_defines ADC Defines
*
* @brief <b>Defined Constants and Types for the STM32F0xx Analog to Digital
* Converter</b>
*
* @ingroup STM32F0xx_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,15 @@
/** @defgroup CEC_defines CEC Defines
*
* @brief <b>Defined Constants and Types for the STM32F0xx HDMI-CEC</b>
*
* @ingroup STM32F0xx_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 dac_defines DAC Defines
*
* @brief <b>Defined Constants and Types for the STM32F0xx Digital to Analog
* Converter</b>
*
* @ingroup STM32F0xx_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 dma_defines DMA Defines
*
* @ingroup STM32F1xx_defines
* @ingroup STM32F0xx_defines
*
* @brief Defined Constants and Types for the STM32F1xx DMA Controller
* @brief Defined Constants and Types for the STM32F0xx DMA Controller
*
* @version 1.0.0
*

View File

@@ -0,0 +1,32 @@
/** @mainpage libopencm3 STM32F0
*
* @version 1.0.0
*
* @date 11 July 2013
*
* API documentation for ST Microelectronics STM32F0 Cortex M0 series.
*
* LGPL License Terms @ref lgpl_license
*/
/** @defgroup STM32F0xx STM32F0xx
* Libraries for ST Microelectronics STM32F0xx series.
*
* @version 1.0.0
*
* @date 11 July 2013
*
* LGPL License Terms @ref lgpl_license
*/
/** @defgroup STM32F0xx_defines STM32F0xx Defines
*
* @brief Defined Constants and Types for the STM32F0xx 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 STM32F0xx External Interrupts
* </b>
*
* @ingroup STM32F0xx_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,15 @@
/** @defgroup flash_defines FLASH Defines
*
* @brief <b>Defined Constants and Types for the STM32F0xx Flash memory</b>
*
* @ingroup STM32F0xx_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,15 @@
/** @defgroup i2c_defines I2C Defines
*
* @brief <b>Defined Constants and Types for the STM32F0xx I2C</b>
*
* @ingroup STM32F0xx_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 pwr_defines PWR Defines
*
* @brief <b>Defined Constants and Types for the STM32F1xx PWR Control</b>
* @brief <b>Defined Constants and Types for the STM32F0xx PWR Control</b>
*
* @ingroup STM32F1xx_defines
* @ingroup STM32F0xx_defines
*
* @version 1.0.0
*

View File

@@ -1,4 +1,4 @@
/** @defgroup STM32F0xx_rcc_defines RCC Defines
/** @defgroup rcc_defines RCC Defines
*
* @brief <b>libopencm3 STM32F0xx Reset and Clock Control</b>
*

View File

@@ -1,3 +1,15 @@
/** @defgroup syscfg_defines SYSCFG Defines
*
* @brief <b>Defined Constants and Types for the STM32F0xx System Config</b>
*
* @ingroup STM32F0xx_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

@@ -0,0 +1,32 @@
/** @defgroup timer_defines Timers Defines
*
* @brief <b>Defined Constants and Types for the STM32F0xx Timers</b>
*
* @ingroup STM32F0xx_defines
*
* @version 1.0.0
*
* @date 11 July 2013
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
* Copyright (C) 2013 Frantisek Burian <BuFran@seznam.cz>
*
* This library 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.
*
* This library 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 library. If not, see <http://www.gnu.org/licenses/>.
*/

View File

@@ -1,3 +1,15 @@
/** @defgroup tsc_defines TSC Defines
*
* @brief <b>Defined Constants and Types for the STM32F0xx Touch Sensor</b>
*
* @ingroup STM32F0xx_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

@@ -18,8 +18,9 @@
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
#if defined(STM32F1)
#if defined(STM32F0)
# include <libopencm3/stm32/f0/timer.h>
#elif defined(STM32F1)
# include <libopencm3/stm32/f1/timer.h>
#elif defined(STM32F2)
# include <libopencm3/stm32/f2/timer.h>