c8d81ba3bb
All checks were successful
Build / Build (push) Successful in 39s
This commit significantly enhances the `README.md` file, providing comprehensive documentation for the ArmaDragonflyClient. Key changes: * **Detailed Function Categories:** Categorized functions for better organization (Core, Basic Data Operations, Hash Operations, List Operations). * **Usage Examples:** Added clear and concise usage examples for basic operations, hash operations (context and ID-specific), and list operations. * **Function Documentation Structure:** Outlined the structure for individual function documentation. * **License Information:** Updated the license information.
270 lines
8.6 KiB
TeX
270 lines
8.6 KiB
TeX
% Handle batch mode
|
|
% to overcome problems with too many open files
|
|
\let\mypdfximage\pdfximage\def\pdfximage{\immediate\mypdfximage}
|
|
\RequirePackage{iftex}
|
|
\ifLuaTeX
|
|
\directlua{pdf.setminorversion(7)}
|
|
\fi
|
|
\ifXeTeX
|
|
\special{pdf:minorversion 7}
|
|
\fi
|
|
\ifPDFTeX
|
|
\pdfminorversion=7
|
|
\fi
|
|
% 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
|
|
\makeatletter
|
|
\providecommand\IfFormatAtLeastTF{\@ifl@t@r\fmtversion}
|
|
% suppress package identification of infwarerr as it contains the word "warning"
|
|
\let\@@protected@wlog\protected@wlog
|
|
\def\protected@wlog#1{\wlog{package info suppressed}}
|
|
\RequirePackage{infwarerr}
|
|
\let\protected@wlog\@@protected@wlog
|
|
\makeatother
|
|
\IfFormatAtLeastTF{2016/01/01}{}{\usepackage{fixltx2e}} % for \textsubscript
|
|
\ifPDFTeX
|
|
\IfFormatAtLeastTF{2015/01/01}{\pdfsuppresswarningpagegroup=1}{}
|
|
\fi
|
|
\usepackage{doxygen}
|
|
\usepackage{graphicx}
|
|
\iftutex
|
|
\usepackage{fontspec}
|
|
\defaultfontfeatures{Ligatures={TeX}}
|
|
\usepackage{unicode-math}
|
|
\else
|
|
\usepackage[utf8]{inputenc}
|
|
\fi
|
|
\usepackage{makeidx}
|
|
\PassOptionsToPackage{warn}{textcomp}
|
|
\usepackage{textcomp}
|
|
\usepackage[nointegrals]{wasysym}
|
|
\usepackage{ifxetex}
|
|
% NLS support packages
|
|
% Define default fonts
|
|
% Font selection
|
|
\iftutex
|
|
\else
|
|
\usepackage[T1]{fontenc}
|
|
\fi
|
|
% set main and monospaced font
|
|
\usepackage[scaled=.90]{helvet}
|
|
\usepackage{courier}
|
|
\renewcommand{\familydefault}{\sfdefault}
|
|
\doxyallsectionsfont{%
|
|
\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%
|
|
}
|
|
\usepackage{changepage}
|
|
% 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[numbers]{natbib}
|
|
\usepackage[titles]{tocloft}
|
|
\setcounter{tocdepth}{3}
|
|
\setcounter{secnumdepth}{5}
|
|
% creating indexes
|
|
\makeindex
|
|
\ifPDFTeX
|
|
\usepackage{newunicodechar}
|
|
\makeatletter
|
|
\def\doxynewunicodechar#1#2{%
|
|
\@tempswafalse
|
|
\edef\nuc@tempa{\detokenize{#1}}%
|
|
\if\relax\nuc@tempa\relax
|
|
\nuc@emptyargerr
|
|
\else
|
|
\edef\@tempb{\expandafter\@car\nuc@tempa\@nil}%
|
|
\nuc@check
|
|
\if@tempswa
|
|
\@namedef{u8:\nuc@tempa}{#2}%
|
|
\fi
|
|
\fi
|
|
}
|
|
\makeatother
|
|
\doxynewunicodechar{⁻}{${}^{-}$}% Superscript minus
|
|
\doxynewunicodechar{²}{${}^{2}$}% Superscript two
|
|
\doxynewunicodechar{³}{${}^{3}$}% Superscript three
|
|
\fi
|
|
% Hyperlinks
|
|
% Hyperlinks (required, but should be loaded last)
|
|
\ifPDFTeX
|
|
\usepackage[pdftex,pagebackref=true]{hyperref}
|
|
\else
|
|
\ifXeTeX
|
|
\usepackage[xetex,pagebackref=true]{hyperref}
|
|
\else
|
|
\ifLuaTeX
|
|
\usepackage[luatex,pagebackref=true]{hyperref}
|
|
\else
|
|
\usepackage[ps2pdf,pagebackref=true]{hyperref}
|
|
\fi
|
|
\fi
|
|
\fi
|
|
\hypersetup{%
|
|
colorlinks=true,%
|
|
linkcolor=blue,%
|
|
citecolor=blue,%
|
|
unicode,%
|
|
pdftitle={Arma\+Dragonfly\+Client},%
|
|
pdfsubject={}%
|
|
}
|
|
% 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
|
|
\IfFormatAtLeastTF{2023/05/01}{\usepackage[deeplevels]{etoc}}{\usepackage[deeplevels]{etoc_doxygen}}
|
|
\etocsettocstyle{\doxytocparskip}{\doxynormalparskip}
|
|
\etocsetlevel{subsubsubsection}{4}
|
|
\etocsetlevel{subsubsubsubsection}{5}
|
|
\etocsetlevel{subsubsubsubsubsection}{6}
|
|
\etocsetlevel{subsubsubsubsubsubsection}{7}
|
|
\etocsetlevel{paragraph}{8}
|
|
\etocsetlevel{subparagraph}{9}
|
|
% 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 Arma\+Dragonfly\+Client}\\
|
|
\vspace*{1cm}
|
|
{\large Generated by Doxygen 1.13.2}\\
|
|
\end{center}
|
|
\end{titlepage}
|
|
\clearemptydoublepage
|
|
\pagenumbering{roman}
|
|
\tableofcontents
|
|
\clearemptydoublepage
|
|
\pagenumbering{arabic}
|
|
% re-enable anchors again
|
|
\hypersetup{pageanchor=true}
|
|
%--- Begin generated contents ---
|
|
\input{df/d12/md__g_1_2ids_2dragonfly_2docs_2basic_2delete}
|
|
\input{d4/d99/md__g_1_2ids_2dragonfly_2docs_2basic_2fetch}
|
|
\input{d3/dcb/md__g_1_2ids_2dragonfly_2docs_2basic_2get}
|
|
\input{d2/dce/md__g_1_2ids_2dragonfly_2docs_2basic_2save}
|
|
\input{d9/d9c/md__g_1_2ids_2dragonfly_2docs_2basic_2set}
|
|
\input{dd/d3b/md__g_1_2ids_2dragonfly_2docs_2core_2add_task}
|
|
\input{d4/d43/md__g_1_2ids_2dragonfly_2docs_2core_2handler}
|
|
\input{dc/d36/md__g_1_2ids_2dragonfly_2docs_2core_2init}
|
|
\input{d4/d7c/md__g_1_2ids_2dragonfly_2docs_2core_2print_addon_name}
|
|
\input{d0/d0e/md__g_1_2ids_2dragonfly_2docs_2core_2process_queue}
|
|
\input{d0/df6/md__g_1_2ids_2dragonfly_2docs_2core_2scheduler}
|
|
\input{d6/d7e/md__g_1_2ids_2dragonfly_2docs_2core_2test}
|
|
\input{d9/de8/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_get}
|
|
\input{da/d08/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_get_all}
|
|
\input{d2/d23/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_get_all_id}
|
|
\input{d2/d28/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_get_id}
|
|
\input{d0/df2/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_set}
|
|
\input{da/d74/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_set_bulk}
|
|
\input{d4/d99/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_set_id}
|
|
\input{de/da6/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_set_id_bulk}
|
|
\input{da/d2c/md__g_1_2ids_2dragonfly_2docs_2list_2list_add}
|
|
\input{d3/ddf/md__g_1_2ids_2dragonfly_2docs_2list_2list_get}
|
|
\input{d9/db3/md__g_1_2ids_2dragonfly_2docs_2list_2list_load}
|
|
\input{d1/d22/md__g_1_2ids_2dragonfly_2docs_2list_2list_remove}
|
|
\input{d2/dc5/md__g_1_2ids_2dragonfly_2docs_2list_2list_set}
|
|
%--- 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}
|