From 9022e69d5d2d58fa5870a64c6232d8cff61b101a Mon Sep 17 00:00:00 2001 From: Karl Palsson Date: Wed, 11 Oct 2017 22:41:59 +0000 Subject: [PATCH] doc: drop the standalone cm3/usb documents They are now included in the projects, so each .a file has a standalone complete package of all documentation. --- doc/DoxygenLayout.xml | 2 - doc/Makefile | 10 +- doc/cm3/Doxyfile | 25 --- doc/cm3/DoxygenLayout_cm3.xml | 209 -------------------------- doc/efm32g/DoxygenLayout_efm32g.xml | 2 - doc/efm32gg/DoxygenLayout_efm32gg.xml | 2 - doc/efm32lg/DoxygenLayout_efm32lg.xml | 2 - doc/efm32tg/DoxygenLayout_efm32tg.xml | 2 - doc/lm3s/DoxygenLayout_lm3s.xml | 2 - doc/lm4f/DoxygenLayout_lm4f.xml | 2 - doc/lpc13xx/DoxygenLayout_lpc13xx.xml | 2 - doc/lpc17xx/DoxygenLayout_lpc17xx.xml | 2 - doc/lpc43xx/DoxygenLayout_lpc43xx.xml | 2 - doc/sam3a/DoxygenLayout_sam3a.xml | 2 - doc/sam3n/DoxygenLayout_sam3n.xml | 2 - doc/sam3s/DoxygenLayout_sam3s.xml | 2 - doc/sam3u/DoxygenLayout_sam3u.xml | 2 - doc/sam3x/DoxygenLayout_sam3x.xml | 2 - doc/stm32f0/DoxygenLayout_stm32f0.xml | 2 - doc/stm32f1/DoxygenLayout_stm32f1.xml | 2 - doc/stm32f2/DoxygenLayout_stm32f2.xml | 2 - doc/stm32f3/DoxygenLayout_stm32f3.xml | 2 - doc/stm32f4/DoxygenLayout_stm32f4.xml | 2 - doc/stm32f7/DoxygenLayout_stm32f7.xml | 2 - doc/stm32l0/DoxygenLayout_stm32l0.xml | 2 - doc/stm32l1/DoxygenLayout_stm32l1.xml | 2 - doc/stm32l4/DoxygenLayout_stm32l4.xml | 2 - doc/usb/Doxyfile | 31 ---- doc/usb/Doxyfile_latex | 40 ----- doc/usb/DoxygenLayout_usb.xml | 209 -------------------------- doc/usb/header_usb.tex | 61 -------- doc/vf6xx/DoxygenLayout_vf6xx.xml | 2 - 32 files changed, 2 insertions(+), 633 deletions(-) delete mode 100644 doc/cm3/Doxyfile delete mode 100644 doc/cm3/DoxygenLayout_cm3.xml delete mode 100644 doc/usb/Doxyfile delete mode 100644 doc/usb/Doxyfile_latex delete mode 100644 doc/usb/DoxygenLayout_usb.xml delete mode 100644 doc/usb/header_usb.tex diff --git a/doc/DoxygenLayout.xml b/doc/DoxygenLayout.xml index 98075380..57f92efb 100644 --- a/doc/DoxygenLayout.xml +++ b/doc/DoxygenLayout.xml @@ -4,8 +4,6 @@ - - diff --git a/doc/Makefile b/doc/Makefile index 960e4ecf..7c116879 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -15,17 +15,11 @@ PDFS := $(ARCHS:=.pdf) doc: html latex -html: rebuildsources cm3 usb $(ARCHS) +html: rebuildsources $(ARCHS) doxygen latex: $(PDFS) -cm3: - cd cm3/; doxygen - -usb: - cd usb/; doxygen - $(ARCHS): cd $@/; doxygen @@ -62,5 +56,5 @@ rebuildsources: ../scripts/gendoxylist ../lib/sam/3x sam3x ../scripts/gendoxylist ../lib/vf6xx vf6xx -.PHONY: doc html cm3 usb $(ARCHS) latex rebuildsources +.PHONY: doc html $(ARCHS) latex rebuildsources diff --git a/doc/cm3/Doxyfile b/doc/cm3/Doxyfile deleted file mode 100644 index ab18666d..00000000 --- a/doc/cm3/Doxyfile +++ /dev/null @@ -1,25 +0,0 @@ -# HTML Documentation for CM3 Core features. - -# 14 September 2012 -# (C) Ken Sarkies - -#--------------------------------------------------------------------------- -# Common Include File -#--------------------------------------------------------------------------- - -@INCLUDE = ../Doxyfile_common - -#--------------------------------------------------------------------------- -# Local settings -#--------------------------------------------------------------------------- - -WARN_LOGFILE = doxygen_cm3.log - -INPUT = ../../include/libopencm3/license.dox -INPUT += ../../include/libopencm3/cm3/ -INPUT += ../../lib/cm3 - -LAYOUT_FILE = DoxygenLayout_cm3.xml - -GENERATE_TAGFILE = cm3.tag - diff --git a/doc/cm3/DoxygenLayout_cm3.xml b/doc/cm3/DoxygenLayout_cm3.xml deleted file mode 100644 index 8173b18e..00000000 --- a/doc/cm3/DoxygenLayout_cm3.xml +++ /dev/null @@ -1,209 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/efm32g/DoxygenLayout_efm32g.xml b/doc/efm32g/DoxygenLayout_efm32g.xml index 8c1fae61..1811e429 100644 --- a/doc/efm32g/DoxygenLayout_efm32g.xml +++ b/doc/efm32g/DoxygenLayout_efm32g.xml @@ -4,8 +4,6 @@ - - diff --git a/doc/efm32gg/DoxygenLayout_efm32gg.xml b/doc/efm32gg/DoxygenLayout_efm32gg.xml index 2b3bcf2c..ef4e5820 100644 --- a/doc/efm32gg/DoxygenLayout_efm32gg.xml +++ b/doc/efm32gg/DoxygenLayout_efm32gg.xml @@ -4,8 +4,6 @@ - - diff --git a/doc/efm32lg/DoxygenLayout_efm32lg.xml b/doc/efm32lg/DoxygenLayout_efm32lg.xml index 7517a3b8..a78c2848 100644 --- a/doc/efm32lg/DoxygenLayout_efm32lg.xml +++ b/doc/efm32lg/DoxygenLayout_efm32lg.xml @@ -4,8 +4,6 @@ - - diff --git a/doc/efm32tg/DoxygenLayout_efm32tg.xml b/doc/efm32tg/DoxygenLayout_efm32tg.xml index ac1cba91..934f9d98 100644 --- a/doc/efm32tg/DoxygenLayout_efm32tg.xml +++ b/doc/efm32tg/DoxygenLayout_efm32tg.xml @@ -4,8 +4,6 @@ - - diff --git a/doc/lm3s/DoxygenLayout_lm3s.xml b/doc/lm3s/DoxygenLayout_lm3s.xml index 178c9078..1f22bb99 100644 --- a/doc/lm3s/DoxygenLayout_lm3s.xml +++ b/doc/lm3s/DoxygenLayout_lm3s.xml @@ -4,8 +4,6 @@ - - diff --git a/doc/lm4f/DoxygenLayout_lm4f.xml b/doc/lm4f/DoxygenLayout_lm4f.xml index 5e3fb0ad..b7bcb908 100644 --- a/doc/lm4f/DoxygenLayout_lm4f.xml +++ b/doc/lm4f/DoxygenLayout_lm4f.xml @@ -4,8 +4,6 @@ - - diff --git a/doc/lpc13xx/DoxygenLayout_lpc13xx.xml b/doc/lpc13xx/DoxygenLayout_lpc13xx.xml index a21c8a8a..6b2db9a2 100644 --- a/doc/lpc13xx/DoxygenLayout_lpc13xx.xml +++ b/doc/lpc13xx/DoxygenLayout_lpc13xx.xml @@ -4,8 +4,6 @@ - - diff --git a/doc/lpc17xx/DoxygenLayout_lpc17xx.xml b/doc/lpc17xx/DoxygenLayout_lpc17xx.xml index e82a7def..5293c536 100644 --- a/doc/lpc17xx/DoxygenLayout_lpc17xx.xml +++ b/doc/lpc17xx/DoxygenLayout_lpc17xx.xml @@ -4,8 +4,6 @@ - - diff --git a/doc/lpc43xx/DoxygenLayout_lpc43xx.xml b/doc/lpc43xx/DoxygenLayout_lpc43xx.xml index 9c30b500..703c8876 100644 --- a/doc/lpc43xx/DoxygenLayout_lpc43xx.xml +++ b/doc/lpc43xx/DoxygenLayout_lpc43xx.xml @@ -4,8 +4,6 @@ - - diff --git a/doc/sam3a/DoxygenLayout_sam3a.xml b/doc/sam3a/DoxygenLayout_sam3a.xml index 46af0ce5..96a1806b 100644 --- a/doc/sam3a/DoxygenLayout_sam3a.xml +++ b/doc/sam3a/DoxygenLayout_sam3a.xml @@ -4,8 +4,6 @@ - - diff --git a/doc/sam3n/DoxygenLayout_sam3n.xml b/doc/sam3n/DoxygenLayout_sam3n.xml index 4a5152c1..90c4ccaf 100644 --- a/doc/sam3n/DoxygenLayout_sam3n.xml +++ b/doc/sam3n/DoxygenLayout_sam3n.xml @@ -4,8 +4,6 @@ - - diff --git a/doc/sam3s/DoxygenLayout_sam3s.xml b/doc/sam3s/DoxygenLayout_sam3s.xml index 71305c80..a4501193 100644 --- a/doc/sam3s/DoxygenLayout_sam3s.xml +++ b/doc/sam3s/DoxygenLayout_sam3s.xml @@ -4,8 +4,6 @@ - - diff --git a/doc/sam3u/DoxygenLayout_sam3u.xml b/doc/sam3u/DoxygenLayout_sam3u.xml index 85023287..c91b36d9 100644 --- a/doc/sam3u/DoxygenLayout_sam3u.xml +++ b/doc/sam3u/DoxygenLayout_sam3u.xml @@ -4,8 +4,6 @@ - - diff --git a/doc/sam3x/DoxygenLayout_sam3x.xml b/doc/sam3x/DoxygenLayout_sam3x.xml index da863df9..aea257dd 100644 --- a/doc/sam3x/DoxygenLayout_sam3x.xml +++ b/doc/sam3x/DoxygenLayout_sam3x.xml @@ -4,8 +4,6 @@ - - diff --git a/doc/stm32f0/DoxygenLayout_stm32f0.xml b/doc/stm32f0/DoxygenLayout_stm32f0.xml index 0bdde1f0..d6a0b9ad 100644 --- a/doc/stm32f0/DoxygenLayout_stm32f0.xml +++ b/doc/stm32f0/DoxygenLayout_stm32f0.xml @@ -4,8 +4,6 @@ - - diff --git a/doc/stm32f1/DoxygenLayout_stm32f1.xml b/doc/stm32f1/DoxygenLayout_stm32f1.xml index 20e26e5e..dc3099ee 100644 --- a/doc/stm32f1/DoxygenLayout_stm32f1.xml +++ b/doc/stm32f1/DoxygenLayout_stm32f1.xml @@ -4,8 +4,6 @@ - - diff --git a/doc/stm32f2/DoxygenLayout_stm32f2.xml b/doc/stm32f2/DoxygenLayout_stm32f2.xml index 1b23e833..f6630c42 100644 --- a/doc/stm32f2/DoxygenLayout_stm32f2.xml +++ b/doc/stm32f2/DoxygenLayout_stm32f2.xml @@ -4,8 +4,6 @@ - - diff --git a/doc/stm32f3/DoxygenLayout_stm32f3.xml b/doc/stm32f3/DoxygenLayout_stm32f3.xml index 814011b2..6f14321a 100644 --- a/doc/stm32f3/DoxygenLayout_stm32f3.xml +++ b/doc/stm32f3/DoxygenLayout_stm32f3.xml @@ -4,8 +4,6 @@ - - diff --git a/doc/stm32f4/DoxygenLayout_stm32f4.xml b/doc/stm32f4/DoxygenLayout_stm32f4.xml index 3fcef60c..ca0df151 100644 --- a/doc/stm32f4/DoxygenLayout_stm32f4.xml +++ b/doc/stm32f4/DoxygenLayout_stm32f4.xml @@ -4,8 +4,6 @@ - - diff --git a/doc/stm32f7/DoxygenLayout_stm32f7.xml b/doc/stm32f7/DoxygenLayout_stm32f7.xml index a44fbaf0..0f3917e5 100644 --- a/doc/stm32f7/DoxygenLayout_stm32f7.xml +++ b/doc/stm32f7/DoxygenLayout_stm32f7.xml @@ -4,8 +4,6 @@ - - diff --git a/doc/stm32l0/DoxygenLayout_stm32l0.xml b/doc/stm32l0/DoxygenLayout_stm32l0.xml index a50ef37f..de294541 100644 --- a/doc/stm32l0/DoxygenLayout_stm32l0.xml +++ b/doc/stm32l0/DoxygenLayout_stm32l0.xml @@ -4,8 +4,6 @@ - - diff --git a/doc/stm32l1/DoxygenLayout_stm32l1.xml b/doc/stm32l1/DoxygenLayout_stm32l1.xml index b2d19af9..1940497f 100644 --- a/doc/stm32l1/DoxygenLayout_stm32l1.xml +++ b/doc/stm32l1/DoxygenLayout_stm32l1.xml @@ -4,8 +4,6 @@ - - diff --git a/doc/stm32l4/DoxygenLayout_stm32l4.xml b/doc/stm32l4/DoxygenLayout_stm32l4.xml index 2049aff0..df781545 100644 --- a/doc/stm32l4/DoxygenLayout_stm32l4.xml +++ b/doc/stm32l4/DoxygenLayout_stm32l4.xml @@ -4,8 +4,6 @@ - - diff --git a/doc/usb/Doxyfile b/doc/usb/Doxyfile deleted file mode 100644 index fcd2745d..00000000 --- a/doc/usb/Doxyfile +++ /dev/null @@ -1,31 +0,0 @@ -# HTML Documentation for USB code level - -# 10 March 2013 -# (C) Ken Sarkies - -#--------------------------------------------------------------------------- -# Common Include File -#--------------------------------------------------------------------------- - -@INCLUDE = ../Doxyfile_common - -#--------------------------------------------------------------------------- -# Local settings -#--------------------------------------------------------------------------- - -WARN_LOGFILE = doxygen_usb.log - -INPUT = ../../include/libopencm3/license.dox \ - ../../include/libopencm3/usb - -INPUT += ../../lib/usb - -EXCLUDE_PATTERNS = - -LAYOUT_FILE = DoxygenLayout_usb.xml - -GENERATE_TAGFILE = usb.tag - -ENABLE_PREPROCESSING = NO - - diff --git a/doc/usb/Doxyfile_latex b/doc/usb/Doxyfile_latex deleted file mode 100644 index 00392aaa..00000000 --- a/doc/usb/Doxyfile_latex +++ /dev/null @@ -1,40 +0,0 @@ -# LaTeX Documentation for USB code level - -# 10 March 2013 -# (C) Ken Sarkies - -#--------------------------------------------------------------------------- -# Common Include File -#--------------------------------------------------------------------------- - -@INCLUDE = ../Doxyfile_common - -#--------------------------------------------------------------------------- -# Local settings -#--------------------------------------------------------------------------- - -WARN_LOGFILE = doxygen_usb_latex.log - -WARN_LOGFILE = doxygen_usb.log - -INPUT = ../../include/libopencm3/license.dox \ - ../../include/libopencm3/usb - -INPUT += ../../lib/usb - -EXCLUDE_PATTERNS = - -LAYOUT_FILE = DoxygenLayout_usb.xml - -TAGFILES = - -GENERATE_TAGFILE = usb.tag - -ENABLE_PREPROCESSING = NO - -GENERATE_HTML = NO - -GENERATE_LATEX = YES - -LATEX_HEADER = header_usb.tex - diff --git a/doc/usb/DoxygenLayout_usb.xml b/doc/usb/DoxygenLayout_usb.xml deleted file mode 100644 index c140cbdb..00000000 --- a/doc/usb/DoxygenLayout_usb.xml +++ /dev/null @@ -1,209 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/usb/header_usb.tex b/doc/usb/header_usb.tex deleted file mode 100644 index 5b902527..00000000 --- a/doc/usb/header_usb.tex +++ /dev/null @@ -1,61 +0,0 @@ -\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\\ Cortex M3 Generic USB}\\ -\vspace*{1cm} -{\large Generated by Doxygen 1.8.2}\\ -\vspace*{0.5cm} -{\small Thu 10 March 2013 23:26:45}\\ -\end{center} -\end{titlepage} -\pagenumbering{arabic} -\hypersetup{pageanchor=true,citecolor=blue} diff --git a/doc/vf6xx/DoxygenLayout_vf6xx.xml b/doc/vf6xx/DoxygenLayout_vf6xx.xml index 9b427673..817db106 100644 --- a/doc/vf6xx/DoxygenLayout_vf6xx.xml +++ b/doc/vf6xx/DoxygenLayout_vf6xx.xml @@ -4,8 +4,6 @@ - -