Geen omschrijving

doxygen.sty 11KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480
  1. \NeedsTeXFormat{LaTeX2e}
  2. \ProvidesPackage{doxygen}
  3. % Packages used by this style file
  4. \RequirePackage{alltt}
  5. \RequirePackage{array}
  6. \RequirePackage{calc}
  7. \RequirePackage{float}
  8. \RequirePackage{ifthen}
  9. \RequirePackage{verbatim}
  10. \RequirePackage[table]{xcolor}
  11. \RequirePackage{xtab}
  12. %---------- Internal commands used in this style file ----------------
  13. \newcommand{\ensurespace}[1]{%
  14. \begingroup%
  15. \setlength{\dimen@}{#1}%
  16. \vskip\z@\@plus\dimen@%
  17. \penalty -100\vskip\z@\@plus -\dimen@%
  18. \vskip\dimen@%
  19. \penalty 9999%
  20. \vskip -\dimen@%
  21. \vskip\z@skip% hide the previous |\vskip| from |\addvspace|
  22. \endgroup%
  23. }
  24. \newcommand{\DoxyLabelFont}{}
  25. \newcommand{\entrylabel}[1]{%
  26. {%
  27. \parbox[b]{\labelwidth-4pt}{%
  28. \makebox[0pt][l]{\DoxyLabelFont#1}%
  29. \vspace{1.5\baselineskip}%
  30. }%
  31. }%
  32. }
  33. \newenvironment{DoxyDesc}[1]{%
  34. \ensurespace{4\baselineskip}%
  35. \begin{list}{}{%
  36. \settowidth{\labelwidth}{20pt}%
  37. \setlength{\parsep}{0pt}%
  38. \setlength{\itemsep}{0pt}%
  39. \setlength{\leftmargin}{\labelwidth+\labelsep}%
  40. \renewcommand{\makelabel}{\entrylabel}%
  41. }%
  42. \item[#1]%
  43. }{%
  44. \end{list}%
  45. }
  46. \newsavebox{\xrefbox}
  47. \newlength{\xreflength}
  48. \newcommand{\xreflabel}[1]{%
  49. \sbox{\xrefbox}{#1}%
  50. \setlength{\xreflength}{\wd\xrefbox}%
  51. \ifthenelse{\xreflength>\labelwidth}{%
  52. \begin{minipage}{\textwidth}%
  53. \setlength{\parindent}{0pt}%
  54. \hangindent=15pt\bfseries #1\vspace{1.2\itemsep}%
  55. \end{minipage}%
  56. }{%
  57. \parbox[b]{\labelwidth}{\makebox[0pt][l]{\textbf{#1}}}%
  58. }%
  59. }
  60. %---------- Commands used by doxygen LaTeX output generator ----------
  61. % Used by <pre> ... </pre>
  62. \newenvironment{DoxyPre}{%
  63. \small%
  64. \begin{alltt}%
  65. }{%
  66. \end{alltt}%
  67. \normalsize%
  68. }
  69. % Used by @code ... @endcode
  70. \newenvironment{DoxyCode}{%
  71. \par%
  72. \scriptsize%
  73. \begin{alltt}%
  74. }{%
  75. \end{alltt}%
  76. \normalsize%
  77. }
  78. % Used by @example, @include, @includelineno and @dontinclude
  79. \newenvironment{DoxyCodeInclude}{%
  80. \DoxyCode%
  81. }{%
  82. \endDoxyCode%
  83. }
  84. % Used by @verbatim ... @endverbatim
  85. \newenvironment{DoxyVerb}{%
  86. \footnotesize%
  87. \verbatim%
  88. }{%
  89. \endverbatim%
  90. \normalsize%
  91. }
  92. % Used by @verbinclude
  93. \newenvironment{DoxyVerbInclude}{%
  94. \DoxyVerb%
  95. }{%
  96. \endDoxyVerb%
  97. }
  98. % Used by numbered lists (using '-#' or <ol> ... </ol>)
  99. \newenvironment{DoxyEnumerate}{%
  100. \enumerate%
  101. }{%
  102. \endenumerate%
  103. }
  104. % Used by bullet lists (using '-', @li, @arg, or <ul> ... </ul>)
  105. \newenvironment{DoxyItemize}{%
  106. \itemize%
  107. }{%
  108. \enditemize%
  109. }
  110. % Used by description lists (using <dl> ... </dl>)
  111. \newenvironment{DoxyDescription}{%
  112. \description%
  113. }{%
  114. \enddescription%
  115. }
  116. % Used by @image, @dotfile, @dot ... @enddot, and @msc ... @endmsc
  117. % (only if caption is specified)
  118. \newenvironment{DoxyImage}{%
  119. \begin{figure}[H]%
  120. \begin{center}%
  121. }{%
  122. \end{center}%
  123. \end{figure}%
  124. }
  125. % Used by @image, @dotfile, @dot ... @enddot, and @msc ... @endmsc
  126. % (only if no caption is specified)
  127. \newenvironment{DoxyImageNoCaption}{%
  128. \begin{center}%
  129. }{%
  130. \end{center}%
  131. }
  132. % Used by @attention
  133. \newenvironment{DoxyAttention}[1]{%
  134. \begin{DoxyDesc}{#1}%
  135. }{%
  136. \end{DoxyDesc}%
  137. }
  138. % Used by @author and @authors
  139. \newenvironment{DoxyAuthor}[1]{%
  140. \begin{DoxyDesc}{#1}%
  141. }{%
  142. \end{DoxyDesc}%
  143. }
  144. % Used by @date
  145. \newenvironment{DoxyDate}[1]{%
  146. \begin{DoxyDesc}{#1}%
  147. }{%
  148. \end{DoxyDesc}%
  149. }
  150. % Used by @invariant
  151. \newenvironment{DoxyInvariant}[1]{%
  152. \begin{DoxyDesc}{#1}%
  153. }{%
  154. \end{DoxyDesc}%
  155. }
  156. % Used by @note
  157. \newenvironment{DoxyNote}[1]{%
  158. \begin{DoxyDesc}{#1}%
  159. }{%
  160. \end{DoxyDesc}%
  161. }
  162. % Used by @post
  163. \newenvironment{DoxyPostcond}[1]{%
  164. \begin{DoxyDesc}{#1}%
  165. }{%
  166. \end{DoxyDesc}%
  167. }
  168. % Used by @pre
  169. \newenvironment{DoxyPrecond}[1]{%
  170. \begin{DoxyDesc}{#1}%
  171. }{%
  172. \end{DoxyDesc}%
  173. }
  174. % Used by @copyright
  175. \newenvironment{DoxyCopyright}[1]{%
  176. \begin{DoxyDesc}{#1}%
  177. }{%
  178. \end{DoxyDesc}%
  179. }
  180. % Used by @remark
  181. \newenvironment{DoxyRemark}[1]{%
  182. \begin{DoxyDesc}{#1}%
  183. }{%
  184. \end{DoxyDesc}%
  185. }
  186. % Used by @return and @returns
  187. \newenvironment{DoxyReturn}[1]{%
  188. \begin{DoxyDesc}{#1}%
  189. }{%
  190. \end{DoxyDesc}%
  191. }
  192. % Used by @since
  193. \newenvironment{DoxySince}[1]{%
  194. \begin{DoxyDesc}{#1}%
  195. }{%
  196. \end{DoxyDesc}%
  197. }
  198. % Used by @see
  199. \newenvironment{DoxySeeAlso}[1]{%
  200. \begin{DoxyDesc}{#1}%
  201. }{%
  202. \end{DoxyDesc}%
  203. }
  204. % Used by @version
  205. \newenvironment{DoxyVersion}[1]{%
  206. \begin{DoxyDesc}{#1}%
  207. }{%
  208. \end{DoxyDesc}%
  209. }
  210. % Used by @warning
  211. \newenvironment{DoxyWarning}[1]{%
  212. \begin{DoxyDesc}{#1}%
  213. }{%
  214. \end{DoxyDesc}%
  215. }
  216. % Used by @internal
  217. \newenvironment{DoxyInternal}[1]{%
  218. \paragraph*{#1}%
  219. }{%
  220. }
  221. % Used by @par and @paragraph
  222. \newenvironment{DoxyParagraph}[1]{%
  223. \begin{list}{}{%
  224. \settowidth{\labelwidth}{40pt}%
  225. \setlength{\leftmargin}{\labelwidth}%
  226. \setlength{\parsep}{0pt}%
  227. \setlength{\itemsep}{-4pt}%
  228. \renewcommand{\makelabel}{\entrylabel}%
  229. }%
  230. \item[#1]%
  231. }{%
  232. \end{list}%
  233. }
  234. % Used by parameter lists
  235. \newenvironment{DoxyParams}[2][]{%
  236. \par%
  237. \tabletail{\hline}%
  238. \tablelasttail{\hline}%
  239. \tablefirsthead{}%
  240. \tablehead{}%
  241. \ifthenelse{\equal{#1}{}}%
  242. {\tablefirsthead{\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #2}\\[1ex]}%
  243. \begin{xtabular}{|>{\raggedleft\hspace{0pt}}p{0.15\textwidth}|%
  244. p{0.805\textwidth}|}}%
  245. {\ifthenelse{\equal{#1}{1}}%
  246. {\tablefirsthead{\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #2}\\[1ex]}%
  247. \begin{xtabular}{|>{\centering}p{0.10\textwidth}|%
  248. >{\raggedleft\hspace{0pt}}p{0.15\textwidth}|%
  249. p{0.678\textwidth}|}}%
  250. {\tablefirsthead{\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #2}\\[1ex]}%
  251. \begin{xtabular}{|>{\centering}p{0.10\textwidth}|%
  252. >{\centering\hspace{0pt}}p{0.15\textwidth}|%
  253. >{\raggedleft\hspace{0pt}}p{0.15\textwidth}|%
  254. p{0.501\textwidth}|}}%
  255. }\hline%
  256. }{%
  257. \end{xtabular}%
  258. \tablefirsthead{}%
  259. \vspace{6pt}%
  260. }
  261. % Used for fields of simple structs
  262. \newenvironment{DoxyFields}[1]{%
  263. \par%
  264. \tabletail{\hline}%
  265. \tablelasttail{\hline}%
  266. \tablehead{}%
  267. \tablefirsthead{\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]}%
  268. \begin{xtabular}{|>{\raggedleft\hspace{0pt}}p{0.15\textwidth}|%
  269. p{0.15\textwidth}|%
  270. p{0.63\textwidth}|}%
  271. \hline%
  272. }{%
  273. \end{xtabular}%
  274. \tablefirsthead{}%
  275. \vspace{6pt}%
  276. }
  277. % Used for parameters within a detailed function description
  278. \newenvironment{DoxyParamCaption}{%
  279. \renewcommand{\item}[2][]{##1 {\em ##2}}%
  280. }{%
  281. }
  282. % Used by return value lists
  283. \newenvironment{DoxyRetVals}[1]{%
  284. \par%
  285. \tabletail{\hline}%
  286. \tablelasttail{\hline}%
  287. \tablehead{}%
  288. \tablefirsthead{\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]}%
  289. \begin{xtabular}{|>{\raggedleft\hspace{0pt}}p{0.25\textwidth}|%
  290. p{0.705\textwidth}|}%
  291. \hline%
  292. }{%
  293. \end{xtabular}%
  294. \tablefirsthead{}%
  295. \vspace{6pt}%
  296. }
  297. % Used by exception lists
  298. \newenvironment{DoxyExceptions}[1]{%
  299. \par%
  300. \tabletail{\hline}%
  301. \tablelasttail{\hline}%
  302. \tablehead{}%
  303. \tablefirsthead{\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]}%
  304. \begin{xtabular}{|>{\raggedleft\hspace{0pt}}p{0.25\textwidth}|%
  305. p{0.705\textwidth}|}%
  306. \hline%
  307. }{%
  308. \end{xtabular}%
  309. \tablefirsthead{}%
  310. \vspace{6pt}%
  311. }
  312. % Used by template parameter lists
  313. \newenvironment{DoxyTemplParams}[1]{%
  314. \par%
  315. \tabletail{\hline}%
  316. \tablelasttail{\hline}%
  317. \tablehead{}%
  318. \tablefirsthead{\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]}%
  319. \begin{xtabular}{|>{\raggedleft\hspace{0pt}}p{0.25\textwidth}|%
  320. p{0.705\textwidth}|}%
  321. \hline%
  322. }{%
  323. \end{xtabular}%
  324. \tablefirsthead{}%
  325. \vspace{6pt}%
  326. }
  327. % Used for member lists
  328. \newenvironment{DoxyCompactItemize}{%
  329. \begin{itemize}%
  330. \setlength{\itemsep}{-3pt}%
  331. \setlength{\parsep}{0pt}%
  332. \setlength{\topsep}{0pt}%
  333. \setlength{\partopsep}{0pt}%
  334. }{%
  335. \end{itemize}%
  336. }
  337. % Used for member descriptions
  338. \newenvironment{DoxyCompactList}{%
  339. \begin{list}{}{%
  340. \setlength{\leftmargin}{0.5cm}%
  341. \setlength{\itemsep}{0pt}%
  342. \setlength{\parsep}{0pt}%
  343. \setlength{\topsep}{0pt}%
  344. \renewcommand{\makelabel}{\hfill}%
  345. }%
  346. }{%
  347. \end{list}%
  348. }
  349. % Used for reference lists (@bug, @deprecated, @todo, etc.)
  350. \newenvironment{DoxyRefList}{%
  351. \begin{list}{}{%
  352. \setlength{\labelwidth}{10pt}%
  353. \setlength{\leftmargin}{\labelwidth}%
  354. \addtolength{\leftmargin}{\labelsep}%
  355. \renewcommand{\makelabel}{\xreflabel}%
  356. }%
  357. }{%
  358. \end{list}%
  359. }
  360. % Used by @bug, @deprecated, @todo, etc.
  361. \newenvironment{DoxyRefDesc}[1]{%
  362. \begin{list}{}{%
  363. \renewcommand\makelabel[1]{\textbf{##1}}%
  364. \settowidth\labelwidth{\makelabel{#1}}%
  365. \setlength\leftmargin{\labelwidth+\labelsep}%
  366. }%
  367. }{%
  368. \end{list}%
  369. }
  370. % Used by parameter lists and simple sections
  371. \newenvironment{Desc}
  372. {\begin{list}{}{%
  373. \settowidth{\labelwidth}{40pt}%
  374. \setlength{\leftmargin}{\labelwidth}%
  375. \setlength{\parsep}{0pt}%
  376. \setlength{\itemsep}{-4pt}%
  377. \renewcommand{\makelabel}{\entrylabel}%
  378. }
  379. }{%
  380. \end{list}%
  381. }
  382. % Used by tables
  383. \newcommand{\PBS}[1]{\let\temp=\\#1\let\\=\temp}%
  384. \newlength{\tmplength}%
  385. \newenvironment{TabularC}[1]%
  386. {%
  387. \setlength{\tmplength}%
  388. {\linewidth/(#1)-\tabcolsep*2-\arrayrulewidth*(#1+1)/(#1)}%
  389. \par\begin{xtabular*}{\linewidth}%
  390. {*{#1}{|>{\PBS\raggedright\hspace{0pt}}p{\the\tmplength}}|}%
  391. }%
  392. {\end{xtabular*}\par}%
  393. % Used by nested tables
  394. \newenvironment{TabularNC}[1]%
  395. {%
  396. \setlength{\tmplength}%
  397. {\linewidth/(#1)-\tabcolsep*2-\arrayrulewidth*(#1+1)/(#1)}%
  398. \par\begin{tabular*}{\linewidth}%
  399. {*{#1}{|>{\PBS\raggedright\hspace{0pt}}p{\the\tmplength}}|}%
  400. }%
  401. {\end{tabular*}\par}%
  402. % Used for member group headers
  403. \newenvironment{Indent}{%
  404. \begin{list}{}{%
  405. \setlength{\leftmargin}{0.5cm}%
  406. }%
  407. \item[]\ignorespaces%
  408. }{%
  409. \unskip%
  410. \end{list}%
  411. }
  412. % Used when hyperlinks are turned off
  413. \newcommand{\doxyref}[3]{%
  414. \textbf{#1} (\textnormal{#2}\,\pageref{#3})%
  415. }
  416. % Used by @addindex
  417. \newcommand{\lcurly}{\{}
  418. \newcommand{\rcurly}{\}}
  419. % Used for syntax highlighting
  420. \definecolor{comment}{rgb}{0.5,0.0,0.0}
  421. \definecolor{keyword}{rgb}{0.0,0.5,0.0}
  422. \definecolor{keywordtype}{rgb}{0.38,0.25,0.125}
  423. \definecolor{keywordflow}{rgb}{0.88,0.5,0.0}
  424. \definecolor{preprocessor}{rgb}{0.5,0.38,0.125}
  425. \definecolor{stringliteral}{rgb}{0.0,0.125,0.25}
  426. \definecolor{charliteral}{rgb}{0.0,0.5,0.5}
  427. \definecolor{vhdldigit}{rgb}{1.0,0.0,1.0}
  428. \definecolor{vhdlkeyword}{rgb}{0.43,0.0,0.43}
  429. \definecolor{vhdllogic}{rgb}{1.0,0.0,0.0}
  430. \definecolor{vhdlchar}{rgb}{0.0,0.0,0.0}