Files
lighthub/docs/latex/refman.tex
2022-01-06 02:01:16 +03:00

289 lines
7.0 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{calc}
\usepackage{doxygen}
\usepackage{graphicx}
\usepackage[utf8]{inputenc}
\usepackage{makeidx}
\usepackage{multicol}
\usepackage{multirow}
\PassOptionsToPackage{warn}{textcomp}
\usepackage{textcomp}
\usepackage[nointegrals]{wasysym}
\usepackage[table]{xcolor}
\usepackage{ifpdf,ifxetex}
% Font selection
\usepackage[T1]{fontenc}
\usepackage[scaled=.90]{helvet}
\usepackage{courier}
\renewcommand{\familydefault}{\sfdefault}
\usepackage{amssymb}
\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}
\fancyhead[LE]{\fancyplain{}{\bfseries\thepage}}
\fancyhead[CE]{\fancyplain{}{}}
\fancyhead[RE]{\fancyplain{}{\bfseries\leftmark}}
\fancyhead[LO]{\fancyplain{}{\bfseries\rightmark}}
\fancyhead[CO]{\fancyplain{}{}}
\fancyhead[RO]{\fancyplain{}{\bfseries\thepage}}
\fancyfoot[LE]{\fancyplain{}{}}
\fancyfoot[CE]{\fancyplain{}{}}
\fancyfoot[RE]{\fancyplain{}{\bfseries\scriptsize Generated by Doxygen }}
\fancyfoot[LO]{\fancyplain{}{\bfseries\scriptsize Generated by Doxygen }}
\fancyfoot[CO]{\fancyplain{}{}}
\fancyfoot[RO]{\fancyplain{}{}}
\renewcommand{\footrulewidth}{0.4pt}
\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}
% Titlepage & ToC
\hypersetup{pageanchor=false,
bookmarksnumbered=true,
pdfencoding=unicode
}
\pagenumbering{alph}
\begin{titlepage}
\vspace*{7cm}
\begin{center}%
{\Large Light\+Hub \\[1ex]\large v4.\+0.\+0 }\\
\vspace*{1cm}
{\large Generated by Doxygen 1.8.20}\\
\end{center}
\end{titlepage}
\clearemptydoublepage
\pagenumbering{roman}
\tableofcontents
\clearemptydoublepage
\pagenumbering{arabic}
\hypersetup{pageanchor=true}
%--- Begin generated contents ---
\chapter{Hierarchical Index}
\input{hierarchy}
\chapter{Class Index}
\input{annotated}
\chapter{File Index}
\input{files}
\chapter{Class Documentation}
\input{classabstract_ch}
\input{classabstract_in}
\input{classabstract_out}
\input{classch_persistent}
\input{classcolor_channel}
\input{classflash_stream}
\input{classin__ccs811}
\input{classin__hdc1080}
\input{class_input}
\input{unionin_store}
\input{class_item}
\input{unionitem_arg_store}
\input{classitem_cmd}
\input{unionitem_cmd_store}
\input{classmb_persistent}
\input{classout___a_c}
\input{classout__dmx}
\input{classout___modbus}
\input{classout___motor}
\input{classout___multivent}
\input{classout__pid}
\input{classout__pwm}
\input{classout__relay}
\input{classout___s_p_i_led}
\input{classpid_persistent}
\input{classread_cache}
\input{structreg__t}
\input{classseekable_stream}
\input{structserial__st}
\input{class_status_l_e_d}
\input{class_streamlog}
\input{classsystem_config}
\input{structsystem_config_data}
\input{unionsystem_config_flags}
\input{unionthermostat_store}
\input{union_u_i_d}
\chapter{File Documentation}
\input{abstractch_8cpp}
\input{abstractch_8h}
\input{abstractin_8cpp}
\input{abstractin_8h}
\input{abstractout_8cpp}
\input{abstractout_8h}
\input{bright_8cpp}
\input{bright_8h}
\input{colorchannel_8cpp}
\input{colorchannel_8h}
\input{config_8cpp}
\input{config_8h}
\input{dmx_8cpp}
\input{dmx_8h}
\input{flashstream_8cpp}
\input{flashstream_8h}
\input{inputs_8cpp}
\input{inputs_8h}
\input{item_8cpp}
\input{item_8h}
\input{item_cmd_8cpp}
\input{item_cmd_8h}
\input{main_8cpp}
\input{main_8h}
\input{in__ccs811__hdc1080_8cpp}
\input{in__ccs811__hdc1080_8h}
\input{out__ac_8cpp}
\input{out__ac_8h}
\input{out__dmx_8cpp}
\input{out__dmx_8h}
\input{out__elevator_8cpp}
\input{out__elevator_8h}
\input{out__modbus_8cpp}
\input{out__modbus_8h}
\input{out__motor_8cpp}
\input{out__motor_8h}
\input{out__multivent_8cpp}
\input{out__multivent_8h}
\input{out__pid_8cpp}
\input{out__pid_8h}
\input{out__pwm_8cpp}
\input{out__pwm_8h}
\input{out__relay_8cpp}
\input{out__relay_8h}
\input{out__spiled_8cpp}
\input{out__spiled_8h}
\input{out__uartbridge_8cpp}
\input{out__uartbridge_8h}
\input{options_8h}
\input{ow_term_8cpp}
\input{ow_term_8h}
\input{seekablestream_8h}
\input{statusled_8cpp}
\input{statusled_8h}
\input{streamlog_8cpp}
\input{streamlog_8h}
\input{systemconfigdata_8h}
\input{textconst_8h}
\input{utils_8cpp}
\input{utils_8h}
%--- End generated contents ---
% Index
\backmatter
\newpage
\phantomsection
\clearemptydoublepage
\addcontentsline{toc}{chapter}{\indexname}
\printindex
\end{document}