[processor-sdk/performance-audio-sr.git] / psdk_cust / libarch_k2g_1_0_1_0 / docs / doxygen / latex / refman.tex
1 \documentclass[twoside]{book}
3 % Packages required by doxygen
4 \usepackage{calc}
5 \usepackage{doxygen}
6 \usepackage{graphicx}
7 \usepackage[utf8]{inputenc}
8 \usepackage{makeidx}
9 \usepackage{multicol}
10 \usepackage{multirow}
11 \usepackage{textcomp}
12 \usepackage[table]{xcolor}
14 % Font selection
15 \usepackage[T1]{fontenc}
16 \usepackage{mathptmx}
17 \usepackage[scaled=.90]{helvet}
18 \usepackage{courier}
19 \usepackage{amssymb}
20 \usepackage{sectsty}
21 \renewcommand{\familydefault}{\sfdefault}
22 \allsectionsfont{%
23 \fontseries{bc}\selectfont%
24 \color{darkgray}%
25 }
26 \renewcommand{\DoxyLabelFont}{%
27 \fontseries{bc}\selectfont%
28 \color{darkgray}%
29 }
31 % Page & text layout
32 \usepackage{geometry}
33 \geometry{%
34 a4paper,%
35 top=2.5cm,%
36 bottom=2.5cm,%
37 left=2.5cm,%
38 right=2.5cm%
39 }
40 \tolerance=750
41 \hfuzz=15pt
42 \hbadness=750
43 \setlength{\emergencystretch}{15pt}
44 \setlength{\parindent}{0cm}
45 \setlength{\parskip}{0.2cm}
46 \makeatletter
47 \renewcommand{\paragraph}{%
48 \@startsection{paragraph}{4}{0ex}{-1.0ex}{1.0ex}{%
49 \normalfont\normalsize\bfseries\SS@parafont%
50 }%
51 }
52 \renewcommand{\subparagraph}{%
53 \@startsection{subparagraph}{5}{0ex}{-1.0ex}{1.0ex}{%
54 \normalfont\normalsize\bfseries\SS@subparafont%
55 }%
56 }
57 \makeatother
59 % Headers & footers
60 \usepackage{fancyhdr}
61 \pagestyle{fancyplain}
62 \fancyhead[LE]{\fancyplain{}{\bfseries\thepage}}
63 \fancyhead[CE]{\fancyplain{}{}}
64 \fancyhead[RE]{\fancyplain{}{\bfseries\leftmark}}
65 \fancyhead[LO]{\fancyplain{}{\bfseries\rightmark}}
66 \fancyhead[CO]{\fancyplain{}{}}
67 \fancyhead[RO]{\fancyplain{}{\bfseries\thepage}}
68 \fancyfoot[LE]{\fancyplain{}{}}
69 \fancyfoot[CE]{\fancyplain{}{}}
70 \fancyfoot[RE]{\fancyplain{}{\bfseries\scriptsize Generated on Mon Mar 6 2017 14\-:10\-:51 for Lib\-Arch by Doxygen }}
71 \fancyfoot[LO]{\fancyplain{}{\bfseries\scriptsize Generated on Mon Mar 6 2017 14\-:10\-:51 for Lib\-Arch by Doxygen }}
72 \fancyfoot[CO]{\fancyplain{}{}}
73 \fancyfoot[RO]{\fancyplain{}{}}
74 \renewcommand{\footrulewidth}{0.4pt}
75 \renewcommand{\chaptermark}[1]{%
76 \markboth{#1}{}%
77 }
78 \renewcommand{\sectionmark}[1]{%
79 \markright{\thesection\ #1}%
80 }
82 % Indices & bibliography
83 \usepackage{natbib}
84 \usepackage[titles]{tocloft}
85 \setcounter{tocdepth}{3}
86 \setcounter{secnumdepth}{5}
87 \makeindex
89 % Hyperlinks (required, but should be loaded last)
90 \usepackage{ifpdf}
91 \ifpdf
92 \usepackage[pdftex,pagebackref=true]{hyperref}
93 \else
94 \usepackage[ps2pdf,pagebackref=true]{hyperref}
95 \fi
96 \hypersetup{%
97 colorlinks=true,%
98 linkcolor=blue,%
99 citecolor=blue,%
100 unicode%
101 }
103 % Custom commands
104 \newcommand{\clearemptydoublepage}{%
105 \newpage{\pagestyle{empty}\cleardoublepage}%
106 }
109 %===== C O N T E N T S =====
111 \begin{document}
113 % Titlepage & ToC
114 \hypersetup{pageanchor=false}
115 \pagenumbering{roman}
116 \begin{titlepage}
117 \vspace*{7cm}
118 \begin{center}%
119 {\Large Lib\-Arch }\\
120 \vspace*{1cm}
121 {\large Generated by Doxygen 1.8.6}\\
122 \vspace*{0.5cm}
123 {\small Mon Mar 6 2017 14:10:51}\\
124 \end{center}
125 \end{titlepage}
126 \clearemptydoublepage
127 \tableofcontents
128 \clearemptydoublepage
129 \pagenumbering{arabic}
130 \hypersetup{pageanchor=true}
132 %--- Begin generated contents ---
133 \chapter{Lib\-Arch A\-P\-I Reference}
134 \label{index}\hypertarget{index}{}\input{index}
135 \chapter{Module Index}
136 \input{modules}
137 \chapter{Data Structure Index}
138 \input{annotated}
139 \chapter{File Index}
140 \input{files}
141 \chapter{Module Documentation}
142 \input{df/d7c/group__libarch__cachecfg}
143 \include{d1/df3/group__libarch__datatrans}
144 \include{d7/da6/group__libarch__memmgt}
145 \include{de/d6b/group__libarch__utils}
146 \chapter{Data Structure Documentation}
147 \input{dd/da7/structlib__emt__Config__s}
148 \input{d8/d98/structlib__emt__ConfigLarge__s}
149 \input{da/dec/structlib__memdscr__str}
150 \chapter{File Documentation}
151 \input{d5/d4d/mainpage_8dox}
152 \input{d1/d92/lib__cachecfg_8c}
153 \input{d3/d2c/lib__cachecfg_8h}
154 \input{da/d77/lib__datatrans_8c}
155 \input{db/d64/lib__datatrans_8h}
156 \input{da/d45/lib__memmgt_8c}
157 \input{db/d68/lib__memmgt_8h}
158 \input{dc/da2/lib__utils_8h}
159 %--- End generated contents ---
161 % Index
162 \newpage
163 \phantomsection
164 \addcontentsline{toc}{chapter}{Index}
165 \printindex
167 \end{document}