ponytracker/documentation/latex/refman.tex

218 lines
5.5 KiB
TeX
Raw Normal View History

\documentclass[twoside]{book}
% Packages required by doxygen
\usepackage{calc}
\usepackage{doxygen}
\usepackage{graphicx}
\usepackage[utf8]{inputenc}
\usepackage{makeidx}
\usepackage{multicol}
\usepackage{multirow}
\usepackage{textcomp}
\usepackage[table]{xcolor}
2014-03-11 18:31:18 +01:00
% NLS support packages
\usepackage[french]{babel}
% Font selection
\usepackage[T1]{fontenc}
\usepackage{mathptmx}
\usepackage[scaled=.90]{helvet}
\usepackage{courier}
\usepackage{amssymb}
\usepackage{sectsty}
\renewcommand{\familydefault}{\sfdefault}
\allsectionsfont{%
\fontseries{bc}\selectfont%
\color{darkgray}%
}
\renewcommand{\DoxyLabelFont}{%
\fontseries{bc}\selectfont%
\color{darkgray}%
}
% 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}
\setlength{\parskip}{0.2cm}
\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
% 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{}{}}
2014-05-22 00:12:25 +02:00
\fancyfoot[RE]{\fancyplain{}{\bfseries\scriptsize Généré le Jeudi 22 Mai 2014 00\-:09\-:14 pour Pony\-Tracker par Doxygen }}
\fancyfoot[LO]{\fancyplain{}{\bfseries\scriptsize Généré le Jeudi 22 Mai 2014 00\-:09\-:14 pour Pony\-Tracker par 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
% Hyperlinks (required, but should be loaded last)
\usepackage{ifpdf}
\ifpdf
\usepackage[pdftex,pagebackref=true]{hyperref}
\else
\usepackage[ps2pdf,pagebackref=true]{hyperref}
\fi
\hypersetup{%
colorlinks=true,%
linkcolor=blue,%
citecolor=blue,%
unicode%
}
% Custom commands
\newcommand{\clearemptydoublepage}{%
\newpage{\pagestyle{empty}\cleardoublepage}%
}
%===== C O N T E N T S =====
\begin{document}
% Titlepage & ToC
\hypersetup{pageanchor=false}
\pagenumbering{roman}
\begin{titlepage}
\vspace*{7cm}
\begin{center}%
{\Large Pony\-Tracker }\\
\vspace*{1cm}
2014-03-11 18:31:18 +01:00
{\large Généré par Doxygen 1.8.6}\\
\vspace*{0.5cm}
2014-05-22 00:12:25 +02:00
{\small Jeudi 22 Mai 2014 00:09:14}\\
\end{center}
\end{titlepage}
\clearemptydoublepage
\tableofcontents
\clearemptydoublepage
\pagenumbering{arabic}
\hypersetup{pageanchor=true}
%--- Begin generated contents ---
\chapter{C\-S\-C3502 \-: Pony\-Tracker}
\label{index}\hypertarget{index}{}\input{index}
2014-05-20 13:17:26 +02:00
\chapter{Index des espaces de nommage}
\input{namespaces}
\chapter{Index des structures de données}
\input{annotated}
\chapter{Index des fichiers}
\input{files}
2014-05-20 13:17:26 +02:00
\chapter{Documentation des espaces de nommage}
\input{namespace_f_m_o_d}
\chapter{Documentation des structures de données}
\input{struct__enveloppe}
\input{struct__intrument}
\input{struct__motif}
\input{struct__note}
\input{struct__sample}
\input{class_f_m_o_d_1_1_channel}
\input{class_f_m_o_d_1_1_channel_group}
\input{class_f_m_o_d_1_1_d_s_p}
\input{class_f_m_o_d_1_1_d_s_p_connection}
\input{struct_f_m_o_d___a_d_v_a_n_c_e_d_s_e_t_t_i_n_g_s}
\input{struct_f_m_o_d___a_s_y_n_c_r_e_a_d_i_n_f_o}
\input{struct_f_m_o_d___c_d_t_o_c}
\input{struct_f_m_o_d___c_o_d_e_c___d_e_s_c_r_i_p_t_i_o_n}
\input{struct_f_m_o_d___c_o_d_e_c___s_t_a_t_e}
\input{struct_f_m_o_d___c_o_d_e_c___w_a_v_e_f_o_r_m_a_t}
\input{struct_f_m_o_d___c_r_e_a_t_e_s_o_u_n_d_e_x_i_n_f_o}
\input{struct_f_m_o_d___d_s_p___d_e_s_c_r_i_p_t_i_o_n}
\input{struct_f_m_o_d___d_s_p___p_a_r_a_m_e_t_e_r_d_e_s_c}
\input{struct_f_m_o_d___d_s_p___s_t_a_t_e}
\input{struct_f_m_o_d___g_u_i_d}
\input{struct_f_m_o_d___m_e_m_o_r_y___u_s_a_g_e___d_e_t_a_i_l_s}
\input{struct_f_m_o_d___o_u_t_p_u_t___d_e_s_c_r_i_p_t_i_o_n}
\input{struct_f_m_o_d___o_u_t_p_u_t___s_t_a_t_e}
\input{struct_f_m_o_d___r_e_v_e_r_b___c_h_a_n_n_e_l_p_r_o_p_e_r_t_i_e_s}
\input{struct_f_m_o_d___r_e_v_e_r_b___p_r_o_p_e_r_t_i_e_s}
\input{struct_f_m_o_d___t_a_g}
\input{struct_f_m_o_d___v_e_c_t_o_r}
\input{class_f_m_o_d_1_1_geometry}
\input{class_f_m_o_d_1_1_reverb}
\input{class_f_m_o_d_1_1_sound}
\input{class_f_m_o_d_1_1_sound_group}
\input{class_f_m_o_d_1_1_system}
\chapter{Documentation des fichiers}
2014-05-22 00:12:25 +02:00
\input{boutonsdemerde_8c}
2014-05-20 13:17:26 +02:00
\input{fichier_8c}
\input{fichier_8h}
\input{fmod_8h}
\input{fmod_8hpp}
\input{fmod__codec_8h}
\input{fmod__dsp_8h}
\input{fmod__errors_8h}
\input{fmod__memoryinfo_8h}
\input{fmod__output_8h}
2014-05-22 00:12:25 +02:00
\input{_f_x_8c}
\input{_f_x_8h}
2014-05-20 13:17:26 +02:00
\input{premier_test_8c}
\input{instruments_8c}
\input{instruments_8h}
\input{lecture_8c}
\input{lecture_8h}
\input{main_8c}
2014-05-22 00:12:25 +02:00
\input{boutondemerdes_8c}
\input{maintest_8c}
2014-05-20 13:17:26 +02:00
\input{melodie_8c}
\input{melodie_8h}
\input{motifs_8c}
\input{motifs_8h}
2014-05-20 13:17:26 +02:00
\input{samples_8c}
\input{samples_8h}
2014-05-20 13:17:26 +02:00
\input{test_8c}
2014-05-22 00:12:25 +02:00
\input{_vol_pan_8c}
\input{_vol_pan_8h}
%--- End generated contents ---
% Index
\newpage
\phantomsection
\addcontentsline{toc}{chapter}{Index}
\printindex
\end{document}