343 lines
12 KiB
TeX
343 lines
12 KiB
TeX
% Handle batch mode
|
|
% to overcome problems with too many open files
|
|
\let\mypdfximage\pdfximage\def\pdfximage{\immediate\mypdfximage}
|
|
% Set document class depending on configuration
|
|
\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} % for \textsubscript
|
|
\usepackage{doxygen}
|
|
\usepackage{graphicx}
|
|
\usepackage[utf8]{inputenc}
|
|
\usepackage{makeidx}
|
|
\PassOptionsToPackage{warn}{textcomp}
|
|
\usepackage{textcomp}
|
|
\usepackage[nointegrals]{wasysym}
|
|
\usepackage{ifxetex}
|
|
% NLS support packages
|
|
% Define default fonts
|
|
% Font selection
|
|
\usepackage[T1]{fontenc}
|
|
% set main and monospaced font
|
|
\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%
|
|
}
|
|
% Allow a bit of overflow to go unnoticed by other means
|
|
\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
|
|
% Redefine paragraph/subparagraph environments, using sectsty fonts
|
|
\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}%
|
|
}
|
|
% ToC, LoF, LoT, bibliography, and index
|
|
% Indices & bibliography
|
|
\usepackage{natbib}
|
|
\usepackage[titles]{tocloft}
|
|
\setcounter{tocdepth}{3}
|
|
\setcounter{secnumdepth}{5}
|
|
% creating indexes
|
|
\makeindex
|
|
\usepackage{newunicodechar}
|
|
\newunicodechar{⁻}{${}^{-}$}% Superscript minus
|
|
\newunicodechar{²}{${}^{2}$}% Superscript two
|
|
\newunicodechar{³}{${}^{3}$}% Superscript three
|
|
% Hyperlinks
|
|
% 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,%
|
|
pdftitle={esp32\+\_\+\+BNO08x},%
|
|
pdfsubject={C++ BNO08x IMU driver component for esp-\/idf.}%
|
|
}
|
|
% Custom commands used by the header
|
|
% Custom commands
|
|
\newcommand{\clearemptydoublepage}{%
|
|
\newpage{\pagestyle{empty}\cleardoublepage}%
|
|
}
|
|
% caption style definition
|
|
\usepackage{caption}
|
|
\captionsetup{labelsep=space,justification=centering,font={bf},singlelinecheck=off,skip=4pt,position=top}
|
|
% in page table of contents
|
|
\usepackage{etoc}
|
|
\etocsettocstyle{\doxytocparskip}{\doxynormalparskip}
|
|
% prevent numbers overlap the titles in toc
|
|
\renewcommand{\numberline}[1]{#1~}
|
|
% End of preamble, now comes the document contents
|
|
%===== C O N T E N T S =====
|
|
\begin{document}
|
|
\raggedbottom
|
|
% Titlepage & ToC
|
|
% To avoid duplicate page anchors due to reuse of same numbers for
|
|
% the index (be it as roman numbers)
|
|
\hypersetup{pageanchor=false,
|
|
bookmarksnumbered=true,
|
|
pdfencoding=unicode
|
|
}
|
|
\pagenumbering{alph}
|
|
\begin{titlepage}
|
|
\vspace*{7cm}
|
|
\begin{center}%
|
|
{\Large esp32\+\_\+\+BNO08x}\\
|
|
\vspace*{1cm}
|
|
{\large Generated by Doxygen 1.9.4}\\
|
|
\end{center}
|
|
\end{titlepage}
|
|
\clearemptydoublepage
|
|
\pagenumbering{roman}
|
|
\tableofcontents
|
|
\clearemptydoublepage
|
|
\pagenumbering{arabic}
|
|
% re-enable anchors again
|
|
\hypersetup{pageanchor=true}
|
|
%--- Begin generated contents ---
|
|
\chapter{Namespace Index}
|
|
\input{namespaces}
|
|
\chapter{Hierarchical Index}
|
|
\input{hierarchy}
|
|
\chapter{Class Index}
|
|
\input{annotated}
|
|
\chapter{File Index}
|
|
\input{files}
|
|
\chapter{Namespace Documentation}
|
|
\input{namespace_b_n_o08x_private_types}
|
|
\chapter{Class Documentation}
|
|
\input{class_b_n_o08x}
|
|
\input{structbno08x__accel__t}
|
|
\input{structbno08x__activity__classifier__t}
|
|
\input{structbno08x__ang__vel__t}
|
|
\input{structbno08x__config__t}
|
|
\input{structbno08x__euler__angle__t}
|
|
\input{structbno08x__gyro__bias__t}
|
|
\input{structbno08x__gyro__t}
|
|
\input{struct_b_n_o08x_private_types_1_1bno08x__init__status__t}
|
|
\input{structbno08x__magf__bias__t}
|
|
\input{structbno08x__magf__t}
|
|
\input{structbno08x__meta__data__t}
|
|
\input{structbno08x__quat__t}
|
|
\input{structbno08x__raw__accel__t}
|
|
\input{structbno08x__raw__gyro__t}
|
|
\input{structbno08x__raw__magf__t}
|
|
\input{struct_b_n_o08x_1_1bno08x__reports__t}
|
|
\input{structbno08x__sample__counts__t}
|
|
\input{structbno08x__shake__detector__t}
|
|
\input{structbno08x__stability__classifier__t}
|
|
\input{structbno08x__step__counter__t}
|
|
\input{struct_b_n_o08x_private_types_1_1bno08x__sync__ctx__t}
|
|
\input{structbno08x__tap__detector__t}
|
|
\input{class_b_n_o08x_cb_generic}
|
|
\input{class_b_n_o08x_cb_param_rpt_i_d}
|
|
\input{class_b_n_o08x_cb_param_void}
|
|
\input{class_b_n_o08x_rpt}
|
|
\input{class_b_n_o08x_rpt_acceleration}
|
|
\input{class_b_n_o08x_rpt_activity_classifier}
|
|
\input{class_b_n_o08x_rpt_a_r_v_r_stabilized_game_r_v}
|
|
\input{class_b_n_o08x_rpt_a_r_v_r_stabilized_r_v}
|
|
\input{class_b_n_o08x_rpt_cal_gyro}
|
|
\input{class_b_n_o08x_rpt_cal_magnetometer}
|
|
\input{class_b_n_o08x_rpt_game_r_v}
|
|
\input{class_b_n_o08x_rpt_gravity}
|
|
\input{class_b_n_o08x_rpt_i_gyro_r_v}
|
|
\input{class_b_n_o08x_rpt_linear_acceleration}
|
|
\input{class_b_n_o08x_rpt_raw_m_e_m_s_accelerometer}
|
|
\input{class_b_n_o08x_rpt_raw_m_e_m_s_gyro}
|
|
\input{class_b_n_o08x_rpt_raw_m_e_m_s_magnetometer}
|
|
\input{class_b_n_o08x_rpt_r_v}
|
|
\input{class_b_n_o08x_rpt_r_v_generic}
|
|
\input{class_b_n_o08x_rpt_r_v_geomag}
|
|
\input{class_b_n_o08x_rpt_shake_detector}
|
|
\input{class_b_n_o08x_rpt_stability_classifier}
|
|
\input{class_b_n_o08x_rpt_step_counter}
|
|
\input{class_b_n_o08x_rpt_tap_detector}
|
|
\input{class_b_n_o08x_rpt_uncal_gyro}
|
|
\input{class_b_n_o08x_rpt_uncal_magnetometer}
|
|
\input{class_b_n_o08x_s_h2_h_a_l}
|
|
\input{class_b_n_o08x_test_helper}
|
|
\input{class_b_n_o08x_test_suite}
|
|
\chapter{File Documentation}
|
|
\input{_b_n_o08x_8hpp}
|
|
\input{_b_n_o08x_8hpp_source}
|
|
\input{_b_n_o08x_global_types_8hpp}
|
|
\input{_b_n_o08x_global_types_8hpp_source}
|
|
\input{_b_n_o08x_private_types_8hpp}
|
|
\input{_b_n_o08x_private_types_8hpp_source}
|
|
\input{_b_n_o08x_s_h2_h_a_l_8hpp}
|
|
\input{_b_n_o08x_s_h2_h_a_l_8hpp_source}
|
|
\input{_b_n_o08x_test_helper_8hpp}
|
|
\input{_b_n_o08x_test_helper_8hpp_source}
|
|
\input{_b_n_o08x_test_suite_8hpp}
|
|
\input{_b_n_o08x_test_suite_8hpp_source}
|
|
\input{_b_n_o08x_cb_generic_8hpp}
|
|
\input{_b_n_o08x_cb_generic_8hpp_source}
|
|
\input{_b_n_o08x_cb_param_rpt_i_d_8hpp}
|
|
\input{_b_n_o08x_cb_param_rpt_i_d_8hpp_source}
|
|
\input{_b_n_o08x_cb_param_void_8hpp}
|
|
\input{_b_n_o08x_cb_param_void_8hpp_source}
|
|
\input{_b_n_o08x_reports_8hpp}
|
|
\input{_b_n_o08x_reports_8hpp_source}
|
|
\input{_b_n_o08x_rpt_8hpp}
|
|
\input{_b_n_o08x_rpt_8hpp_source}
|
|
\input{_b_n_o08x_rpt_acceleration_8hpp}
|
|
\input{_b_n_o08x_rpt_acceleration_8hpp_source}
|
|
\input{_b_n_o08x_rpt_activity_classifier_8hpp}
|
|
\input{_b_n_o08x_rpt_activity_classifier_8hpp_source}
|
|
\input{_b_n_o08x_rpt_a_r_v_r_stabilized_game_r_v_8hpp}
|
|
\input{_b_n_o08x_rpt_a_r_v_r_stabilized_game_r_v_8hpp_source}
|
|
\input{_b_n_o08x_rpt_a_r_v_r_stabilized_r_v_8hpp}
|
|
\input{_b_n_o08x_rpt_a_r_v_r_stabilized_r_v_8hpp_source}
|
|
\input{_b_n_o08x_rpt_cal_gyro_8hpp}
|
|
\input{_b_n_o08x_rpt_cal_gyro_8hpp_source}
|
|
\input{_b_n_o08x_rpt_cal_magnetometer_8hpp}
|
|
\input{_b_n_o08x_rpt_cal_magnetometer_8hpp_source}
|
|
\input{_b_n_o08x_rpt_game_r_v_8hpp}
|
|
\input{_b_n_o08x_rpt_game_r_v_8hpp_source}
|
|
\input{_b_n_o08x_rpt_gravity_8hpp}
|
|
\input{_b_n_o08x_rpt_gravity_8hpp_source}
|
|
\input{_b_n_o08x_rpt_i_gyro_r_v_8hpp}
|
|
\input{_b_n_o08x_rpt_i_gyro_r_v_8hpp_source}
|
|
\input{_b_n_o08x_rpt_linear_acceleration_8hpp}
|
|
\input{_b_n_o08x_rpt_linear_acceleration_8hpp_source}
|
|
\input{_b_n_o08x_rpt_raw_m_e_m_s_accelerometer_8hpp}
|
|
\input{_b_n_o08x_rpt_raw_m_e_m_s_accelerometer_8hpp_source}
|
|
\input{_b_n_o08x_rpt_raw_m_e_m_s_gyro_8hpp}
|
|
\input{_b_n_o08x_rpt_raw_m_e_m_s_gyro_8hpp_source}
|
|
\input{_b_n_o08x_rpt_raw_m_e_m_s_magnetometer_8hpp}
|
|
\input{_b_n_o08x_rpt_raw_m_e_m_s_magnetometer_8hpp_source}
|
|
\input{_b_n_o08x_rpt_r_v_8hpp}
|
|
\input{_b_n_o08x_rpt_r_v_8hpp_source}
|
|
\input{_b_n_o08x_rpt_r_v_generic_8hpp}
|
|
\input{_b_n_o08x_rpt_r_v_generic_8hpp_source}
|
|
\input{_b_n_o08x_rpt_r_v_geomag_8hpp}
|
|
\input{_b_n_o08x_rpt_r_v_geomag_8hpp_source}
|
|
\input{_b_n_o08x_rpt_shake_detector_8hpp}
|
|
\input{_b_n_o08x_rpt_shake_detector_8hpp_source}
|
|
\input{_b_n_o08x_rpt_stability_classifier_8hpp}
|
|
\input{_b_n_o08x_rpt_stability_classifier_8hpp_source}
|
|
\input{_b_n_o08x_rpt_step_counter_8hpp}
|
|
\input{_b_n_o08x_rpt_step_counter_8hpp_source}
|
|
\input{_b_n_o08x_rpt_tap_detector_8hpp}
|
|
\input{_b_n_o08x_rpt_tap_detector_8hpp_source}
|
|
\input{_b_n_o08x_rpt_uncal_gyro_8hpp}
|
|
\input{_b_n_o08x_rpt_uncal_gyro_8hpp_source}
|
|
\input{_b_n_o08x_rpt_uncal_magnetometer_8hpp}
|
|
\input{_b_n_o08x_rpt_uncal_magnetometer_8hpp_source}
|
|
\input{_b_n_o08x_8cpp}
|
|
\input{_b_n_o08x_rpt_8cpp}
|
|
\input{_b_n_o08x_s_h2_h_a_l_8cpp}
|
|
\input{_b_n_o08x_rpt_acceleration_8cpp}
|
|
\input{_b_n_o08x_rpt_activity_classifier_8cpp}
|
|
\input{_b_n_o08x_rpt_a_r_v_r_stabilized_game_r_v_8cpp}
|
|
\input{_b_n_o08x_rpt_a_r_v_r_stabilized_r_v_8cpp}
|
|
\input{_b_n_o08x_rpt_cal_gyro_8cpp}
|
|
\input{_b_n_o08x_rpt_cal_magnetometer_8cpp}
|
|
\input{_b_n_o08x_rpt_game_r_v_8cpp}
|
|
\input{_b_n_o08x_rpt_gravity_8cpp}
|
|
\input{_b_n_o08x_rpt_i_gyro_r_v_8cpp}
|
|
\input{_b_n_o08x_rpt_linear_acceleration_8cpp}
|
|
\input{_b_n_o08x_rpt_raw_m_e_m_s_accelerometer_8cpp}
|
|
\input{_b_n_o08x_rpt_raw_m_e_m_s_gyro_8cpp}
|
|
\input{_b_n_o08x_rpt_raw_m_e_m_s_magnetometer_8cpp}
|
|
\input{_b_n_o08x_rpt_r_v_8cpp}
|
|
\input{_b_n_o08x_rpt_r_v_generic_8cpp}
|
|
\input{_b_n_o08x_rpt_r_v_geomag_8cpp}
|
|
\input{_b_n_o08x_rpt_shake_detector_8cpp}
|
|
\input{_b_n_o08x_rpt_stability_classifier_8cpp}
|
|
\input{_b_n_o08x_rpt_step_counter_8cpp}
|
|
\input{_b_n_o08x_rpt_tap_detector_8cpp}
|
|
\input{_b_n_o08x_rpt_uncal_gyro_8cpp}
|
|
\input{_b_n_o08x_rpt_uncal_magnetometer_8cpp}
|
|
%--- End generated contents ---
|
|
% Index
|
|
\backmatter
|
|
\newpage
|
|
\phantomsection
|
|
\clearemptydoublepage
|
|
\addcontentsline{toc}{chapter}{\indexname}
|
|
\printindex
|
|
% Required for some languages (in combination with latexdocumentpre from the header)
|
|
\end{document}
|