Doxyfile 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543
  1. # Doxyfile 1.8.2
  2. #---------------------------------------------------------------------------
  3. # Project Options
  4. #---------------------------------------------------------------------------
  5. DOXYFILE_ENCODING = UTF-8
  6. PROJECT_NAME = wxWidgets
  7. PROJECT_NUMBER = 3.0.2
  8. PROJECT_BRIEF =
  9. PROJECT_LOGO = logo.png
  10. OUTPUT_DIRECTORY = out
  11. CREATE_SUBDIRS = NO
  12. OUTPUT_LANGUAGE = English
  13. BRIEF_MEMBER_DESC = YES
  14. REPEAT_BRIEF = YES
  15. ABBREVIATE_BRIEF =
  16. ALWAYS_DETAILED_SEC = YES # Default: NO
  17. INLINE_INHERITED_MEMB = NO
  18. FULL_PATH_NAMES = YES
  19. STRIP_FROM_PATH = "$(WXWIDGETS)/"
  20. STRIP_FROM_INC_PATH = "$(WXWIDGETS)/include/" \
  21. "$(WXWIDGETS)/interface/"
  22. SHORT_NAMES = NO
  23. JAVADOC_AUTOBRIEF = YES # Default: NO
  24. QT_AUTOBRIEF = NO
  25. MULTILINE_CPP_IS_BRIEF = NO
  26. INHERIT_DOCS = YES
  27. SEPARATE_MEMBER_PAGES = NO
  28. TAB_SIZE = 4
  29. TCL_SUBST =
  30. OPTIMIZE_OUTPUT_FOR_C = NO
  31. OPTIMIZE_OUTPUT_JAVA = NO
  32. OPTIMIZE_FOR_FORTRAN = NO
  33. OPTIMIZE_OUTPUT_VHDL = NO
  34. EXTENSION_MAPPING =
  35. MARKDOWN_SUPPORT = YES
  36. AUTOLINK_SUPPORT = YES
  37. BUILTIN_STL_SUPPORT = NO
  38. CPP_CLI_SUPPORT = NO
  39. SIP_SUPPORT = NO
  40. IDL_PROPERTY_SUPPORT = NO # Default: YES
  41. DISTRIBUTE_GROUP_DOC = YES # Default: NO
  42. SUBGROUPING = YES
  43. INLINE_GROUPED_CLASSES = NO # TODO: Examine this setting.
  44. INLINE_SIMPLE_STRUCTS = NO # TODO: Examine this setting.
  45. TYPEDEF_HIDES_STRUCT = NO
  46. SYMBOL_CACHE_SIZE = 0
  47. LOOKUP_CACHE_SIZE = 0
  48. #---------------------------------------------------------------------------
  49. # Aliases
  50. #---------------------------------------------------------------------------
  51. # This is the most important part of the wxWidgets Doxyfile. Aliases allow
  52. # us to keep the headers readable and "implement" wxWidgets-specific commands.
  53. # Aliases for documenting C++ classes
  54. #---------------------------------------------------------------------------
  55. # aliases to be used by classes which emit wxEvents (e.g. wxWindow, wxTextCtrl, etc):
  56. ALIASES = beginEventEmissionTable="\n<h2>Events emitted by this class</h2><p>Event macros for events emitted by this class:</p><div>"
  57. ALIASES += beginEventEmissionTable{1}="\n<h2>Events emitted by this class</h2><p>The following event handler macros redirect the events to member function handlers '<b>func</b>' with prototypes like: <div class='eventHandler'><span>void&nbsp;handlerFuncName(\1&&nbsp;event)</span></div></p>Event macros for events emitted by this class:<div>"
  58. ALIASES += beginEventEmissionTable{2}="\n<h2>Events emitted by this class</h2><p>The following event handler macros redirect the events to member function handlers '<b>func</b>' with prototypes like: <div class='eventHandler'><span>void&nbsp;handlerFuncName(\1&&nbsp;event)</span> or <span>void&nbsp;handlerFuncName(\2&&nbsp;event)</span></div></p>Event macros for events emitted by this class:<div>"
  59. # aliases to be used in wxEvent-derived classes:
  60. ALIASES += beginEventTable{1}="\n<h2>Events using this class</h2><p>The following event handler macros redirect the events to member function handlers '<b>func</b>' with prototypes like: <div class='eventHandler'><span>void&nbsp;handlerFuncName(\1&&nbsp;event)</span></div></p>Event macros:<div>"
  61. ALIASES += beginEventTable{2}="\n<h2>Events using this class</h2><p>The following event handler macros redirect the events to member function handlers '<b>func</b>' with prototypes like: <div class='eventHandler'><span>void&nbsp;handlerFuncName(\1&&nbsp;event)</span> or <span>void&nbsp;handlerFuncName(\2&&nbsp;event)</span></div></p>Event macros:<div>"
  62. # common event aliases:
  63. ALIASES += event{1}="</div>\li <span class='event'>\1</span>:<div class='eventDesc'>"
  64. ALIASES += event{2}="</div>\li <span class='event'>\1, \2</span>:<div class='eventDesc'>"
  65. ALIASES += event{3}="</div>\li <span class='event'>\1, \2, \3</span>:<div class='eventDesc'>"
  66. ALIASES += event{4}="</div>\li <span class='event'>\1, \2, \3, \4</span>:<div class='eventDesc'>"
  67. ALIASES += endEventTable="</div>\n"
  68. # style aliases
  69. ALIASES += beginStyleTable="\n<h2>Styles</h2><p>This class supports the following styles:</p><div>"
  70. ALIASES += style{1}="</div>\li <span class='style'>\1</span>:<div class='styleDesc'>"
  71. ALIASES += endStyleTable="</div>\n"
  72. # extra style aliases
  73. ALIASES += beginExtraStyleTable="\n<hr><h2>Extra Styles</h2><p>This class supports the following extra styles:</p><div>"
  74. ALIASES += endExtraStyleTable="</div>\n"
  75. # flag aliases
  76. ALIASES += beginFlagTable="<div>"
  77. ALIASES += flag{1}="</div>\li <span class='flag'>\1</span>:<div class='flagDesc'>"
  78. ALIASES += endFlagTable="</div>\n"
  79. # creates appearance section: this should be used for all main GUI controls
  80. # that look different in different ports. genericAppearance can be used for the
  81. # controls that always look the same.
  82. ALIASES += appearance{1}="\htmlonly<div class="appearance"><span class='appearance'>Appearance:</span><table><tr><td>\endhtmlonly\n\image html appear-\1-msw.png \"wxMSW Appearance\"\n\htmlonly</td><td>\endhtmlonly\n\image html appear-\1-gtk.png \"wxGTK Appearance\"\n\htmlonly</td><td>\endhtmlonly\n\image html appear-\1-mac.png \"wxOSX Appearance\"\n\htmlonly</td></tr></table></div>\endhtmlonly"
  83. ALIASES += genericAppearance{1}="\htmlonly<div class="appearance"><span class='appearance'>Appearance:</span><table class='appearance'><tr><td>\endhtmlonly\n\image html generic/\1.png \"Generic Appearance\"\n\htmlonly</td></tr></table></div>\endhtmlonly"
  84. # aliases for the creation of "named member groups"
  85. # USAGE: the first argument must not contain spaces and be a unique identifier
  86. # of the member group for the class being documented;
  87. # the second argument is the member group name and can contain spaces
  88. # See wxString as an usage example.
  89. # NOTE: no warnings are given for wrong member group names so be careful and check
  90. # the doxygen output to verify that there are no typos
  91. ALIASES += member_group_name{2}="<a name='\1'></a> \name \2"
  92. ALIASES += ref_member_group{2}="<a href='#\1' class='el'>\2</a>"
  93. # Aliases for documenting any C++ entity
  94. #---------------------------------------------------------------------------
  95. # aliases for additional wx-specific infos
  96. ALIASES += category{1}="\ingroup group_class_\1 \n<div><span class='category'>Category:</span>&nbsp;&nbsp;<span class='category_text'>\ref group_class_\1</span></div>"
  97. ALIASES += category{2}="\ingroup group_class_\1 group_class_\2 \n<div><span class='category'>Category:</span>&nbsp;&nbsp;<span class='category_text'>\ref group_class_\1, \ref group_class_\2</span></div>"
  98. ALIASES += category{3}="\ingroup group_class_\1 group_class_\2 group_class_\3 \n<div><span class='category'>Category:</span>&nbsp;&nbsp;<span class='category_text'>\ref group_class_\1, \ref group_class_\2, \ref group_class_\3</span></div>"
  99. ALIASES += library{1}="<h2></h2><div><span class='lib'>Library:</span>&nbsp;&nbsp;<span class='lib_text'>\ref page_libs_\1</span></div>"
  100. ALIASES += nolibrary="<h2></h2><div><span class='lib'>Library:</span>&nbsp;&nbsp;<span class='lib_text'>None; this class implementation is entirely header-based.</span></div>"
  101. ALIASES += stdobjects="<span class='stdobj'>Predefined objects/pointers:</span>"
  102. # native implementation infos:
  103. ALIASES += nativeimpl{1}="<div><span class='impl'>Implementations:</span>&nbsp;&nbsp;native under \ref page_port_\1 port; a generic implementation is used elsewhere.</div>"
  104. ALIASES += nativeimpl{2}="<div><span class='impl'>Implementations:</span>&nbsp;&nbsp;native under \ref page_port_\1, \ref page_port_\2 ports; a generic implementation is used elsewhere.</div>"
  105. ALIASES += nativeimpl{3}="<div><span class='impl'>Implementations:</span>&nbsp;&nbsp;native under \ref page_port_\1, \ref page_port_\2, \ref page_port_\3 ports; a generic implementation is used elsewhere.</div>"
  106. ALIASES += nativeimpl{4}="<div><span class='impl'>Implementations:</span>&nbsp;&nbsp;native under \ref page_port_\1, \ref page_port_\2, \ref page_port_\3, \ref page_port_\4 ports; a generic implementation is used elsewhere.</div>"
  107. # onlyfor infos:
  108. # NOTE: we need to be able to retrieve these infos also from the XML output, thus
  109. # we use the \xmlonly and \endxmlonly commands to include custom XML tags
  110. ALIASES += onlyfor{1}="<div><span class='avail'>Availability:</span>&nbsp;&nbsp;only available for the \ref page_port_\1 port.</div> \xmlonly <onlyfor>\1</onlyfor> \endxmlonly"
  111. ALIASES += onlyfor{2}="<div><span class='avail'>Availability:</span>&nbsp;&nbsp;only available for the \ref page_port_\1, \ref page_port_\2 ports.</div> \xmlonly <onlyfor>\1,\2</onlyfor> \endxmlonly"
  112. ALIASES += onlyfor{3}="<div><span class='avail'>Availability:</span>&nbsp;&nbsp;only available for the \ref page_port_\1, \ref page_port_\2, \ref page_port_\3 ports.</div> \xmlonly <onlyfor>\1,\2,\3</onlyfor> \endxmlonly"
  113. ALIASES += onlyfor{4}="<div><span class='avail'>Availability:</span>&nbsp;&nbsp;only available for the \ref page_port_\1, \ref page_port_\2, \ref page_port_\3, \ref page_port_\4 ports.</div> \xmlonly <onlyfor>\1,\2,\3,\4</onlyfor> \endxmlonly"
  114. # Use this in grouped global functions, and macros since they
  115. # wouldn't otherwise indicate what header they are defined in.
  116. ALIASES += header{1}="Include file:\n \verbatim #include <\1> \endverbatim"
  117. # some formatting aliases
  118. ALIASES += true="<span class='literal'>true</span>"
  119. ALIASES += false="<span class='literal'>false</span>"
  120. ALIASES += NULL="<span class='literal'>NULL</span>"
  121. ALIASES += NUL="<span class='literal'>NUL</span>"
  122. # NOTE: these are important as you can't write in the docs
  123. # just #ifdef since the # character is used by Doxygen
  124. # for explicit linking; use the following aliases instead!
  125. # However to avoid overwriting e.g. \if Doxygen command the _
  126. # character is postfixed
  127. ALIASES += ifdef_="<span class='literal'>\#ifdef</span>"
  128. ALIASES += ifndef_="<span class='literal'>\#ifndef</span>"
  129. ALIASES += if_="<span class='literal'>\#if</span>"
  130. ALIASES += endif_="<span class='literal'>\#endif</span>"
  131. # table aliases for 2 and 3 column tables
  132. ALIASES += beginTable="<table class='doctable' border='1' cellspacing='0' cellpadding='3'>"
  133. ALIASES += beginInvisibleTable="<table class='doctable' border='0' cellspacing='0' cellpadding='4'>"
  134. ALIASES += row2col{2}="<tr><td>\1</td> <td>\2</td></tr>"
  135. ALIASES += row2col{3}="<tr><td>\1</td> <td>\2,\3</td></tr>"
  136. ALIASES += row2col{4}="<tr><td>\1</td> <td>\2,\3,\4</td></tr>"
  137. ALIASES += row2col{5}="<tr><td>\1</td> <td>\2,\3,\4,\5</td></tr>"
  138. ALIASES += row2col{6}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6</td></tr>"
  139. ALIASES += row2col{7}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7</td></tr>"
  140. ALIASES += row2col{8}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8</td></tr>"
  141. ALIASES += row2col{9}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8,\9</td></tr>"
  142. ALIASES += row2col{10}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
  143. ALIASES += row3col{3}="<tr><td>\1</td> <td>\2</td> <td>\3</td></tr>"
  144. ALIASES += row3col{4}="<tr><td>\1</td> <td>\2</td> <td>\3,\4</td></tr>"
  145. ALIASES += row3col{5}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5</td></tr>"
  146. ALIASES += row3col{6}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6</td></tr>"
  147. ALIASES += row3col{7}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7</td></tr>"
  148. ALIASES += row3col{8}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8</td></tr>"
  149. ALIASES += row3col{9}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8,\9</td></tr>"
  150. ALIASES += row3col{10}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
  151. ALIASES += hdr3col{3}="<tr><th>\1</th> <th>\2</th> <th>\3</th></tr>"
  152. ALIASES += endTable="</table>"
  153. # definition list aliases
  154. # a definition list currently is rendered as 2-column table but it may use as
  155. # well the <dl>, <dt> and <dd> HTML tags in future.
  156. # In any case a definition list differs from a table because of its semantic
  157. # nature and because it is always the association of a "title" with a "description"
  158. # (in contrast a table may have more than 2 columns of data)...
  159. ALIASES += beginDefList="<table class='doclist' border='1' cellspacing='0'>"
  160. ALIASES += itemdef{2}="<tr><td><span class='itemdef'>\1</span></td> <td>\2</td></tr>"
  161. ALIASES += itemdef{3}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3</td></tr>"
  162. ALIASES += itemdef{4}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4</td></tr>"
  163. ALIASES += itemdef{5}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5</td></tr>"
  164. ALIASES += itemdef{6}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6</td></tr>"
  165. ALIASES += itemdef{7}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7</td></tr>"
  166. ALIASES += itemdef{8}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8</td></tr>"
  167. ALIASES += itemdef{9}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8,\9</td></tr>"
  168. ALIASES += itemdef{10}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
  169. ALIASES += endDefList="</table>"
  170. ALIASES += stock{3}="<tr><td><span class='itemdef'>\1</span></td> <td> @image html gtk-\2.png\n</td><td>\3</td></tr>"
  171. # Aliases for documenting wxPerl/wxPython-specific parts
  172. #---------------------------------------------------------------------------
  173. # See ENABLED_SECTIONS configuration key for more info about these:
  174. ALIASES += beginWxPerlOnly="\if WXPERL_MANUAL <b>wxPerl Note:</b> "
  175. ALIASES += endWxPerlOnly="\endif"
  176. # This is to get around a bug in Doxygen that prevents use of '{' or '}'
  177. # inside of any aliased command in parameters.
  178. ALIASES += leftCurly="{"
  179. ALIASES += rightCurly="}"
  180. # Aliases for documenting samples
  181. #---------------------------------------------------------------------------
  182. # For indicating a sample location
  183. ALIASES += sampledir{1}="@e Location: @c samples/\1 subdirectory of your wxWidgets installation or http://svn.wxwidgets.org/viewvc/wx/wxWidgets/trunk/samples/\1"
  184. # For refering to the corresponding sample in a class document or a overview
  185. # Usually placed in the queue of @see
  186. ALIASES += sample{1}="\ref page_samples_\1"
  187. # For generating a general description for a sample
  188. # \1 could be a class or an overview or a descriptive sentence
  189. # Shall be replaced by manual written description soon
  190. ALIASES += sampleabout{1}="This sample demonstrates \1."
  191. # For indicating the necessary condition of a sample or a class
  192. # \1 is the wxUSE_XXX macro
  193. ALIASES += buildwith{1}="<b>Build Note:</b> You may need to build the wxWidgets library with <tt>\1</tt> being set to 1 to be able to make it work, please read comments in @c <wx/setup_inc.h> for more info."
  194. ALIASES += buildwith{2}="<b>Build Note:</b> You may need to build the wxWidgets library with <tt>\1</tt> and <tt>\2</tt> being set to 1 to be able to make it work, please read comments in @c <wx/setup_inc.h> for more info."
  195. #---------------------------------------------------------------------------
  196. # Build Options
  197. #---------------------------------------------------------------------------
  198. EXTRACT_ALL = YES # Default: NO
  199. EXTRACT_PRIVATE = NO
  200. EXTRACT_PACKAGE = NO
  201. EXTRACT_STATIC = YES # Default: NO
  202. EXTRACT_LOCAL_CLASSES = YES
  203. EXTRACT_LOCAL_METHODS = NO
  204. EXTRACT_ANON_NSPACES = YES # TODO: Default: NO
  205. HIDE_UNDOC_MEMBERS = NO
  206. HIDE_UNDOC_CLASSES = NO
  207. HIDE_FRIEND_COMPOUNDS = NO
  208. HIDE_IN_BODY_DOCS = NO
  209. INTERNAL_DOCS = NO
  210. CASE_SENSE_NAMES = NO # Default: YES
  211. HIDE_SCOPE_NAMES = NO
  212. SHOW_INCLUDE_FILES = YES
  213. FORCE_LOCAL_INCLUDES = NO
  214. INLINE_INFO = YES
  215. SORT_MEMBER_DOCS = YES
  216. SORT_BRIEF_DOCS = NO # Don't set to YES, it renders our named groups out of order.
  217. SORT_MEMBERS_CTORS_1ST = NO # Default: NO
  218. SORT_GROUP_NAMES = YES # Default: NO
  219. SORT_BY_SCOPE_NAME = NO
  220. STRICT_PROTO_MATCHING = NO
  221. GENERATE_TODOLIST = YES
  222. GENERATE_TESTLIST = YES
  223. GENERATE_BUGLIST = YES
  224. GENERATE_DEPRECATEDLIST= YES
  225. # can contain WXPERL_MANUAL, WXPYTHON_MANUAL keywords
  226. ENABLED_SECTIONS = WXPERL_MANUAL WXPYTHON_MANUAL
  227. MAX_INITIALIZER_LINES = 30
  228. SHOW_USED_FILES = NO # Default: YES
  229. SHOW_FILES = YES
  230. SHOW_NAMESPACES = NO # TODO: Default: YES
  231. FILE_VERSION_FILTER =
  232. LAYOUT_FILE = DoxygenLayout.xml
  233. CITE_BIB_FILES =
  234. #---------------------------------------------------------------------------
  235. # Warning and Progress Message Options
  236. #---------------------------------------------------------------------------
  237. QUIET = YES # Default: NO
  238. WARNINGS = YES
  239. WARN_IF_UNDOCUMENTED = YES
  240. WARN_IF_DOC_ERROR = YES
  241. WARN_NO_PARAMDOC = YES # Default: NO
  242. WARN_FORMAT = "$file:$line: $text"
  243. WARN_LOGFILE = doxygen.log
  244. #---------------------------------------------------------------------------
  245. # Input File Options
  246. #---------------------------------------------------------------------------
  247. INPUT = mainpages groups overviews ../../interface
  248. INPUT_ENCODING = UTF-8
  249. FILE_PATTERNS = *.h
  250. RECURSIVE = YES # Default: NO
  251. EXCLUDE =
  252. EXCLUDE_SYMLINKS = NO
  253. EXCLUDE_PATTERNS =
  254. EXCLUDE_SYMBOLS =
  255. EXAMPLE_PATH = ../
  256. EXAMPLE_PATTERNS = *
  257. EXAMPLE_RECURSIVE = NO
  258. IMAGE_PATH = images
  259. INPUT_FILTER =
  260. FILTER_PATTERNS =
  261. FILTER_SOURCE_FILES = NO
  262. FILTER_SOURCE_PATTERNS =
  263. #---------------------------------------------------------------------------
  264. # Source Browsing Options
  265. #---------------------------------------------------------------------------
  266. SOURCE_BROWSER = NO
  267. INLINE_SOURCES = NO
  268. STRIP_CODE_COMMENTS = YES
  269. REFERENCED_BY_RELATION = NO
  270. REFERENCES_RELATION = NO
  271. REFERENCES_LINK_SOURCE = YES
  272. USE_HTAGS = NO
  273. VERBATIM_HEADERS = NO # Default: YES
  274. #---------------------------------------------------------------------------
  275. # Alphabetical Class Index Options
  276. #---------------------------------------------------------------------------
  277. ALPHABETICAL_INDEX = YES
  278. COLS_IN_ALPHA_INDEX = 5
  279. IGNORE_PREFIX = wx
  280. #---------------------------------------------------------------------------
  281. # HTML Output Options
  282. #---------------------------------------------------------------------------
  283. GENERATE_HTML = $(GENERATE_HTML)
  284. HTML_OUTPUT = html
  285. HTML_FILE_EXTENSION = .html
  286. HTML_HEADER = custom_header.html
  287. HTML_FOOTER = custom_footer.html
  288. HTML_STYLESHEET =
  289. HTML_EXTRA_STYLESHEET = extra_stylesheet.css
  290. HTML_EXTRA_FILES = wxwidgets.js
  291. HTML_COLORSTYLE_HUE = 220 # Default: 220
  292. HTML_COLORSTYLE_SAT = 255 # Default: 100
  293. HTML_COLORSTYLE_GAMMA = 100 # Default: 80
  294. HTML_TIMESTAMP = YES
  295. HTML_DYNAMIC_SECTIONS = YES # Default: NO
  296. HTML_INDEX_NUM_ENTRIES = 100
  297. DISABLE_INDEX = NO
  298. ENUM_VALUES_PER_LINE = 1 # Default: 4
  299. GENERATE_TREEVIEW = NO
  300. TREEVIEW_WIDTH = 250
  301. EXT_LINKS_IN_WINDOW = YES # Default: NO
  302. FORMULA_FONTSIZE = 10
  303. FORMULA_TRANSPARENT = YES
  304. USE_MATHJAX = NO
  305. MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
  306. MATHJAX_EXTENSIONS =
  307. SEARCHENGINE = $(SEARCHENGINE)
  308. SERVER_BASED_SEARCH = $(SERVER_BASED_SEARCH)
  309. #---------------------------------------------------------------------------
  310. # Docset Output Options
  311. #---------------------------------------------------------------------------
  312. GENERATE_DOCSET = $(GENERATE_DOCSET)
  313. DOCSET_FEEDNAME = "wxWidgets 3.0"
  314. DOCSET_BUNDLE_ID = org.wxwidgets.doxygen.wx30
  315. DOCSET_PUBLISHER_ID = org.wxwidgets.doxygen
  316. DOCSET_PUBLISHER_NAME = wxWidgets Team
  317. #---------------------------------------------------------------------------
  318. # CHM Output Options
  319. #---------------------------------------------------------------------------
  320. GENERATE_HTMLHELP = $(GENERATE_HTMLHELP)
  321. CHM_FILE = ..\wx.chm # Windows style separator is required.
  322. HHC_LOCATION = hhc.exe
  323. GENERATE_CHI = NO
  324. CHM_INDEX_ENCODING =
  325. BINARY_TOC = NO
  326. TOC_EXPAND = NO
  327. #---------------------------------------------------------------------------
  328. # QHP Output Options
  329. #---------------------------------------------------------------------------
  330. GENERATE_QHP = $(GENERATE_QHP)
  331. QCH_FILE =
  332. QHP_NAMESPACE = org.wxwidgets.doxygen
  333. QHP_VIRTUAL_FOLDER = doc
  334. QHP_CUST_FILTER_NAME =
  335. QHP_CUST_FILTER_ATTRS =
  336. QHP_SECT_FILTER_ATTRS =
  337. QHG_LOCATION =
  338. #---------------------------------------------------------------------------
  339. # Eclipse Output Options
  340. #---------------------------------------------------------------------------
  341. GENERATE_ECLIPSEHELP = NO
  342. ECLIPSE_DOC_ID = org.wxwidgets.doxygen
  343. #---------------------------------------------------------------------------
  344. # LaTeX Output Options
  345. #---------------------------------------------------------------------------
  346. GENERATE_LATEX = $(GENERATE_LATEX)
  347. LATEX_OUTPUT = latex
  348. LATEX_CMD_NAME = latex
  349. MAKEINDEX_CMD_NAME = makeindex
  350. COMPACT_LATEX = NO
  351. PAPER_TYPE = a4wide
  352. EXTRA_PACKAGES =
  353. LATEX_HEADER = latexdocstart.inc
  354. LATEX_FOOTER =
  355. PDF_HYPERLINKS = YES
  356. USE_PDFLATEX = YES
  357. LATEX_BATCHMODE = YES # Default: NO
  358. LATEX_HIDE_INDICES = NO
  359. LATEX_SOURCE_CODE = NO
  360. LATEX_BIB_STYLE = plain
  361. #---------------------------------------------------------------------------
  362. # RTF Output Options
  363. #---------------------------------------------------------------------------
  364. GENERATE_RTF = NO
  365. RTF_OUTPUT = rtf
  366. COMPACT_RTF = NO
  367. RTF_HYPERLINKS = NO
  368. RTF_STYLESHEET_FILE =
  369. RTF_EXTENSIONS_FILE =
  370. #---------------------------------------------------------------------------
  371. # Man Page Output Options
  372. #---------------------------------------------------------------------------
  373. GENERATE_MAN = NO
  374. MAN_OUTPUT = man
  375. MAN_EXTENSION = .3
  376. MAN_LINKS = NO
  377. #---------------------------------------------------------------------------
  378. # XML Output Options
  379. #---------------------------------------------------------------------------
  380. GENERATE_XML = $(GENERATE_XML)
  381. XML_OUTPUT = xml
  382. XML_SCHEMA =
  383. XML_DTD =
  384. XML_PROGRAMLISTING = NO # Default: YES
  385. #---------------------------------------------------------------------------
  386. # AutoGen Definitions Output Options
  387. #---------------------------------------------------------------------------
  388. GENERATE_AUTOGEN_DEF = NO
  389. #---------------------------------------------------------------------------
  390. # Perl Module Output Options
  391. #---------------------------------------------------------------------------
  392. GENERATE_PERLMOD = NO
  393. PERLMOD_LATEX = YES # Default: NO
  394. PERLMOD_PRETTY = YES
  395. PERLMOD_MAKEVAR_PREFIX =
  396. #---------------------------------------------------------------------------
  397. # Preprocessor Options
  398. #---------------------------------------------------------------------------
  399. ENABLE_PREPROCESSING = YES
  400. MACRO_EXPANSION = NO
  401. EXPAND_ONLY_PREDEF = NO
  402. SEARCH_INCLUDES = YES
  403. INCLUDE_PATH =
  404. INCLUDE_FILE_PATTERNS =
  405. PREDEFINED = wxUSE_BASE wxUSE_GUI
  406. EXPAND_AS_DEFINED =
  407. SKIP_FUNCTION_MACROS = YES
  408. #---------------------------------------------------------------------------
  409. # Additions Related to External References
  410. #---------------------------------------------------------------------------
  411. TAGFILES =
  412. GENERATE_TAGFILE =
  413. ALLEXTERNALS = NO
  414. EXTERNAL_GROUPS = YES
  415. PERL_PATH = /usr/bin/perl
  416. #---------------------------------------------------------------------------
  417. # dot Tool Options
  418. #---------------------------------------------------------------------------
  419. CLASS_DIAGRAMS = YES
  420. MSCGEN_PATH =
  421. HIDE_UNDOC_RELATIONS = YES
  422. HAVE_DOT = YES # Default: NO
  423. DOT_NUM_THREADS = 0
  424. DOT_FONTNAME = FreeSans # Default: Helvetica
  425. DOT_FONTSIZE = 10
  426. DOT_FONTPATH =
  427. CLASS_GRAPH = YES
  428. COLLABORATION_GRAPH = NO # Default: YES
  429. GROUP_GRAPHS = NO # Default: YES
  430. UML_LOOK = NO
  431. UML_LIMIT_NUM_FIELDS = 10
  432. TEMPLATE_RELATIONS = NO
  433. INCLUDE_GRAPH = NO # Default: YES
  434. INCLUDED_BY_GRAPH = NO # Default: YES
  435. CALL_GRAPH = NO
  436. CALLER_GRAPH = NO
  437. GRAPHICAL_HIERARCHY = NO # TODO: Default: YES
  438. DIRECTORY_GRAPH = NO # Default: YES
  439. DOT_IMAGE_FORMAT = png
  440. INTERACTIVE_SVG = NO
  441. DOTFILE_DIRS =
  442. MSCFILE_DIRS =
  443. DOT_GRAPH_MAX_NODES = 50
  444. MAX_DOT_GRAPH_DEPTH = 1000 # Default: 0
  445. DOT_TRANSPARENT = NO
  446. DOT_MULTI_TARGETS = NO
  447. GENERATE_LEGEND = YES
  448. DOT_CLEANUP = YES
  449. # Instead of setting a value for DOT_PATH it's easier and more portable to
  450. # put your dot utility in the PATH. On Windows you'll need to install GraphViz
  451. # tools, and then manually add it to the PATH environment variable.
  452. DOT_PATH =