Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/thirdpin/libopencm3.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBuFran <BuFran@seznam.cz>2013-07-11 21:21:31 +0400
committerPiotr Esden-Tempski <piotr@esden.net>2013-08-23 10:08:52 +0400
commitd63bf5ac640d78bcf547aac7059d0989ec3ff077 (patch)
tree1dba65f1534951ececf81cc3fcf20ce6c17a144d
parentf797c50b6a7f645974a628926099e692c94ee9ee (diff)
[STM32F3:doc] Add doxygen documentation page to output
-rw-r--r--doc/stm32f3/Doxyfile36
-rw-r--r--doc/stm32f3/Doxyfile_latex40
-rw-r--r--doc/stm32f3/DoxygenLayout_stm32f3.xml200
-rw-r--r--doc/stm32f3/header_stm32f3.tex61
-rw-r--r--include/libopencm3/stm32/f3/adc.h15
-rw-r--r--include/libopencm3/stm32/f3/crc.h3
-rw-r--r--include/libopencm3/stm32/f3/dma.h2
-rw-r--r--include/libopencm3/stm32/f3/doc-stm32f3.h32
-rw-r--r--include/libopencm3/stm32/f3/exti.h13
-rw-r--r--include/libopencm3/stm32/f3/flash.h13
-rw-r--r--include/libopencm3/stm32/f3/i2c.h4
-rw-r--r--include/libopencm3/stm32/f3/pwr.h12
-rw-r--r--include/libopencm3/stm32/f3/rcc.h13
-rw-r--r--include/libopencm3/stm32/f3/timer.h2
-rw-r--r--lib/stm32/common/pwr_common_all.c2
-rw-r--r--lib/stm32/f3/adc.c8
-rw-r--r--lib/stm32/f3/crc.c1
-rw-r--r--lib/stm32/f3/dma.c8
-rw-r--r--lib/stm32/f3/flash.c12
-rw-r--r--lib/stm32/f3/gpio.c12
-rw-r--r--lib/stm32/f3/pwr.c33
-rw-r--r--lib/stm32/f3/rcc.c12
-rw-r--r--lib/stm32/f3/spi.c12
-rw-r--r--lib/stm32/f3/timer.c33
24 files changed, 566 insertions, 13 deletions
diff --git a/doc/stm32f3/Doxyfile b/doc/stm32f3/Doxyfile
new file mode 100644
index 00000000..4db5b2cd
--- /dev/null
+++ b/doc/stm32f3/Doxyfile
@@ -0,0 +1,36 @@
+# HTML Documentation for STM32F3 code level
+
+#---------------------------------------------------------------------------
+# Common Include File
+#---------------------------------------------------------------------------
+
+@INCLUDE = ../Doxyfile_common
+
+#---------------------------------------------------------------------------
+# Local settings
+#---------------------------------------------------------------------------
+
+WARN_LOGFILE = doxygen_stm32f3.log
+
+INPUT = ../../include/libopencm3/license.dox \
+ ../../include/libopencm3/stm32/f3 \
+ ../../include/libopencm3/stm32/common
+
+INPUT += ../../lib/stm32/f3 \
+ ../../lib/stm32/common
+
+EXCLUDE = ../../include/libopencm3/stm32/f3/usb.h \
+ ../../include/libopencm3/stm32/f3/usb_desc.h
+
+EXCLUDE_PATTERNS = *_common_f24.h *_common_f24.c
+EXCLUDE_PATTERNS += *_common_f124.h *_common_f124.c
+EXCLUDE_PATTERNS += *_common_l1f24.h *_common_l1f24.c
+EXCLUDE_PATTERNS += *_common_bcd.h *_common_bcd.c
+
+LAYOUT_FILE = DoxygenLayout_stm32f3.xml
+
+TAGFILES = ../cm3/cm3.tag=../../cm3/html
+
+GENERATE_TAGFILE = stm32f3.tag
+
+ENABLE_PREPROCESSING = YES
diff --git a/doc/stm32f3/Doxyfile_latex b/doc/stm32f3/Doxyfile_latex
new file mode 100644
index 00000000..a9dc0f6e
--- /dev/null
+++ b/doc/stm32f3/Doxyfile_latex
@@ -0,0 +1,40 @@
+# LaTeX Documentation for STM32F3 code level
+
+# 14 September 2012
+# (C) Ken Sarkies <ksarkies@internode.on.net>
+
+#---------------------------------------------------------------------------
+# Common Include File
+#---------------------------------------------------------------------------
+
+@INCLUDE = ../Doxyfile_common
+
+#---------------------------------------------------------------------------
+# Local settings
+#---------------------------------------------------------------------------
+
+WARN_LOGFILE = doxygen_stm32f3_latex.log
+
+INPUT = ../../include/libopencm3/docmain.dox \
+ ../../include/libopencm3/license.dox \
+ ../../include/libopencm3/stm32/f3 \
+ ../../include/libopencm3/stm32/common
+
+INPUT += ../../lib/stm32/f3 \
+ ../../lib/stm32/common
+
+EXCLUDE = ../../include/libopencm3/stm32/f3/doc-stm32f3.h \
+ ../../include/libopencm3/stm32/f3/usb.h \
+ ../../include/libopencm3/stm32/f3/usb_desc.h \
+ ../../include/libopencm3/stm32/f3/nvic_f3.h
+
+EXCLUDE_PATTERNS = *_common_f24.h *_common_f24.c
+
+LAYOUT_FILE = DoxygenLayout_stm32f1.xml
+
+GENERATE_HTML = NO
+
+GENERATE_LATEX = YES
+
+LATEX_HEADER = header_stm32f3.tex
+
diff --git a/doc/stm32f3/DoxygenLayout_stm32f3.xml b/doc/stm32f3/DoxygenLayout_stm32f3.xml
new file mode 100644
index 00000000..3bf1a5b7
--- /dev/null
+++ b/doc/stm32f3/DoxygenLayout_stm32f3.xml
@@ -0,0 +1,200 @@
+<doxygenlayout version="1.0">
+ <!-- Navigation index tabs for HTML output -->
+ <navindex>
+ <tab type="mainpage" visible="yes" title="libopencm3"/>
+ <tab type="pages" visible="yes" title="General Information" intro=""/>
+ <tab type="user" visible="yes" url="../../html/index.html" title="Back to Top" intro=""/>
+ <tab type="user" visible="yes" url="../../cm3/html/modules.html" title="CM3 Core" intro=""/>
+ <tab type="user" visible="yes" url="../../usb/html/modules.html" title="Generic USB" intro=""/>
+ <tab type="user" visible="yes" url="../../stm32f1/html/modules.html" title="STM32F1" intro=""/>
+ <tab type="user" visible="yes" url="../../stm32f2/html/modules.html" title="STM32F2" intro=""/>
+ <tab type="modules" visible="yes" title="STM32F3" intro=""/>
+ <tab type="user" visible="yes" url="../../stm32f4/html/modules.html" title="STM32F4" intro=""/>
+ <tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/>
+ <tab type="user" visible="yes" url="../../lm3s/html/modules.html" title="LM3S" intro=""/>
+ <tab type="user" visible="yes" url="../../lm4f/html/modules.html" title="LM4F" intro=""/>
+ <tab type="user" visible="yes" url="../../lpc13xx/html/modules.html" title="LPC13" intro=""/>
+ <tab type="user" visible="yes" url="../../lpc17xx/html/modules.html" title="LPC17" intro=""/>
+ <tab type="user" visible="yes" url="../../lpc43xx/html/modules.html" title="LPC43" intro=""/>
+ <tab type="user" visible="yes" url="../../emf32g/html/modules.html" title="EMF32 Gecko" intro=""/>
+ <tab type="user" visible="yes" url="../../emf32gg/html/modules.html" title="EMF32 Giant Gecko" intro=""/>
+ <tab type="user" visible="yes" url="../../emf32lg/html/modules.html" title="EMF32 Leopard Gecko" intro=""/>
+ <tab type="user" visible="yes" url="../../emf32tg/html/modules.html" title="EMF32 Tiny Gecko" intro=""/>
+ <tab type="namespaces" visible="yes" title="">
+ <tab type="namespaces" visible="yes" title="" intro=""/>
+ <tab type="namespacemembers" visible="yes" title="" intro=""/>
+ </tab>
+ <tab type="classes" visible="yes" title="">
+ <tab type="classes" visible="yes" title="" intro=""/>
+ <tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/>
+ <tab type="hierarchy" visible="yes" title="" intro=""/>
+ <tab type="classmembers" visible="yes" title="" intro=""/>
+ </tab>
+ <tab type="files" visible="yes" title="">
+ <tab type="files" visible="yes" title="" intro=""/>
+ <tab type="globals" visible="yes" title="" intro=""/>
+ </tab>
+ <tab type="examples" visible="yes" title="" intro=""/>
+ </navindex>
+
+ <!-- Layout definition for a class page -->
+ <class>
+ <briefdescription visible="yes"/>
+ <includes visible="$SHOW_INCLUDE_FILES"/>
+ <inheritancegraph visible="$CLASS_GRAPH"/>
+ <collaborationgraph visible="$COLLABORATION_GRAPH"/>
+ <allmemberslink visible="yes"/>
+ <memberdecl>
+ <nestedclasses visible="yes" title=""/>
+ <publictypes title=""/>
+ <publicslots title=""/>
+ <signals title=""/>
+ <publicmethods title=""/>
+ <publicstaticmethods title=""/>
+ <publicattributes title=""/>
+ <publicstaticattributes title=""/>
+ <protectedtypes title=""/>
+ <protectedslots title=""/>
+ <protectedmethods title=""/>
+ <protectedstaticmethods title=""/>
+ <protectedattributes title=""/>
+ <protectedstaticattributes title=""/>
+ <packagetypes title=""/>
+ <packagemethods title=""/>
+ <packagestaticmethods title=""/>
+ <packageattributes title=""/>
+ <packagestaticattributes title=""/>
+ <properties title=""/>
+ <events title=""/>
+ <privatetypes title=""/>
+ <privateslots title=""/>
+ <privatemethods title=""/>
+ <privatestaticmethods title=""/>
+ <privateattributes title=""/>
+ <privatestaticattributes title=""/>
+ <friends title=""/>
+ <related title="" subtitle=""/>
+ <membergroups visible="yes"/>
+ </memberdecl>
+ <detaileddescription title=""/>
+ <memberdef>
+ <typedefs title=""/>
+ <enums title=""/>
+ <constructors title=""/>
+ <functions title=""/>
+ <related title=""/>
+ <variables title=""/>
+ <properties title=""/>
+ <events title=""/>
+ </memberdef>
+ <usedfiles visible="$SHOW_USED_FILES"/>
+ <authorsection visible="yes"/>
+ </class>
+
+ <!-- Layout definition for a namespace page -->
+ <namespace>
+ <briefdescription visible="yes"/>
+ <memberdecl>
+ <nestednamespaces visible="yes" title=""/>
+ <classes visible="yes" title=""/>
+ <typedefs title=""/>
+ <enums title=""/>
+ <functions title=""/>
+ <variables title=""/>
+ <membergroups visible="yes"/>
+ </memberdecl>
+ <detaileddescription title=""/>
+ <memberdef>
+ <typedefs title=""/>
+ <enums title=""/>
+ <functions title=""/>
+ <variables title=""/>
+ </memberdef>
+ <authorsection visible="yes"/>
+ </namespace>
+
+ <!-- Layout definition for a file page -->
+ <file>
+ <briefdescription visible="yes"/>
+ <includes visible="$SHOW_INCLUDE_FILES"/>
+ <includegraph visible="$INCLUDE_GRAPH"/>
+ <includedbygraph visible="$INCLUDED_BY_GRAPH"/>
+ <sourcelink visible="yes"/>
+ <memberdecl>
+ <classes visible="yes" title=""/>
+ <namespaces visible="yes" title=""/>
+ <defines title=""/>
+ <typedefs title=""/>
+ <enums title=""/>
+ <functions title=""/>
+ <variables title=""/>
+ <membergroups visible="yes"/>
+ </memberdecl>
+ <detaileddescription title=""/>
+ <memberdef>
+ <defines title=""/>
+ <typedefs title=""/>
+ <enums title=""/>
+ <functions title=""/>
+ <variables title=""/>
+ </memberdef>
+ <authorsection/>
+ </file>
+
+ <!-- Layout definition for a group page -->
+ <group>
+ <briefdescription visible="yes"/>
+ <groupgraph visible="$GROUP_GRAPHS"/>
+ <memberdecl>
+ <classes visible="yes" title=""/>
+ <namespaces visible="yes" title=""/>
+ <dirs visible="yes" title=""/>
+ <nestedgroups visible="yes" title=""/>
+ <files visible="yes" title=""/>
+ <defines title=""/>
+ <typedefs title=""/>
+ <enums title=""/>
+ <enumvalues title=""/>
+ <functions title=""/>
+ <variables title=""/>
+ <signals title=""/>
+ <publicslots title=""/>
+ <protectedslots title=""/>
+ <privateslots title=""/>
+ <events title=""/>
+ <properties title=""/>
+ <friends title=""/>
+ <membergroups visible="yes"/>
+ </memberdecl>
+ <detaileddescription title=""/>
+ <memberdef>
+ <pagedocs/>
+ <inlineclasses title=""/>
+ <defines title=""/>
+ <typedefs title=""/>
+ <enums title=""/>
+ <enumvalues title=""/>
+ <functions title=""/>
+ <variables title=""/>
+ <signals title=""/>
+ <publicslots title=""/>
+ <protectedslots title=""/>
+ <privateslots title=""/>
+ <events title=""/>
+ <properties title=""/>
+ <friends title=""/>
+ </memberdef>
+ <authorsection visible="yes"/>
+ </group>
+
+ <!-- Layout definition for a directory page -->
+ <directory>
+ <briefdescription visible="yes"/>
+ <directorygraph visible="yes"/>
+ <memberdecl>
+ <dirs visible="yes"/>
+ <files visible="yes"/>
+ </memberdecl>
+ <detaileddescription title=""/>
+ </directory>
+</doxygenlayout>
diff --git a/doc/stm32f3/header_stm32f3.tex b/doc/stm32f3/header_stm32f3.tex
new file mode 100644
index 00000000..0755c0a9
--- /dev/null
+++ b/doc/stm32f3/header_stm32f3.tex
@@ -0,0 +1,61 @@
+\documentclass{book}
+\usepackage[a4paper,top=2.5cm,bottom=2.5cm,left=2.5cm,right=2.5cm]{geometry}
+\usepackage{makeidx}
+\usepackage{natbib}
+\usepackage{graphicx}
+\usepackage{multicol}
+\usepackage{float}
+\usepackage{listings}
+\usepackage{color}
+\usepackage{ifthen}
+\usepackage[table]{xcolor}
+\usepackage{textcomp}
+\usepackage{alltt}
+\usepackage{ifpdf}
+\ifpdf
+\usepackage[pdftex,
+ pagebackref=true,
+ colorlinks=true,
+ linkcolor=blue,
+ unicode
+ ]{hyperref}
+\else
+\usepackage[ps2pdf,
+ pagebackref=true,
+ colorlinks=true,
+ linkcolor=blue,
+ unicode
+ ]{hyperref}
+\usepackage{pspicture}
+\fi
+\usepackage[utf8]{inputenc}
+\usepackage{mathptmx}
+\usepackage[scaled=.90]{helvet}
+\usepackage{courier}
+\usepackage{sectsty}
+\usepackage{amssymb}
+\usepackage[titles]{tocloft}
+\usepackage{doxygen}
+\lstset{language=C++,inputencoding=utf8,basicstyle=\footnotesize,breaklines=true,breakatwhitespace=true,tabsize=4,numbers=left }
+\makeindex
+\setcounter{tocdepth}{3}
+\renewcommand{\footrulewidth}{0.4pt}
+\renewcommand{\familydefault}{\sfdefault}
+\hfuzz=15pt
+\setlength{\emergencystretch}{15pt}
+\hbadness=750
+\tolerance=750
+\begin{document}
+\hypersetup{pageanchor=false,citecolor=blue}
+\begin{titlepage}
+\vspace*{7cm}
+\begin{center}
+{\Huge libopencm3: API Reference\\ STM STM32F3 ARM Cortex M3 Series}\\
+\vspace*{1cm}
+{\large Generated by Doxygen 1.8.2}\\
+\vspace*{0.5cm}
+{\small Thu Sep 13 2012 23:26:45}\\
+\end{center}
+\end{titlepage}
+\pagenumbering{arabic}
+\hypersetup{pageanchor=true,citecolor=blue}
diff --git a/include/libopencm3/stm32/f3/adc.h b/include/libopencm3/stm32/f3/adc.h
index 6bac5acc..cee45519 100644
--- a/include/libopencm3/stm32/f3/adc.h
+++ b/include/libopencm3/stm32/f3/adc.h
@@ -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
diff --git a/include/libopencm3/stm32/f3/crc.h b/include/libopencm3/stm32/f3/crc.h
index 96a56d0c..41359049 100644
--- a/include/libopencm3/stm32/f3/crc.h
+++ b/include/libopencm3/stm32/f3/crc.h
@@ -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
*
diff --git a/include/libopencm3/stm32/f3/dma.h b/include/libopencm3/stm32/f3/dma.h
index 7fe1009a..b1c02809 100644
--- a/include/libopencm3/stm32/f3/dma.h
+++ b/include/libopencm3/stm32/f3/dma.h
@@ -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
*
diff --git a/include/libopencm3/stm32/f3/doc-stm32f3.h b/include/libopencm3/stm32/f3/doc-stm32f3.h
new file mode 100644
index 00000000..5adc4edb
--- /dev/null
+++ b/include/libopencm3/stm32/f3/doc-stm32f3.h
@@ -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
+ */
+
diff --git a/include/libopencm3/stm32/f3/exti.h b/include/libopencm3/stm32/f3/exti.h
index c0b7340a..f9148853 100644
--- a/include/libopencm3/stm32/f3/exti.h
+++ b/include/libopencm3/stm32/f3/exti.h
@@ -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.
*
diff --git a/include/libopencm3/stm32/f3/flash.h b/include/libopencm3/stm32/f3/flash.h
index cbb6ec1c..52698778 100644
--- a/include/libopencm3/stm32/f3/flash.h
+++ b/include/libopencm3/stm32/f3/flash.h
@@ -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.
*
diff --git a/include/libopencm3/stm32/f3/i2c.h b/include/libopencm3/stm32/f3/i2c.h
index 4f91c519..90f263aa 100644
--- a/include/libopencm3/stm32/f3/i2c.h
+++ b/include/libopencm3/stm32/f3/i2c.h
@@ -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
*
diff --git a/include/libopencm3/stm32/f3/pwr.h b/include/libopencm3/stm32/f3/pwr.h
index 35dcea16..7694c25e 100644
--- a/include/libopencm3/stm32/f3/pwr.h
+++ b/include/libopencm3/stm32/f3/pwr.h
@@ -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.
*
diff --git a/include/libopencm3/stm32/f3/rcc.h b/include/libopencm3/stm32/f3/rcc.h
index d034a4b1..608b0560 100644
--- a/include/libopencm3/stm32/f3/rcc.h
+++ b/include/libopencm3/stm32/f3/rcc.h
@@ -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.
*
diff --git a/include/libopencm3/stm32/f3/timer.h b/include/libopencm3/stm32/f3/timer.h
index f8141026..f9284c7e 100644
--- a/include/libopencm3/stm32/f3/timer.h
+++ b/include/libopencm3/stm32/f3/timer.h
@@ -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
*
diff --git a/lib/stm32/common/pwr_common_all.c b/lib/stm32/common/pwr_common_all.c
index bf9442d0..53e6b42a 100644
--- a/lib/stm32/common/pwr_common_all.c
+++ b/lib/stm32/common/pwr_common_all.c
@@ -1,4 +1,4 @@
-/** @addtogroup pwr-file PWR
+/** @addtogroup pwr_file PWR
@author @htmlonly &copy; @endhtmlonly 2012
Ken Sarkies <ksarkies@internode.on.net>
diff --git a/lib/stm32/f3/adc.c b/lib/stm32/f3/adc.c
index d392689b..d0cc7c6d 100644
--- a/lib/stm32/f3/adc.c
+++ b/lib/stm32/f3/adc.c
@@ -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
diff --git a/lib/stm32/f3/crc.c b/lib/stm32/f3/crc.c
index 2c7c6dd4..eb3c14be 100644
--- a/lib/stm32/f3/crc.c
+++ b/lib/stm32/f3/crc.c
@@ -29,6 +29,5 @@
*/
#include <libopencm3/stm32/crc.h>
-#include <libopencm3/stm32/common/crc_common_all.h>
diff --git a/lib/stm32/f3/dma.c b/lib/stm32/f3/dma.c
index fbb0803d..e63c56f5 100644
--- a/lib/stm32/f3/dma.c
+++ b/lib/stm32/f3/dma.c
@@ -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
*/
diff --git a/lib/stm32/f3/flash.c b/lib/stm32/f3/flash.c
index c2d25d2d..2d4be6cd 100644
--- a/lib/stm32/f3/flash.c
+++ b/lib/stm32/f3/flash.c
@@ -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.
*
diff --git a/lib/stm32/f3/gpio.c b/lib/stm32/f3/gpio.c
index 88be2496..642a08af 100644
--- a/lib/stm32/f3/gpio.c
+++ b/lib/stm32/f3/gpio.c
@@ -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.
*
diff --git a/lib/stm32/f3/pwr.c b/lib/stm32/f3/pwr.c
new file mode 100644
index 00000000..f9a2aede
--- /dev/null
+++ b/lib/stm32/f3/pwr.c
@@ -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>
+
+
diff --git a/lib/stm32/f3/rcc.c b/lib/stm32/f3/rcc.c
index d3255774..15971817 100644
--- a/lib/stm32/f3/rcc.c
+++ b/lib/stm32/f3/rcc.c
@@ -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.
*
diff --git a/lib/stm32/f3/spi.c b/lib/stm32/f3/spi.c
index 67b041f5..b33411db 100644
--- a/lib/stm32/f3/spi.c
+++ b/lib/stm32/f3/spi.c
@@ -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.
*
diff --git a/lib/stm32/f3/timer.c b/lib/stm32/f3/timer.c
new file mode 100644
index 00000000..0e9ac3d4
--- /dev/null
+++ b/lib/stm32/f3/timer.c
@@ -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>
+
+