doxygen.sty 7.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351
  1. \NeedsTeXFormat{LaTeX2e}
  2. \ProvidesPackage{doxygen}
  3. % Packages used by this style file
  4. \RequirePackage{alltt}
  5. \RequirePackage{array}
  6. \RequirePackage{calc}
  7. \RequirePackage{color}
  8. \RequirePackage{fancyhdr}
  9. \RequirePackage{verbatim}
  10. % Setup fancy headings
  11. \pagestyle{fancyplain}
  12. \newcommand{\clearemptydoublepage}{%
  13. \newpage{\pagestyle{empty}\cleardoublepage}%
  14. }
  15. \renewcommand{\chaptermark}[1]{%
  16. \markboth{#1}{}%
  17. }
  18. \renewcommand{\sectionmark}[1]{%
  19. \markright{\thesection\ #1}%
  20. }
  21. \lhead[\fancyplain{}{\bfseries\thepage}]{%
  22. \fancyplain{}{\bfseries\rightmark}%
  23. }
  24. \rhead[\fancyplain{}{\bfseries\leftmark}]{%
  25. \fancyplain{}{\bfseries\thepage}%
  26. }
  27. \rfoot[\fancyplain{}{\bfseries\scriptsize%
  28. Generated on Mon Sep 28 11:02:24 2009 for libtheora by Doxygen }]{}
  29. \lfoot[]{\fancyplain{}{\bfseries\scriptsize%
  30. Generated on Mon Sep 28 11:02:24 2009 for libtheora by Doxygen }}
  31. \cfoot{}
  32. %---------- Internal commands used in this style file ----------------
  33. % Generic environment used by all paragraph-based environments defined
  34. % below. Note that the command \title{...} needs to be defined inside
  35. % those environments!
  36. \newenvironment{DoxyDesc}[1]{%
  37. \begin{list}{}%
  38. {%
  39. \settowidth{\labelwidth}{40pt}%
  40. \setlength{\leftmargin}{\labelwidth}%
  41. \setlength{\parsep}{0pt}%
  42. \setlength{\itemsep}{-4pt}%
  43. \renewcommand{\makelabel}{\entrylabel}%
  44. }%
  45. \item[#1:]%
  46. }{%
  47. \end{list}%
  48. }
  49. %---------- Commands used by doxygen LaTeX output generator ----------
  50. % Used by <pre> ... </pre>
  51. \newenvironment{DoxyPre}{%
  52. \small%
  53. \begin{alltt}%
  54. }{%
  55. \end{alltt}%
  56. \normalsize%
  57. }
  58. % Used by @code ... @endcode
  59. \newenvironment{DoxyCode}{%
  60. \footnotesize%
  61. \verbatim%
  62. }{%
  63. \endverbatim%
  64. \normalsize%
  65. }
  66. % Used by @example, @include, @includelineno and @dontinclude
  67. \newenvironment{DoxyCodeInclude}{%
  68. \DoxyCode%
  69. }{%
  70. \endDoxyCode%
  71. }
  72. % Used by @verbatim ... @endverbatim
  73. \newenvironment{DoxyVerb}{%
  74. \footnotesize%
  75. \verbatim%
  76. }{%
  77. \endverbatim%
  78. \normalsize%
  79. }
  80. % Used by @verbinclude
  81. \newenvironment{DoxyVerbInclude}{%
  82. \DoxyVerb%
  83. }{%
  84. \endDoxyVerb%
  85. }
  86. % Used by numbered lists (using '-#' or <ol> ... </ol>)
  87. \newenvironment{DoxyEnumerate}{%
  88. \enumerate%
  89. }{%
  90. \endenumerate%
  91. }
  92. % Used by bullet lists (using '-', @li, @arg, or <ul> ... </ul>)
  93. \newenvironment{DoxyItemize}{%
  94. \itemize%
  95. }{%
  96. \enditemize%
  97. }
  98. % Used by description lists (using <dl> ... </dl>)
  99. \newenvironment{DoxyDescription}{%
  100. \description%
  101. }{%
  102. \enddescription%
  103. }
  104. % Used by @image, @dotfile, and @dot ... @enddot
  105. % (only if caption is specified)
  106. \newenvironment{DoxyImage}{%
  107. \begin{figure}[H]%
  108. \begin{center}%
  109. }{%
  110. \end{center}%
  111. \end{figure}%
  112. }
  113. % Used by @image, @dotfile, @dot ... @enddot, and @msc ... @endmsc
  114. % (only if no caption is specified)
  115. \newenvironment{DoxyImageNoCaption}{%
  116. }{%
  117. }
  118. % Used by @attention
  119. \newenvironment{DoxyAttention}[1]{%
  120. \begin{DoxyDesc}{#1}%
  121. }{%
  122. \end{DoxyDesc}%
  123. }
  124. % Used by @author and @authors
  125. \newenvironment{DoxyAuthor}[1]{%
  126. \begin{DoxyDesc}{#1}%
  127. }{%
  128. \end{DoxyDesc}%
  129. }
  130. % Used by @date
  131. \newenvironment{DoxyDate}[1]{%
  132. \begin{DoxyDesc}{#1}%
  133. }{%
  134. \end{DoxyDesc}%
  135. }
  136. % Used by @invariant
  137. \newenvironment{DoxyInvariant}[1]{%
  138. \begin{DoxyDesc}{#1}%
  139. }{%
  140. \end{DoxyDesc}%
  141. }
  142. % Used by @note
  143. \newenvironment{DoxyNote}[1]{%
  144. \begin{DoxyDesc}{#1}%
  145. }{%
  146. \end{DoxyDesc}%
  147. }
  148. % Used by @post
  149. \newenvironment{DoxyPostcond}[1]{%
  150. \begin{DoxyDesc}{#1}%
  151. }{%
  152. \end{DoxyDesc}%
  153. }
  154. % Used by @pre
  155. \newenvironment{DoxyPrecond}[1]{%
  156. \begin{DoxyDesc}{#1}%
  157. }{%
  158. \end{DoxyDesc}%
  159. }
  160. % Used by @remark
  161. \newenvironment{DoxyRemark}[1]{%
  162. \begin{DoxyDesc}{#1}%
  163. }{%
  164. \end{DoxyDesc}%
  165. }
  166. % Used by @return
  167. \newenvironment{DoxyReturn}[1]{%
  168. \begin{DoxyDesc}{#1}%
  169. }{%
  170. \end{DoxyDesc}%
  171. }
  172. % Used by @since
  173. \newenvironment{DoxySince}[1]{%
  174. \begin{DoxyDesc}{#1}%
  175. }{%
  176. \end{DoxyDesc}%
  177. }
  178. % Used by @see
  179. \newenvironment{DoxySeeAlso}[1]{%
  180. \begin{DoxyDesc}{#1}%
  181. }{%
  182. \end{DoxyDesc}%
  183. }
  184. % Used by @version
  185. \newenvironment{DoxyVersion}[1]{%
  186. \begin{DoxyDesc}{#1}%
  187. }{%
  188. \end{DoxyDesc}%
  189. }
  190. % Used by @warning
  191. \newenvironment{DoxyWarning}[1]{%
  192. \begin{DoxyDesc}{#1}%
  193. }{%
  194. \end{DoxyDesc}%
  195. }
  196. % Used by @internal
  197. \newenvironment{DoxyInternal}[1]{%
  198. \begin{DoxyDesc}{#1}%
  199. }{%
  200. \end{DoxyDesc}%
  201. }
  202. % Used by @par and @paragraph
  203. \newenvironment{DoxyParagraph}[1]{%
  204. \begin{list}{}%
  205. {%
  206. \settowidth{\labelwidth}{40pt}%
  207. \setlength{\leftmargin}{\labelwidth}%
  208. \setlength{\parsep}{0pt}%
  209. \setlength{\itemsep}{-4pt}%
  210. \renewcommand{\makelabel}{\entrylabel}%
  211. }%
  212. \item[#1]%
  213. }{%
  214. \end{list}%
  215. }
  216. % Used by parameter lists
  217. \newenvironment{DoxyParams}[1]{%
  218. \begin{DoxyDesc}{#1}%
  219. \begin{description}%
  220. }{%
  221. \end{description}%
  222. \end{DoxyDesc}%
  223. }
  224. % Used by return value lists
  225. \newenvironment{DoxyRetVals}[1]{%
  226. \begin{DoxyDesc}{#1}%
  227. \begin{description}%
  228. }{%
  229. \end{description}%
  230. \end{DoxyDesc}%
  231. }
  232. % Used by exception lists
  233. \newenvironment{DoxyExceptions}[1]{%
  234. \begin{DoxyDesc}{#1}%
  235. \begin{description}%
  236. }{%
  237. \end{description}%
  238. \end{DoxyDesc}%
  239. }
  240. % Used by template parameter lists
  241. \newenvironment{DoxyTemplParams}[1]{%
  242. \begin{DoxyDesc}{#1}%
  243. \begin{description}%
  244. }{%
  245. \end{description}%
  246. \end{DoxyDesc}%
  247. }
  248. \newcommand{\doxyref}[3]{\textbf{#1} (\textnormal{#2}\,\pageref{#3})}
  249. \newenvironment{DoxyCompactList}
  250. {\begin{list}{}{
  251. \setlength{\leftmargin}{0.5cm}
  252. \setlength{\itemsep}{0pt}
  253. \setlength{\parsep}{0pt}
  254. \setlength{\topsep}{0pt}
  255. \renewcommand{\makelabel}{\hfill}}}
  256. {\end{list}}
  257. \newenvironment{DoxyCompactItemize}
  258. {
  259. \begin{itemize}
  260. \setlength{\itemsep}{-3pt}
  261. \setlength{\parsep}{0pt}
  262. \setlength{\topsep}{0pt}
  263. \setlength{\partopsep}{0pt}
  264. }
  265. {\end{itemize}}
  266. \newcommand{\PBS}[1]{\let\temp=\\#1\let\\=\temp}
  267. \newlength{\tmplength}
  268. \newenvironment{TabularC}[1]
  269. {
  270. \setlength{\tmplength}
  271. {\linewidth/(#1)-\tabcolsep*2-\arrayrulewidth*(#1+1)/(#1)}
  272. \par\begin{tabular*}{\linewidth}
  273. {*{#1}{|>{\PBS\raggedright\hspace{0pt}}p{\the\tmplength}}|}
  274. }
  275. {\end{tabular*}\par}
  276. \newcommand{\entrylabel}[1]{
  277. {\parbox[b]{\labelwidth-4pt}{\makebox[0pt][l]{\textbf{#1}}\vspace{1.5\baselineskip}}}}
  278. \newenvironment{Desc}
  279. {\begin{list}{}
  280. {
  281. \settowidth{\labelwidth}{40pt}
  282. \setlength{\leftmargin}{\labelwidth}
  283. \setlength{\parsep}{0pt}
  284. \setlength{\itemsep}{-4pt}
  285. \renewcommand{\makelabel}{\entrylabel}
  286. }
  287. }
  288. {\end{list}}
  289. \newenvironment{Indent}
  290. {\begin{list}{}{\setlength{\leftmargin}{0.5cm}}
  291. \item[]\ignorespaces}
  292. {\unskip\end{list}}
  293. \setlength{\parindent}{0cm}
  294. \setlength{\parskip}{0.2cm}
  295. \addtocounter{secnumdepth}{1}
  296. \sloppy
  297. \usepackage[T1]{fontenc}
  298. \makeatletter
  299. \renewcommand{\paragraph}{\@startsection{paragraph}{4}{0ex}%
  300. {-3.25ex plus -1ex minus -0.2ex}%
  301. {1.5ex plus 0.2ex}%
  302. {\normalfont\normalsize\bfseries}}
  303. \makeatother
  304. \stepcounter{secnumdepth}
  305. \stepcounter{tocdepth}
  306. \definecolor{comment}{rgb}{0.5,0.0,0.0}
  307. \definecolor{keyword}{rgb}{0.0,0.5,0.0}
  308. \definecolor{keywordtype}{rgb}{0.38,0.25,0.125}
  309. \definecolor{keywordflow}{rgb}{0.88,0.5,0.0}
  310. \definecolor{preprocessor}{rgb}{0.5,0.38,0.125}
  311. \definecolor{stringliteral}{rgb}{0.0,0.125,0.25}
  312. \definecolor{charliteral}{rgb}{0.0,0.5,0.5}
  313. \definecolor{vhdldigit}{rgb}{1.0,0.0,1.0}
  314. \definecolor{vhdlkeyword}{rgb}{0.43,0.0,0.43}
  315. \definecolor{vhdllogic}{rgb}{1.0,0.0,0.0}
  316. \definecolor{vhdlchar}{rgb}{0.0,0.0,0.0}