From eee5a45019967b96d0930769dbb2d247eb60eddb Mon Sep 17 00:00:00 2001 From: Frantisek Burian Date: Wed, 15 Oct 2014 17:05:56 +0200 Subject: [stm32l0] Integrate the L0 architecture to the doxygen documentation Conflicts: doc/Makefile --- doc/DoxygenLayout.xml | 1 + doc/Makefile | 12 +- doc/cm3/DoxygenLayout_cm3.xml | 1 + doc/efm32g/DoxygenLayout_efm32g.xml | 1 + doc/efm32gg/DoxygenLayout_efm32gg.xml | 1 + doc/efm32lg/DoxygenLayout_efm32lg.xml | 1 + doc/efm32tg/DoxygenLayout_efm32tg.xml | 1 + doc/lm3s/DoxygenLayout_lm3s.xml | 1 + doc/lm4f/DoxygenLayout_lm4f.xml | 1 + doc/lpc13xx/DoxygenLayout_lpc13xx.xml | 1 + doc/lpc17xx/DoxygenLayout_lpc17xx.xml | 1 + doc/lpc43xx/DoxygenLayout_lpc43xx.xml | 1 + doc/sam3a/DoxygenLayout_sam3a.xml | 1 + doc/sam3n/DoxygenLayout_sam3n.xml | 1 + doc/sam3s/DoxygenLayout_sam3s.xml | 1 + doc/sam3u/DoxygenLayout_sam3u.xml | 1 + doc/sam3x/DoxygenLayout_sam3x.xml | 1 + doc/stm32f0/DoxygenLayout_stm32f0.xml | 1 + doc/stm32f1/DoxygenLayout_stm32f1.xml | 1 + doc/stm32f2/DoxygenLayout_stm32f2.xml | 1 + doc/stm32f3/DoxygenLayout_stm32f3.xml | 1 + doc/stm32f4/DoxygenLayout_stm32f4.xml | 1 + doc/stm32l0/Doxyfile | 43 +++++++ doc/stm32l0/Doxyfile_latex | 38 +++++++ doc/stm32l0/DoxygenLayout_stm32l0.xml | 207 ++++++++++++++++++++++++++++++++++ doc/stm32l0/header_stm32l0.tex | 61 ++++++++++ doc/stm32l0/index.html | 8 ++ doc/stm32l1/DoxygenLayout_stm32l1.xml | 1 + doc/usb/DoxygenLayout_usb.xml | 1 + 29 files changed, 389 insertions(+), 3 deletions(-) create mode 100644 doc/stm32l0/Doxyfile create mode 100644 doc/stm32l0/Doxyfile_latex create mode 100644 doc/stm32l0/DoxygenLayout_stm32l0.xml create mode 100644 doc/stm32l0/header_stm32l0.tex create mode 100644 doc/stm32l0/index.html (limited to 'doc') diff --git a/doc/DoxygenLayout.xml b/doc/DoxygenLayout.xml index a860bce5..9a9958ce 100644 --- a/doc/DoxygenLayout.xml +++ b/doc/DoxygenLayout.xml @@ -11,6 +11,7 @@ + diff --git a/doc/Makefile b/doc/Makefile index ab02efeb..3029fcfd 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -5,7 +5,7 @@ doc: html latex -html: cm3 usb stm32l1 stm32f0 stm32f1 stm32f2 stm32f3 stm32f4 efm32g efm32gg efm32lg efm32tg lm3s lm4f lpc13 lpc17 lpc43 sam3a sam3n sam3s sam3u sam3x vf6xx top +html: cm3 usb stm32l0 stm32l1 stm32f0 stm32f1 stm32f2 stm32f3 stm32f4 efm32g efm32gg efm32lg efm32tg lm3s lm4f lpc13 lpc17 lpc43 sam3a sam3n sam3s sam3u sam3x vf6xx top cm3: cd cm3/; doxygen @@ -55,6 +55,9 @@ stm32f3: stm32f4: cd stm32f4/; doxygen +stm32l0: + cd stm32l0/; doxygen + stm32l1: cd stm32l1/; doxygen @@ -79,7 +82,10 @@ vf6xx: top: doxygen -latex: stm32l1.pdf stm32f0.pdf stm32f1.pdf stm32f2.pdf stm32f3.pdf stm32f4.pdf lm3s.pdf lm4f.pdf lpc13.pdf lpc17.pdf lpc43.pdf efm32g.pdf efm32gg.pdf efm32lg.pdf efm32tg.pdf sam3a.pdf sam3n.pdf sam3s.pdf sam3u.pdf sam3x.pdf vf6xx.pdf +latex: stm32l0.pdf stm32l1.pdf stm32f0.pdf stm32f1.pdf stm32f2.pdf stm32f3.pdf stm32f4.pdf lm3s.pdf lm4f.pdf lpc13.pdf lpc17.pdf lpc43.pdf efm32g.pdf efm32gg.pdf efm32lg.pdf efm32tg.pdf sam3a.pdf sam3n.pdf sam3s.pdf sam3u.pdf sam3x.pdf vf6xx.pdf + +stm32l0.pdf: + cd stm32l0/; doxygen Doxyfile_latex; cd latex/; $(MAKE); cp refman.pdf ../../stm32l0.pdf stm32l1.pdf: cd stm32l1/; doxygen Doxyfile_latex; cd latex/; $(MAKE); cp refman.pdf ../../stm32l1.pdf @@ -147,5 +153,5 @@ vf6xx.pdf: clean: @rm -rf html/ */html/ */latex/ *.pdf */*.tag -.PHONY: doc html cm3 usb lm3s lm4f lpc13 lpc17 lpc43 stm32l1 stm32f0 stm32f1 stm32f2 stm32f3 stm32f4 efm32g efm32gg efm32lg efm32tg sam3a sam3n sam3s sam3u sam3x vf6xx top latex +.PHONY: doc html cm3 usb lm3s lm4f lpc13 lpc17 lpc43 stm32l0 stm32l1 stm32f0 stm32f1 stm32f2 stm32f3 stm32f4 efm32g efm32gg efm32lg efm32tg sam3a sam3n sam3s sam3u sam3x vf6xx top latex diff --git a/doc/cm3/DoxygenLayout_cm3.xml b/doc/cm3/DoxygenLayout_cm3.xml index 78df3364..8bb2549b 100644 --- a/doc/cm3/DoxygenLayout_cm3.xml +++ b/doc/cm3/DoxygenLayout_cm3.xml @@ -10,6 +10,7 @@ + diff --git a/doc/efm32g/DoxygenLayout_efm32g.xml b/doc/efm32g/DoxygenLayout_efm32g.xml index 3ec76282..ee422abd 100644 --- a/doc/efm32g/DoxygenLayout_efm32g.xml +++ b/doc/efm32g/DoxygenLayout_efm32g.xml @@ -11,6 +11,7 @@ + diff --git a/doc/efm32gg/DoxygenLayout_efm32gg.xml b/doc/efm32gg/DoxygenLayout_efm32gg.xml index 5da81779..0360b9ac 100644 --- a/doc/efm32gg/DoxygenLayout_efm32gg.xml +++ b/doc/efm32gg/DoxygenLayout_efm32gg.xml @@ -11,6 +11,7 @@ + diff --git a/doc/efm32lg/DoxygenLayout_efm32lg.xml b/doc/efm32lg/DoxygenLayout_efm32lg.xml index cc2ab447..e15e5f2e 100644 --- a/doc/efm32lg/DoxygenLayout_efm32lg.xml +++ b/doc/efm32lg/DoxygenLayout_efm32lg.xml @@ -11,6 +11,7 @@ + diff --git a/doc/efm32tg/DoxygenLayout_efm32tg.xml b/doc/efm32tg/DoxygenLayout_efm32tg.xml index e923dfe3..9a694f5f 100644 --- a/doc/efm32tg/DoxygenLayout_efm32tg.xml +++ b/doc/efm32tg/DoxygenLayout_efm32tg.xml @@ -11,6 +11,7 @@ + diff --git a/doc/lm3s/DoxygenLayout_lm3s.xml b/doc/lm3s/DoxygenLayout_lm3s.xml index 0fd3343c..b66addc3 100644 --- a/doc/lm3s/DoxygenLayout_lm3s.xml +++ b/doc/lm3s/DoxygenLayout_lm3s.xml @@ -11,6 +11,7 @@ + diff --git a/doc/lm4f/DoxygenLayout_lm4f.xml b/doc/lm4f/DoxygenLayout_lm4f.xml index bd13a0e9..63495484 100644 --- a/doc/lm4f/DoxygenLayout_lm4f.xml +++ b/doc/lm4f/DoxygenLayout_lm4f.xml @@ -11,6 +11,7 @@ + diff --git a/doc/lpc13xx/DoxygenLayout_lpc13xx.xml b/doc/lpc13xx/DoxygenLayout_lpc13xx.xml index 8e153ecf..87b3faad 100644 --- a/doc/lpc13xx/DoxygenLayout_lpc13xx.xml +++ b/doc/lpc13xx/DoxygenLayout_lpc13xx.xml @@ -10,6 +10,7 @@ + diff --git a/doc/lpc17xx/DoxygenLayout_lpc17xx.xml b/doc/lpc17xx/DoxygenLayout_lpc17xx.xml index b154ab57..37ebdad5 100644 --- a/doc/lpc17xx/DoxygenLayout_lpc17xx.xml +++ b/doc/lpc17xx/DoxygenLayout_lpc17xx.xml @@ -10,6 +10,7 @@ + diff --git a/doc/lpc43xx/DoxygenLayout_lpc43xx.xml b/doc/lpc43xx/DoxygenLayout_lpc43xx.xml index a7de0428..a113900d 100644 --- a/doc/lpc43xx/DoxygenLayout_lpc43xx.xml +++ b/doc/lpc43xx/DoxygenLayout_lpc43xx.xml @@ -10,6 +10,7 @@ + diff --git a/doc/sam3a/DoxygenLayout_sam3a.xml b/doc/sam3a/DoxygenLayout_sam3a.xml index 1048daf0..29ef241d 100644 --- a/doc/sam3a/DoxygenLayout_sam3a.xml +++ b/doc/sam3a/DoxygenLayout_sam3a.xml @@ -11,6 +11,7 @@ + diff --git a/doc/sam3n/DoxygenLayout_sam3n.xml b/doc/sam3n/DoxygenLayout_sam3n.xml index 51a19fcc..48cb64ae 100644 --- a/doc/sam3n/DoxygenLayout_sam3n.xml +++ b/doc/sam3n/DoxygenLayout_sam3n.xml @@ -11,6 +11,7 @@ + diff --git a/doc/sam3s/DoxygenLayout_sam3s.xml b/doc/sam3s/DoxygenLayout_sam3s.xml index e8dfc72b..b2277d72 100644 --- a/doc/sam3s/DoxygenLayout_sam3s.xml +++ b/doc/sam3s/DoxygenLayout_sam3s.xml @@ -11,6 +11,7 @@ + diff --git a/doc/sam3u/DoxygenLayout_sam3u.xml b/doc/sam3u/DoxygenLayout_sam3u.xml index 28b89354..2a4b5938 100644 --- a/doc/sam3u/DoxygenLayout_sam3u.xml +++ b/doc/sam3u/DoxygenLayout_sam3u.xml @@ -11,6 +11,7 @@ + diff --git a/doc/sam3x/DoxygenLayout_sam3x.xml b/doc/sam3x/DoxygenLayout_sam3x.xml index 97f05461..71bc2078 100644 --- a/doc/sam3x/DoxygenLayout_sam3x.xml +++ b/doc/sam3x/DoxygenLayout_sam3x.xml @@ -11,6 +11,7 @@ + diff --git a/doc/stm32f0/DoxygenLayout_stm32f0.xml b/doc/stm32f0/DoxygenLayout_stm32f0.xml index 8816377f..c477fccd 100644 --- a/doc/stm32f0/DoxygenLayout_stm32f0.xml +++ b/doc/stm32f0/DoxygenLayout_stm32f0.xml @@ -11,6 +11,7 @@ + diff --git a/doc/stm32f1/DoxygenLayout_stm32f1.xml b/doc/stm32f1/DoxygenLayout_stm32f1.xml index 4760a406..210952d0 100644 --- a/doc/stm32f1/DoxygenLayout_stm32f1.xml +++ b/doc/stm32f1/DoxygenLayout_stm32f1.xml @@ -11,6 +11,7 @@ + diff --git a/doc/stm32f2/DoxygenLayout_stm32f2.xml b/doc/stm32f2/DoxygenLayout_stm32f2.xml index 1099a6d4..24a92328 100644 --- a/doc/stm32f2/DoxygenLayout_stm32f2.xml +++ b/doc/stm32f2/DoxygenLayout_stm32f2.xml @@ -11,6 +11,7 @@ + diff --git a/doc/stm32f3/DoxygenLayout_stm32f3.xml b/doc/stm32f3/DoxygenLayout_stm32f3.xml index 3f077fea..8b477f5f 100644 --- a/doc/stm32f3/DoxygenLayout_stm32f3.xml +++ b/doc/stm32f3/DoxygenLayout_stm32f3.xml @@ -11,6 +11,7 @@ + diff --git a/doc/stm32f4/DoxygenLayout_stm32f4.xml b/doc/stm32f4/DoxygenLayout_stm32f4.xml index 9b6cd9f7..044cae31 100644 --- a/doc/stm32f4/DoxygenLayout_stm32f4.xml +++ b/doc/stm32f4/DoxygenLayout_stm32f4.xml @@ -11,6 +11,7 @@ + diff --git a/doc/stm32l0/Doxyfile b/doc/stm32l0/Doxyfile new file mode 100644 index 00000000..496336ff --- /dev/null +++ b/doc/stm32l0/Doxyfile @@ -0,0 +1,43 @@ +# HTML Documentation for STM32L0 code level + +# 15 December 2012 +# (C) Ken Sarkies + +#--------------------------------------------------------------------------- +# Common Include File +#--------------------------------------------------------------------------- + +@INCLUDE = ../Doxyfile_common + +#--------------------------------------------------------------------------- +# Local settings +#--------------------------------------------------------------------------- + +WARN_LOGFILE = doxygen_stm32l0.log + +INPUT = ../../include/libopencm3/license.dox +INPUT +=../../include/libopencm3/stm32/l0 +INPUT +=../../include/libopencm3/stm32/common + +INPUT +=../../lib/stm32/l0 +INPUT +=../../lib/stm32/common + +EXCLUDE = ../../include/libopencm3/stm32/common/gpio_common_f24.h +EXCLUDE +=../../include/libopencm3/stm32/common/timer_common_f24.h \ +EXCLUDE +=../../include/libopencm3/stm32/common/crypto_common_f24.h \ +EXCLUDE +=../../include/libopencm3/stm32/common/hash_common_f24.h + +EXCLUDE =../../lib/stm32/common/gpio_common_f24.c +EXCLUDE =../../lib/stm32/common/timer_common_f24.c +EXCLUDE =../../lib/stm32/common/crypto_common_f24.c +EXCLUDE =../../lib/stm32/common/hash_common_f24.c + +EXCLUDE_PATTERNS = + +LAYOUT_FILE = DoxygenLayout_stm32l0.xml + +GENERATE_TAGFILE = stm32l0.tag + +ENABLE_PREPROCESSING = YES + + diff --git a/doc/stm32l0/Doxyfile_latex b/doc/stm32l0/Doxyfile_latex new file mode 100644 index 00000000..2886e4e8 --- /dev/null +++ b/doc/stm32l0/Doxyfile_latex @@ -0,0 +1,38 @@ +# LaTeX Documentation for STM32L0 code level + +# 15 September 2014 +# (C) Ken Sarkies + +#--------------------------------------------------------------------------- +# Common Include File +#--------------------------------------------------------------------------- + +@INCLUDE = ../Doxyfile_common + +#--------------------------------------------------------------------------- +# Local settings +#--------------------------------------------------------------------------- + +WARN_LOGFILE = doxygen_stm32l0_latex.log + +INPUT = ../../include/libopencm3/docmain.dox +INPUT += ../../include/libopencm3/license.dox \ +INPUT += ../../include/libopencm3/stm32/l0 \ +INPUT += ../../include/libopencm3/stm32/common +INPUT += ../../lib/stm32/l0 +INPUT += ../../lib/stm32/common + +EXCLUDE = ../../include/libopencm3/stm32/l0/doc-stm32l0.h +EXCLUDE += ../../include/libopencm3/stm32/common/gpio_common_f24.h +EXCLUDE += ../../lib/stm32/common/gpio_common_f24.c + +EXCLUDE_PATTERNS = + +LAYOUT_FILE = DoxygenLayout_stm32l0.xml + +GENERATE_HTML = NO + +GENERATE_LATEX = YES + +LATEX_HEADER = header_stm32l0.tex + diff --git a/doc/stm32l0/DoxygenLayout_stm32l0.xml b/doc/stm32l0/DoxygenLayout_stm32l0.xml new file mode 100644 index 00000000..31dbab87 --- /dev/null +++ b/doc/stm32l0/DoxygenLayout_stm32l0.xml @@ -0,0 +1,207 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/stm32l0/header_stm32l0.tex b/doc/stm32l0/header_stm32l0.tex new file mode 100644 index 00000000..2c5e7c27 --- /dev/null +++ b/doc/stm32l0/header_stm32l0.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 STM32L0 ARM Cortex M0 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/doc/stm32l0/index.html b/doc/stm32l0/index.html new file mode 100644 index 00000000..7715877a --- /dev/null +++ b/doc/stm32l0/index.html @@ -0,0 +1,8 @@ + + + + + + Documentation index

+ + diff --git a/doc/stm32l1/DoxygenLayout_stm32l1.xml b/doc/stm32l1/DoxygenLayout_stm32l1.xml index 5b09e390..d23816aa 100644 --- a/doc/stm32l1/DoxygenLayout_stm32l1.xml +++ b/doc/stm32l1/DoxygenLayout_stm32l1.xml @@ -11,6 +11,7 @@ + diff --git a/doc/usb/DoxygenLayout_usb.xml b/doc/usb/DoxygenLayout_usb.xml index 68f9f9f1..c782d528 100644 --- a/doc/usb/DoxygenLayout_usb.xml +++ b/doc/usb/DoxygenLayout_usb.xml @@ -11,6 +11,7 @@ + -- cgit v1.2.3