345 lines
7.9 KiB
TeX
345 lines
7.9 KiB
TeX
\let\mypdfximage\pdfximage\def\pdfximage{\immediate\mypdfximage}\documentclass[twoside]{book}
|
|
|
|
%% moved from doxygen.sty due to workaround for LaTex 2019 version and unmaintained tabu package
|
|
\usepackage{ifthen}
|
|
\ifx\requestedLaTeXdate\undefined
|
|
\usepackage{array}
|
|
\else
|
|
\usepackage{array}[=2016-10-06]
|
|
\fi
|
|
%%
|
|
% Packages required by doxygen
|
|
\usepackage{fixltx2e}
|
|
\usepackage{doxygen}
|
|
\usepackage{graphicx}
|
|
\usepackage[utf8]{inputenc}
|
|
\usepackage{makeidx}
|
|
\PassOptionsToPackage{warn}{textcomp}
|
|
\usepackage{textcomp}
|
|
\usepackage[nointegrals]{wasysym}
|
|
\usepackage{ifxetex}
|
|
|
|
% Font selection
|
|
\usepackage[T1]{fontenc}
|
|
\usepackage[scaled=.90]{helvet}
|
|
\usepackage{courier}
|
|
\renewcommand{\familydefault}{\sfdefault}
|
|
\usepackage{sectsty}
|
|
\allsectionsfont{%
|
|
\fontseries{bc}\selectfont%
|
|
\color{darkgray}%
|
|
}
|
|
\renewcommand{\DoxyLabelFont}{%
|
|
\fontseries{bc}\selectfont%
|
|
\color{darkgray}%
|
|
}
|
|
\newcommand{\+}{\discretionary{\mbox{\scriptsize$\hookleftarrow$}}{}{}}
|
|
|
|
% Arguments of doxygenemoji:
|
|
% 1) ':<text>:' form of the emoji, already "LaTeX"-escaped
|
|
% 2) file with the name of the emoji without the .png extension
|
|
% in case image exist use this otherwise use the ':<text>:' form
|
|
\newcommand{\doxygenemoji}[2]{%
|
|
\IfFileExists{./#2.png}{\raisebox{-0.1em}{\includegraphics[height=0.9em]{./#2.png}}}{#1}%
|
|
}
|
|
% Page & text layout
|
|
\usepackage{geometry}
|
|
\geometry{%
|
|
a4paper,%
|
|
top=2.5cm,%
|
|
bottom=2.5cm,%
|
|
left=2.5cm,%
|
|
right=2.5cm%
|
|
}
|
|
\tolerance=750
|
|
\hfuzz=15pt
|
|
\hbadness=750
|
|
\setlength{\emergencystretch}{15pt}
|
|
\setlength{\parindent}{0cm}
|
|
\newcommand{\doxynormalparskip}{\setlength{\parskip}{3ex plus 2ex minus 2ex}}
|
|
\newcommand{\doxytocparskip}{\setlength{\parskip}{1ex plus 0ex minus 0ex}}
|
|
\doxynormalparskip
|
|
\makeatletter
|
|
\renewcommand{\paragraph}{%
|
|
\@startsection{paragraph}{4}{0ex}{-1.0ex}{1.0ex}{%
|
|
\normalfont\normalsize\bfseries\SS@parafont%
|
|
}%
|
|
}
|
|
\renewcommand{\subparagraph}{%
|
|
\@startsection{subparagraph}{5}{0ex}{-1.0ex}{1.0ex}{%
|
|
\normalfont\normalsize\bfseries\SS@subparafont%
|
|
}%
|
|
}
|
|
\makeatother
|
|
|
|
\makeatletter
|
|
\newcommand\hrulefilll{\leavevmode\leaders\hrule\hskip 0pt plus 1filll\kern\z@}
|
|
\makeatother
|
|
|
|
% Headers & footers
|
|
\usepackage{fancyhdr}
|
|
\pagestyle{fancyplain}
|
|
\renewcommand{\footrulewidth}{0.4pt}
|
|
%
|
|
\fancypagestyle{fancyplain}{
|
|
\fancyhf{}
|
|
\fancyhead[LE, RO]{\bfseries\thepage}
|
|
\fancyhead[LO]{\bfseries\rightmark}
|
|
\fancyhead[RE]{\bfseries\leftmark}
|
|
\fancyfoot[LO, RE]{\bfseries\scriptsize Generated by Doxygen }
|
|
}
|
|
%
|
|
\fancypagestyle{plain}{
|
|
\fancyhf{}
|
|
\fancyfoot[LO, RE]{\bfseries\scriptsize Generated by Doxygen }
|
|
\renewcommand{\headrulewidth}{0pt}}
|
|
%
|
|
\pagestyle{fancyplain}
|
|
%
|
|
\renewcommand{\chaptermark}[1]{%
|
|
\markboth{#1}{}%
|
|
}
|
|
\renewcommand{\sectionmark}[1]{%
|
|
\markright{\thesection\ #1}%
|
|
}
|
|
|
|
% Indices & bibliography
|
|
\usepackage{natbib}
|
|
\usepackage[titles]{tocloft}
|
|
\setcounter{tocdepth}{3}
|
|
\setcounter{secnumdepth}{5}
|
|
\makeindex
|
|
|
|
\usepackage{newunicodechar}
|
|
\newunicodechar{⁻}{${}^{-}$}% Superscript minus
|
|
\newunicodechar{²}{${}^{2}$}% Superscript two
|
|
\newunicodechar{³}{${}^{3}$}% Superscript three
|
|
|
|
% Hyperlinks (required, but should be loaded last)
|
|
\ifpdf
|
|
\usepackage[pdftex,pagebackref=true]{hyperref}
|
|
\else
|
|
\ifxetex
|
|
\usepackage[pagebackref=true]{hyperref}
|
|
\else
|
|
\usepackage[ps2pdf,pagebackref=true]{hyperref}
|
|
\fi
|
|
\fi
|
|
|
|
\hypersetup{%
|
|
colorlinks=true,%
|
|
linkcolor=blue,%
|
|
citecolor=blue,%
|
|
unicode%
|
|
}
|
|
|
|
% Custom commands
|
|
\newcommand{\clearemptydoublepage}{%
|
|
\newpage{\pagestyle{empty}\cleardoublepage}%
|
|
}
|
|
|
|
\usepackage{caption}
|
|
\captionsetup{labelsep=space,justification=centering,font={bf},singlelinecheck=off,skip=4pt,position=top}
|
|
|
|
\usepackage{etoc}
|
|
\etocsettocstyle{\doxytocparskip}{\doxynormalparskip}
|
|
\renewcommand{\numberline}[1]{#1~}
|
|
%===== C O N T E N T S =====
|
|
|
|
\begin{document}
|
|
\raggedbottom
|
|
|
|
% Titlepage & ToC
|
|
\hypersetup{pageanchor=false,
|
|
bookmarksnumbered=true,
|
|
pdfencoding=unicode
|
|
}
|
|
\pagenumbering{alph}
|
|
\begin{titlepage}
|
|
\vspace*{7cm}
|
|
\begin{center}%
|
|
{\Large 2020-\/2021 Sunseeker Telemetry and Lighting System }\\
|
|
\vspace*{1cm}
|
|
{\large Generated by Doxygen 1.9.1}\\
|
|
\end{center}
|
|
\end{titlepage}
|
|
\clearemptydoublepage
|
|
\pagenumbering{roman}
|
|
\tableofcontents
|
|
\clearemptydoublepage
|
|
\pagenumbering{arabic}
|
|
\hypersetup{pageanchor=true}
|
|
|
|
%--- Begin generated contents ---
|
|
\chapter{Home}
|
|
\label{index}\hypertarget{index}{}\input{index}
|
|
\chapter{Hardware}
|
|
\label{hardware}
|
|
\Hypertarget{hardware}
|
|
\input{hardware}
|
|
\chapter{Software}
|
|
\label{software}
|
|
\Hypertarget{software}
|
|
\input{software}
|
|
\chapter{Documentation Guide}
|
|
\label{documentation_guide}
|
|
\Hypertarget{documentation_guide}
|
|
\input{documentation_guide}
|
|
\chapter{Module Index}
|
|
\input{modules}
|
|
\chapter{Namespace Index}
|
|
\input{namespaces}
|
|
\chapter{File Index}
|
|
\input{files}
|
|
\chapter{Module Documentation}
|
|
\input{group__adc10__a__api}
|
|
\input{group__adc12__a__api}
|
|
\input{group__aes__api}
|
|
\input{group__battbak__api}
|
|
\input{group__comp__b__api}
|
|
\input{group__crc__api}
|
|
\input{group__ctsd16__api}
|
|
\input{group__dac12__a__api}
|
|
\input{group__dma__api}
|
|
\input{group__eusci__a__spi__api}
|
|
\input{group__eusci__a__uart__api}
|
|
\input{group__eusci__b__i2c__api}
|
|
\input{group__eusci__b__spi__api}
|
|
\input{group__flashctl__api}
|
|
\input{group__gpio__api}
|
|
\input{group__lcd__b__api}
|
|
\input{group__lcd__c__api}
|
|
\input{group__ldopwr__api}
|
|
\input{group__mpy32__api}
|
|
\input{group__oa__api}
|
|
\input{group__pmap__api}
|
|
\input{group__pmm__api}
|
|
\input{group__ram__api}
|
|
\input{group__ref__api}
|
|
\input{group__rtc__a__api}
|
|
\input{group__rtc__b__api}
|
|
\input{group__rtc__c__api}
|
|
\input{group__sd24__b__api}
|
|
\input{group__sfr__api}
|
|
\input{group__sysctl__api}
|
|
\input{group__tec__api}
|
|
\input{group__timer__a__api}
|
|
\input{group__timer__b__api}
|
|
\input{group__timer__d__api}
|
|
\input{group__tlv__api}
|
|
\input{group__ucs__api}
|
|
\input{group__usci__a__spi__api}
|
|
\input{group__usci__a__uart__api}
|
|
\input{group__usci__b__i2c__api}
|
|
\input{group__usci__b__spi__api}
|
|
\input{group__wdt__a__api}
|
|
\chapter{Namespace Documentation}
|
|
\input{namespacelextab}
|
|
\input{namespaceyacctab}
|
|
\chapter{File Documentation}
|
|
\input{_9_hardware_8markdown}
|
|
\input{_design_01_choices_8markdown}
|
|
\input{_device_01_specifications_8markdown}
|
|
\input{_documentation_01_guide_8markdown}
|
|
\input{_r_e_a_d_m_e_8markdown}
|
|
\input{_9_software_8markdown}
|
|
\input{adc10__a_8c}
|
|
\input{adc10__a_8h}
|
|
\input{adc12__a_8c}
|
|
\input{adc12__a_8h}
|
|
\input{aes_8c}
|
|
\input{aes_8h}
|
|
\input{battbak_8c}
|
|
\input{battbak_8h}
|
|
\input{comp__b_8c}
|
|
\input{comp__b_8h}
|
|
\input{crc_8c}
|
|
\input{crc_8h}
|
|
\input{ctsd16_8c}
|
|
\input{ctsd16_8h}
|
|
\input{dac12__a_8c}
|
|
\input{dac12__a_8h}
|
|
\input{dma_8c}
|
|
\input{dma_8h}
|
|
\input{driverlib_8h}
|
|
\input{eusci__a__spi_8c}
|
|
\input{eusci__a__spi_8h}
|
|
\input{eusci__a__uart_8c}
|
|
\input{eusci__a__uart_8h}
|
|
\input{eusci__b__i2c_8c}
|
|
\input{eusci__b__i2c_8h}
|
|
\input{eusci__b__spi_8c}
|
|
\input{eusci__b__spi_8h}
|
|
\input{flashctl_8c}
|
|
\input{flashctl_8h}
|
|
\input{gpio_8c}
|
|
\input{gpio_8h}
|
|
\input{hw__memmap_8h}
|
|
\input{version_8h}
|
|
\input{lcd__b_8c}
|
|
\input{lcd__b_8h}
|
|
\input{lcd__c_8c}
|
|
\input{lcd__c_8h}
|
|
\input{ldopwr_8c}
|
|
\input{ldopwr_8h}
|
|
\input{lextab_8py}
|
|
\input{mpy32_8c}
|
|
\input{mpy32_8h}
|
|
\input{oa_8c}
|
|
\input{oa_8h}
|
|
\input{pmap_8c}
|
|
\input{pmap_8h}
|
|
\input{pmm_8c}
|
|
\input{pmm_8h}
|
|
\input{ram_8c}
|
|
\input{ram_8h}
|
|
\input{ref_8c}
|
|
\input{ref_8h}
|
|
\input{rtc__a_8c}
|
|
\input{rtc__a_8h}
|
|
\input{rtc__b_8c}
|
|
\input{rtc__b_8h}
|
|
\input{rtc__c_8c}
|
|
\input{rtc__c_8h}
|
|
\input{sd24__b_8c}
|
|
\input{sd24__b_8h}
|
|
\input{sfr_8c}
|
|
\input{sfr_8h}
|
|
\input{sysctl_8c}
|
|
\input{sysctl_8h}
|
|
\input{tec_8c}
|
|
\input{tec_8h}
|
|
\input{timer__a_8c}
|
|
\input{timer__a_8h}
|
|
\input{timer__b_8c}
|
|
\input{timer__b_8h}
|
|
\input{timer__d_8c}
|
|
\input{timer__d_8h}
|
|
\input{tlv_8c}
|
|
\input{tlv_8h}
|
|
\input{ucs_8c}
|
|
\input{ucs_8h}
|
|
\input{usci__a__spi_8c}
|
|
\input{usci__a__spi_8h}
|
|
\input{usci__a__uart_8c}
|
|
\input{usci__a__uart_8h}
|
|
\input{usci__b__i2c_8c}
|
|
\input{usci__b__i2c_8h}
|
|
\input{usci__b__spi_8c}
|
|
\input{usci__b__spi_8h}
|
|
\input{wdt__a_8c}
|
|
\input{wdt__a_8h}
|
|
\input{yacctab_8py}
|
|
\input{main_8c}
|
|
%--- End generated contents ---
|
|
|
|
% Index
|
|
\backmatter
|
|
\newpage
|
|
\phantomsection
|
|
\clearemptydoublepage
|
|
\addcontentsline{toc}{chapter}{\indexname}
|
|
\printindex
|
|
|
|
\end{document}
|