Ken Sarkies
12 years ago
15 changed files with 571 additions and 0 deletions
@ -0,0 +1,33 @@ |
|||
# HTML Documentation for USB code level |
|||
|
|||
# 10 March 2013 |
|||
# (C) Ken Sarkies <ksarkies@internode.on.net> |
|||
|
|||
#--------------------------------------------------------------------------- |
|||
# 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 |
|||
|
|||
TAGFILES = |
|||
|
|||
GENERATE_TAGFILE = usb.tag |
|||
|
|||
ENABLE_PREPROCESSING = NO |
|||
|
|||
|
|||
@ -0,0 +1,40 @@ |
|||
# LaTeX Documentation for USB code level |
|||
|
|||
# 10 March 2013 |
|||
# (C) Ken Sarkies <ksarkies@internode.on.net> |
|||
|
|||
#--------------------------------------------------------------------------- |
|||
# 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 |
|||
|
|||
@ -0,0 +1,199 @@ |
|||
<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="modules" visible="yes" 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="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> |
|||
@ -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\\ 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} |
|||
@ -0,0 +1,32 @@ |
|||
/** @mainpage libopencm3 Generic USB
|
|||
|
|||
@version 1.0.0 |
|||
|
|||
@date 10 March 2013 |
|||
|
|||
API documentation for Generic USB. |
|||
|
|||
LGPL License Terms @ref lgpl_license |
|||
*/ |
|||
|
|||
/** @defgroup USB Generic USB
|
|||
Libraries for Generic USB. |
|||
|
|||
@version 1.0.0 |
|||
|
|||
@date 10 March 2013 |
|||
|
|||
LGPL License Terms @ref lgpl_license |
|||
*/ |
|||
|
|||
/** @defgroup USB_defines Generic USB Defines
|
|||
|
|||
@brief Defined Constants and Types for Generic USB. |
|||
|
|||
@version 1.0.0 |
|||
|
|||
@date 10 March 2013 |
|||
|
|||
LGPL License Terms @ref lgpl_license |
|||
*/ |
|||
|
|||
Loading…
Reference in new issue