489 in an output format independent way. The create the layout file that represents |
489 in an output format independent way. The create the layout file that represents |
490 doxygen's defaults, run doxygen with the -l option. You can optionally specify a |
490 doxygen's defaults, run doxygen with the -l option. You can optionally specify a |
491 file name after the option, if omitted DoxygenLayout.xml will be used as the name |
491 file name after the option, if omitted DoxygenLayout.xml will be used as the name |
492 of the layout file. |
492 of the layout file. |
493 ' defval=''/> |
493 ' defval=''/> |
|
494 <option type='bool' id='OUTPUT_INCLUDES' docs=' |
|
495 If set this will write out documentation for #included files so that links can be |
|
496 made from INPUT files to them. |
|
497 if PREPROCESS_INCLUDES is not set then this has no effect. |
|
498 You are strongly advised to have EXTRACT_ALL = YES, if not some include files |
|
499 may not be linkable to. |
|
500 ' defval='0'/> |
494 </group> |
501 </group> |
495 <group name='Messages' docs='configuration options related to warning and progress messages'> |
502 <group name='Messages' docs='configuration options related to warning and progress messages'> |
496 <option type='bool' id='QUIET' docs=' |
503 <option type='bool' id='QUIET' docs=' |
497 The QUIET tag can be used to turn on/off the messages that are generated |
504 The QUIET tag can be used to turn on/off the messages that are generated |
498 by doxygen. Possible values are YES and NO. If left blank NO is used. |
505 by doxygen. Possible values are YES and NO. If left blank NO is used. |
1123 generate DITA XML files that captures the structure of |
1130 generate DITA XML files that captures the structure of |
1124 the code including all documentation. |
1131 the code including all documentation. |
1125 See: http://www.oasis-open.org/committees/dita/ |
1132 See: http://www.oasis-open.org/committees/dita/ |
1126 ' defval='0'/> |
1133 ' defval='0'/> |
1127 <option type='string' id='XML_DITA_OUTPUT' format='dir' docs=' |
1134 <option type='string' id='XML_DITA_OUTPUT' format='dir' docs=' |
1128 The XML_DITA_ OUTPUT tag is used to specify where the DITA XML pages will be put. |
1135 The XML_DITA_OUTPUT tag is used to specify where the DITA XML pages will be put. |
1129 If a relative path is entered the value of OUTPUT_DIRECTORY will be |
1136 If a relative path is entered the value of OUTPUT_DIRECTORY will be |
1130 put in front of it. If left blank `dita' will be used as the default path. |
1137 put in front of it. If left blank `dita' will be used as the default path. |
1131 ' defval='dita' depends='GENERATE_XML_DITA'/> |
1138 ' defval='dita' depends='GENERATE_XML_DITA'/> |
|
1139 <option type='string' id='XML_DITA_EXTENSION' format='string' docs=' |
|
1140 The XML_DITA_EXTENSION is used to specify the file extension for DITA XML pages. |
|
1141 ' defval='.xml' depends='GENERATE_XML_DITA'/> |
|
1142 <option type='string' id='XML_DITA_EXTENSION_DITAMAP' format='string' docs=' |
|
1143 The XML_DITA_EXTENSION_DITAMAP is used to specify the file extension for DITA maps. |
|
1144 ' defval='.ditamap' depends='GENERATE_XML_DITA'/> |
|
1145 <option type='bool' id='XML_DITA_OMIT_UNLINKABLE' docs=' |
|
1146 If the XML_DITA_OMIT_UNLINKABLE tag is set to YES Doxygen will |
|
1147 not generate DITA XML files for classes that are not fully defined |
|
1148 (i.e. classes that have member functions that are declared but not defined). |
|
1149 This happens in component based builds where where Doxygen can see class |
|
1150 declarations in a header file but not the implememtation of those declarations. |
|
1151 In that case the documentation for those classes will not be generated. |
|
1152 ' defval='0' depends='GENERATE_XML_DITA'/> |
|
1153 <option type='bool' id='XML_DITA_OMIT_DUPLICATE_MEMBERS' docs=' |
|
1154 If the XML_DITA_OMIT_DUPLICATE_MEMBERS tag is set to YES Doxygen will |
|
1155 not generate DITA XML members that have duplicate IDs. |
|
1156 ' defval='0' depends='GENERATE_XML_DITA'/> |
1132 </group> |
1157 </group> |
1133 <group name='DEF' docs='configuration options for the AutoGen Definitions output'> |
1158 <group name='DEF' docs='configuration options for the AutoGen Definitions output'> |
1134 <option type='bool' id='GENERATE_AUTOGEN_DEF' docs=' |
1159 <option type='bool' id='GENERATE_AUTOGEN_DEF' docs=' |
1135 If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will |
1160 If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will |
1136 generate an AutoGen Definitions (see autogen.sf.net) file |
1161 generate an AutoGen Definitions (see autogen.sf.net) file |
1221 doxygen's preprocessor will remove all function-like macros that are alone |
1246 doxygen's preprocessor will remove all function-like macros that are alone |
1222 on a line, have an all uppercase name, and do not end with a semicolon. Such |
1247 on a line, have an all uppercase name, and do not end with a semicolon. Such |
1223 function macros are typically used for boiler-plate code, and will confuse |
1248 function macros are typically used for boiler-plate code, and will confuse |
1224 the parser if not removed. |
1249 the parser if not removed. |
1225 ' defval='1' depends='ENABLE_PREPROCESSING'/> |
1250 ' defval='1' depends='ENABLE_PREPROCESSING'/> |
1226 <option type='list' id='PRE_INCLUDES' format='string' docs=' |
|
1227 The PRE_INCLUDES tag can be used to specify a list of files names that will be |
|
1228 #include'd before preprocesing any file. The files will be included in the |
|
1229 order specified by the PRE_INCLUDES tag. |
|
1230 For example if the PRE_INCLUDES has "foo.h" in it this will be treated as if |
|
1231 #include "foo.h" preceeded each input file. |
|
1232 ' defval='0' depends='ENABLE_PREPROCESSING'/> |
|
1233 <option type='bool' id='PREPROCESS_INCLUDES' docs=' |
1251 <option type='bool' id='PREPROCESS_INCLUDES' docs=' |
1234 If the PREPROCESS_INCLUDES tag is set to YES then doxygen's preprocessor will |
1252 If the PREPROCESS_INCLUDES tag is set to YES then doxygen's preprocessor will |
1235 search for all #include'd files according the search paths and feed them to |
1253 search for all #include'd files according the search paths and feed them to |
1236 the preprocessor. This means that documentation will be generated for those |
1254 the preprocessor. This means that documentation will be generated for those |
1237 #include'd files as well. If set to NO (the default) then the #include |
1255 #include'd files as well. If set to NO (the default) then the #include |
1238 statements will be ignored and documentation on #include'd files will only |
1256 statements will be ignored and documentation on #include'd files will only |
1239 be generated if they are in the INPUT. |
1257 be generated if they are in the INPUT. |
|
1258 ' defval='0' depends='ENABLE_PREPROCESSING'/> |
|
1259 <option type='bool' id='PREPROCCESS_FULL_TU' docs=' |
|
1260 If set then Doxygen will always preprocess the complete translation unit for each |
|
1261 INPUT. This gives a more accurate picture of the contents of the INPUT but may |
|
1262 take considerably longer to run. |
1240 ' defval='0' depends='ENABLE_PREPROCESSING'/> |
1263 ' defval='0' depends='ENABLE_PREPROCESSING'/> |
1241 </group> |
1264 </group> |
1242 <group name='External' docs='Configuration::additions related to external references'> |
1265 <group name='External' docs='Configuration::additions related to external references'> |
1243 <option type='list' id='TAGFILES' format='file' docs=' |
1266 <option type='list' id='TAGFILES' format='file' docs=' |
1244 The TAGFILES option can be used to specify one or more tagfiles. |
1267 The TAGFILES option can be used to specify one or more tagfiles. |