diff options
Diffstat (limited to 'docs/doxygen/latex/refman.tex')
-rw-r--r-- | docs/doxygen/latex/refman.tex | 332 |
1 files changed, 332 insertions, 0 deletions
diff --git a/docs/doxygen/latex/refman.tex b/docs/doxygen/latex/refman.tex new file mode 100644 index 0000000..3f408ed --- /dev/null +++ b/docs/doxygen/latex/refman.tex @@ -0,0 +1,332 @@ + % 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=Xbase64,% + pdfsubject=C++ Library for handling Xbase (\+DBF) format type files% + } + % 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 Xbase64}\\ + \vspace*{1cm} + {\large Generated by Doxygen 1.9.3}\\ + \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{Data Structure Index} +\input{annotated} +\chapter{File Index} +\input{files} +\chapter{Namespace Documentation} +\input{namespacexb} +\chapter{Data Structure Documentation} +\input{classxb_1_1xbDate} +\input{classxb_1_1xbDbf} +\input{classxb_1_1xbFile} +\input{structxb_1_1xbSchema} +\input{classxb_1_1xbSsv} +\input{classxb_1_1xbString} +\input{structxb_1_1xbTblList} +\input{classxb_1_1xbTblMgr} +\input{classxb_1_1xbXBase} +\chapter{File Documentation} +\input{xbbcd_8cpp} +\input{xbdate_8cpp} +\input{xbdbf_8cpp} +\input{xbdbf3_8cpp} +\input{xbdbf4_8cpp} +\input{xbexp_8cpp} +\input{xbexpnode_8cpp} +\input{xbfields_8cpp} +\input{xbfile_8cpp} +\input{xbfilter_8cpp} +\input{xbfuncs_8cpp} +\input{xbixbase_8cpp} +\input{xbixmdx_8cpp} +\input{xbixndx_8cpp} +\input{xblog_8cpp} +\input{xbmemo_8cpp} +\input{xbmemo3_8cpp} +\input{xbmemo4_8cpp} +\input{xbssv_8cpp} +\input{xbstring_8cpp} +\input{xbtag_8cpp} +\input{xbtblmgr_8cpp} +\input{xbuda_8cpp} +\input{xbxbase_8cpp} +\input{xb__ex__date_8cpp} +\input{xb__ex__sql_8cpp} +\input{xb__ex__string_8cpp} +\input{xb__ex__v3__create__dbf_8cpp} +\input{xb__ex__v3__upd__dbf_8cpp} +\input{xb__ex__v4__create__dbf_8cpp} +\input{xb__ex__v4__upd__dbf_8cpp} +\input{xbase_8h} +\input{xbase_8h_source} +\input{xbbcd_8h} +\input{xbbcd_8h_source} +\input{xbdate_8h} +\input{xbdate_8h_source} +\input{xbdbf_8h} +\input{xbdbf_8h_source} +\input{xbexp_8h} +\input{xbexp_8h_source} +\input{xbexpnode_8h} +\input{xbexpnode_8h_source} +\input{xbfile_8h} +\input{xbfile_8h_source} +\input{xbfilter_8h} +\input{xbfilter_8h_source} +\input{xbindex_8h} +\input{xbindex_8h_source} +\input{xblnklst_8h} +\input{xblnklst_8h_source} +\input{xblnklstord_8h} +\input{xblnklstord_8h_source} +\input{xblnknod_8h} +\input{xblnknod_8h_source} +\input{xblog_8h} +\input{xblog_8h_source} +\input{xbmemo_8h} +\input{xbmemo_8h_source} +\input{xbretcod_8h} +\input{xbretcod_8h_source} +\input{xbsql_8h} +\input{xbsql_8h_source} +\input{xbssv_8h} +\input{xbssv_8h_source} +\input{xbstring_8h} +\input{xbstring_8h_source} +\input{xbtag_8h} +\input{xbtag_8h_source} +\input{xbtblmgr_8h} +\input{xbtblmgr_8h_source} +\input{xbtypes_8h} +\input{xbtypes_8h_source} +\input{xbuda_8h} +\input{xbuda_8h_source} +\input{xbxbase_8h} +\input{xbxbase_8h_source} +\input{xbcrix_8cpp} +\input{xbcrtbl_8cpp} +\input{xbdrpix_8cpp} +\input{xbdrptbl_8cpp} +\input{xbinsert_8cpp} +\input{xbset_8cpp} +\input{xbsql_8cpp} +\input{tstfuncs_8cpp} +\input{xb__test__bcd_8cpp} +\input{xb__test__date_8cpp} +\input{xb__test__dbf__v3__memos_8cpp} +\input{xb__test__dbf__v3__nomemos_8cpp} +\input{xb__test__dbf__v4__memos_8cpp} +\input{xb__test__dbf__v4__nomemos_8cpp} +\input{xb__test__expnode_8cpp} +\input{xb__test__expression_8cpp} +\input{xb__test__file_8cpp} +\input{xb__test__filter_8cpp} +\input{xb__test__funcs_8cpp} +\input{xb__test__linklist_8cpp} +\input{xb__test__lock_8cpp} +\input{xb__test__lock2_8cpp} +\input{xb__test__log_8cpp} +\input{xb__test__mdx_8cpp} +\input{xb__test__ndx_8cpp} +\input{xb__test__ndx2_8cpp} +\input{xb__test__sql_8cpp} +\input{xb__test__string_8cpp} +\input{xb__test__tblmgr_8cpp} +\input{xb__test__uda_8cpp} +\input{xb__test__xbase_8cpp} +\input{checkndx_8cpp} +\input{dbfxtrct_8cpp} +\input{reindex_8cpp} +\input{xb__cfg__check_8cpp} +\input{xb__copydbf_8cpp} +\input{xb__dbfutil_8cpp} +\input{xb__deletall_8cpp} +\input{xb__dumpdbt_8cpp} +\input{xb__dumphdr_8cpp} +\input{xb__dumpix_8cpp} +\input{xb__dumprecs_8cpp} +\input{xb__execsql_8cpp} +\input{xb__pack_8cpp} +\input{xb__tblinfo_8cpp} +\input{xb__undelall_8cpp} +\input{xb__zap_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} |