update doc
[apps/agl-service-homescreen.git] / doc / api-ref / latex / refman.tex
1 \documentclass[twoside]{book}
2
3 % Packages required by doxygen
4 \usepackage{fixltx2e}
5 \usepackage{calc}
6 \usepackage{doxygen}
7 \usepackage[export]{adjustbox} % also loads graphicx
8 \usepackage{graphicx}
9 \usepackage[utf8]{inputenc}
10 \usepackage{makeidx}
11 \usepackage{multicol}
12 \usepackage{multirow}
13 \PassOptionsToPackage{warn}{textcomp}
14 \usepackage{textcomp}
15 \usepackage[nointegrals]{wasysym}
16 \usepackage[table]{xcolor}
17
18 % Font selection
19 \usepackage[T1]{fontenc}
20 \usepackage[scaled=.90]{helvet}
21 \usepackage{courier}
22 \usepackage{amssymb}
23 \usepackage{sectsty}
24 \renewcommand{\familydefault}{\sfdefault}
25 \allsectionsfont{%
26   \fontseries{bc}\selectfont%
27   \color{darkgray}%
28 }
29 \renewcommand{\DoxyLabelFont}{%
30   \fontseries{bc}\selectfont%
31   \color{darkgray}%
32 }
33 \newcommand{\+}{\discretionary{\mbox{\scriptsize$\hookleftarrow$}}{}{}}
34
35 % Page & text layout
36 \usepackage{geometry}
37 \geometry{%
38   a4paper,%
39   top=2.5cm,%
40   bottom=2.5cm,%
41   left=2.5cm,%
42   right=2.5cm%
43 }
44 \tolerance=750
45 \hfuzz=15pt
46 \hbadness=750
47 \setlength{\emergencystretch}{15pt}
48 \setlength{\parindent}{0cm}
49 \setlength{\parskip}{3ex plus 2ex minus 2ex}
50 \makeatletter
51 \renewcommand{\paragraph}{%
52   \@startsection{paragraph}{4}{0ex}{-1.0ex}{1.0ex}{%
53     \normalfont\normalsize\bfseries\SS@parafont%
54   }%
55 }
56 \renewcommand{\subparagraph}{%
57   \@startsection{subparagraph}{5}{0ex}{-1.0ex}{1.0ex}{%
58     \normalfont\normalsize\bfseries\SS@subparafont%
59   }%
60 }
61 \makeatother
62
63 % Headers & footers
64 \usepackage{fancyhdr}
65 \pagestyle{fancyplain}
66 \fancyhead[LE]{\fancyplain{}{\bfseries\thepage}}
67 \fancyhead[CE]{\fancyplain{}{}}
68 \fancyhead[RE]{\fancyplain{}{\bfseries\leftmark}}
69 \fancyhead[LO]{\fancyplain{}{\bfseries\rightmark}}
70 \fancyhead[CO]{\fancyplain{}{}}
71 \fancyhead[RO]{\fancyplain{}{\bfseries\thepage}}
72 \fancyfoot[LE]{\fancyplain{}{}}
73 \fancyfoot[CE]{\fancyplain{}{}}
74 \fancyfoot[RE]{\fancyplain{}{\bfseries\scriptsize Generated by Doxygen }}
75 \fancyfoot[LO]{\fancyplain{}{\bfseries\scriptsize Generated by Doxygen }}
76 \fancyfoot[CO]{\fancyplain{}{}}
77 \fancyfoot[RO]{\fancyplain{}{}}
78 \renewcommand{\footrulewidth}{0.4pt}
79 \renewcommand{\chaptermark}[1]{%
80   \markboth{#1}{}%
81 }
82 \renewcommand{\sectionmark}[1]{%
83   \markright{\thesection\ #1}%
84 }
85
86 % Indices & bibliography
87 \usepackage{natbib}
88 \usepackage[titles]{tocloft}
89 \setcounter{tocdepth}{3}
90 \setcounter{secnumdepth}{5}
91 \makeindex
92
93 % Hyperlinks (required, but should be loaded last)
94 \usepackage{ifpdf}
95 \ifpdf
96   \usepackage[pdftex,pagebackref=true]{hyperref}
97 \else
98   \usepackage[ps2pdf,pagebackref=true]{hyperref}
99 \fi
100 \hypersetup{%
101   colorlinks=true,%
102   linkcolor=blue,%
103   citecolor=blue,%
104   unicode%
105 }
106
107 % Custom commands
108 \newcommand{\clearemptydoublepage}{%
109   \newpage{\pagestyle{empty}\cleardoublepage}%
110 }
111
112 \usepackage{caption}
113 \captionsetup{labelsep=space,justification=centering,font={bf},singlelinecheck=off,skip=4pt,position=top}
114
115 %===== C O N T E N T S =====
116
117 \begin{document}
118
119 % Titlepage & ToC
120 \hypersetup{pageanchor=false,
121              bookmarksnumbered=true,
122              pdfencoding=unicode
123             }
124 \pagenumbering{roman}
125 \begin{titlepage}
126 \vspace*{7cm}
127 \begin{center}%
128 {\Large Home\+Screen\+Binding }\\
129 \vspace*{1cm}
130 {\large Generated by Doxygen 1.8.11}\\
131 \end{center}
132 \end{titlepage}
133 \clearemptydoublepage
134 \tableofcontents
135 \clearemptydoublepage
136 \pagenumbering{arabic}
137 \hypersetup{pageanchor=true}
138
139 %--- Begin generated contents ---
140 \chapter{Class Index}
141 \input{annotated}
142 \chapter{File Index}
143 \input{files}
144 \chapter{Class Documentation}
145 \input{d6/df5/structdisplay}
146 \input{dd/ddc/structgeometry}
147 \input{d5/d20/class_h_s___client}
148 \input{d0/d53/struct_h_s___client_ctxt}
149 \input{d2/d8e/class_h_s___client_manager}
150 \input{de/dd0/class_lib_home_screen}
151 \input{d6/de3/structwindow}
152 \chapter{File Documentation}
153 \input{d2/d66/include_2hmi-debug_8h}
154 \input{d6/dff/src_2hmi-debug_8h}
155 \input{df/d43/libhomescreen_8hpp}
156 \input{d0/d8a/libhomescreen_8cpp}
157 \input{de/da4/simple-egl_8cpp}
158 \input{d6/dda/homescreen_8cpp}
159 \input{d8/d55/hs-client_8cpp}
160 \input{da/dd3/hs-client_8h}
161 \input{dd/d30/hs-clientmanager_8cpp}
162 \input{de/dca/hs-clientmanager_8h}
163 \input{df/d66/hs-helper_8cpp}
164 \input{d3/d3d/hs-helper_8h}
165 %--- End generated contents ---
166
167 % Index
168 \backmatter
169 \newpage
170 \phantomsection
171 \clearemptydoublepage
172 \addcontentsline{toc}{chapter}{Index}
173 \printindex
174
175 \end{document}