[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,4 +1,4 @@
/** @addtogroup pwr-file PWR
/** @addtogroup pwr_file PWR
@author @htmlonly © @endhtmlonly 2012
Ken Sarkies <ksarkies@internode.on.net>

View File

@@ -1,8 +1,8 @@
/** @defgroup STM32F4xx_adc_file ADC
/** @defgroup adc_file ADC
*
* @ingroup STM32F4xx
* @ingroup STM32F3xx
*
* @brief <b>libopencm3 STM32F4xx Analog to Digital Converters</b>
* @brief <b>libopencm3 STM32F3xx Analog to Digital Converters</b>
*
* @author @htmlonly &copy; @endhtmlonly 2012
* Ken Sarkies <ksarkies@internode.on.net>
@@ -41,7 +41,7 @@
* separately from the regular group. An interrupt can be set to occur at the
* end of conversion, which occurs after all channels have been scanned.
*
* @section adc_f4_api_ex Basic ADC Handling API.
* @section adc_f3_api_ex Basic ADC Handling API.
*
* Example 1: Simple single channel conversion polled. Enable the peripheral
* clock and ADC, reset ADC and set the prescaler divider. Set multiple mode to

View File

@@ -29,6 +29,5 @@
*/
#include <libopencm3/stm32/crc.h>
#include <libopencm3/stm32/common/crc_common_all.h>

View File

@@ -2,11 +2,19 @@
*
* @ingroup STM32F3xx
*
<<<<<<< HEAD
* @brief <b>libopencm3 STM32F3xx DMA</b>
*
* @version 1.0.0
*
* @date 10 July 2013
=======
* @brief <b>libopencm3 STM32F3xx Direct Memory Access</b>
*
* @version 1.0.0
*
* @date 11 July 2013
>>>>>>> feadf1f... [STM32F3:doc] Add doxygen documentation page to output
*
* LGPL License Terms @ref lgpl_license
*/

View File

@@ -1,3 +1,15 @@
/** @defgroup flash_file FLASH
*
* @ingroup STM32F3xx
*
* @brief <b>libopencm3 STM32F3xx FLASH</b>
*
* @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 gpio_file GPIO
*
* @ingroup STM32F3xx
*
* @brief <b>libopencm3 STM32F3xx General Purpose I/O</b>
*
* @version 1.0.0
*
* @date 11 July 2013
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*

33
lib/stm32/f3/pwr.c Normal file
View File

@@ -0,0 +1,33 @@
/** @defgroup pwr_file PWR
*
* @ingroup STM32F3xx
*
* @brief <b>libopencm3 STM32F3xx Power control</b>
*
* @version 1.0.0
*
* @date 11 July 2013
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
* 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/>.
*/
#include <libopencm3/stm32/pwr.h>

View File

@@ -1,3 +1,15 @@
/** @defgroup rcc_file RCC
*
* @ingroup STM32F3xx
*
* @brief <b>libopencm3 STM32F3xx Reset and Clock Control</b>
*
* @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 spi_file SPI
*
* @ingroup STM32F3xx
*
* @brief <b>libopencm3 STM32F3xx Serial Peripheral Interface</b>
*
* @version 1.0.0
*
* @date 11 July 2013
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*

33
lib/stm32/f3/timer.c Normal file
View File

@@ -0,0 +1,33 @@
/** @defgroup timer_file TIMER
*
* @ingroup STM32F3xx
*
* @brief <b>libopencm3 STM32F3xx Timers</b>
*
* @version 1.0.0
*
* @date 11 July 2013
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
* 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/>.
*/
#include <libopencm3/stm32/timer.h>