← Back to branch summary

~j-rivero/+junk/doxygen

« back to all changes in this revision

Viewing changes to doc/config.doc

  • Committer: Package Import Robot
  • Author(s): Helmut Grohne
  • Date: 2014-05-16 20:58:26 UTC
  • mfrom: (1.1.33)
  • Revision ID: package-import@ubuntu.com-20140516205826-bmlvn4pltxejeyzk
Tags: 1.8.7-1
* doxygen 1.8.7 release.
  + Standard build regenerates *_js.h now. Update README.jquery.
  + Add doxygen.NEWS for GENERATE_HTML default change.
  + Refresh patches. dot-config.diff completely rewritten against
    config.xml.
* Uglify javascript during build. Therefore B-D: yui-compressor.
* Also remove winbuild to avoid accidentally using it.
* Add half a stage1 build-profile to drop libqt4-dev. Not annotating the
  dependency because #744246. Thanks to Daniel Schepler and Wookey.
  (Addresses: #738263)

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/config.doc
6
6
 *
7
7
 * 
8
8
 *
9
 
 * Copyright (C) 1997-2013 by Dimitri van Heesch.
 
9
 * Copyright (C) 1997-2014 by Dimitri van Heesch.
10
10
 *
11
11
 * Permission to use, copy, modify, and distribute this software and its
12
12
 * documentation under the terms of the GNU General Public License is hereby 
66
66
\refitem cfg_abbreviate_brief ABBREVIATE_BRIEF
67
67
\refitem cfg_aliases ALIASES
68
68
\refitem cfg_allexternals ALLEXTERNALS
 
69
\refitem cfg_allow_unicode_names ALLOW_UNICODE_NAMES
69
70
\refitem cfg_alphabetical_index ALPHABETICAL_INDEX
70
71
\refitem cfg_always_detailed_sec ALWAYS_DETAILED_SEC
71
72
\refitem cfg_autolink_support AUTOLINK_SUPPORT
225
226
\refitem cfg_man_extension MAN_EXTENSION
226
227
\refitem cfg_man_links MAN_LINKS
227
228
\refitem cfg_man_output MAN_OUTPUT
 
229
\refitem cfg_man_subdir MAN_SUBDIR
228
230
\refitem cfg_markdown_support MARKDOWN_SUPPORT
229
231
\refitem cfg_mathjax_codefile MATHJAX_CODEFILE
230
232
\refitem cfg_mathjax_extensions MATHJAX_EXTENSIONS
316
318
\refitem cfg_warn_if_undocumented WARN_IF_UNDOCUMENTED
317
319
\refitem cfg_warn_logfile WARN_LOGFILE
318
320
\refitem cfg_warn_no_paramdoc WARN_NO_PARAMDOC
319
 
\refitem cfg_xml_dtd XML_DTD
320
321
\refitem cfg_xml_output XML_OUTPUT
321
322
\refitem cfg_xml_programlisting XML_PROGRAMLISTING
322
 
\refitem cfg_xml_schema XML_SCHEMA
323
323
\endsecreflist
324
324
\section config_project Project related configuration options
325
325
 \anchor cfg_doxyfile_encoding
388
388
 
389
389
The default value is: <code>NO</code>.
390
390
 
 
391
 \anchor cfg_allow_unicode_names
 
392
<dt>\c ALLOW_UNICODE_NAMES <dd>
 
393
 \addindex ALLOW_UNICODE_NAMES
 
394
 If the \c ALLOW_UNICODE_NAMES tag is set to \c YES,
 
395
 doxygen will allow non-ASCII characters to appear in the names of generated files. 
 
396
 If set to \c NO, non-ASCII characters will be escaped, for example _xE3_x81_x84 
 
397
 will be used for Unicode U+3044.
 
398
 
 
399
 
 
400
The default value is: <code>NO</code>.
 
401
 
391
402
 \anchor cfg_output_language
392
403
<dt>\c OUTPUT_LANGUAGE <dd>
393
404
 \addindex OUTPUT_LANGUAGE
697
708
 Doxygen has a built-in mapping, but you can override or extend it using this tag.
698
709
 The format is <code>ext=language</code>, where \c ext is a file extension, and language is one of
699
710
 the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
700
 
 Objective-C, Python, Fortran, VHDL. 
 
711
 Objective-C, Python, Fortran (fixed format Fortran: FortranFixed,
 
712
 free formatted Fortran: FortranFree, unknown formatted Fortran: Fortran. In
 
713
 the later case the parser tries to guess whether the code is fixed or free
 
714
 formatted code, this is the default for Fortran type files), VHDL. 
701
715
 
702
716
 For instance to make doxygen treat
703
717
 <code>.inc</code> files as Fortran files (default is PHP), and <code>.f</code> files as C (default is Fortran),
1698
1712
<dt>\c CLANG_ASSISTED_PARSING <dd>
1699
1713
 \addindex CLANG_ASSISTED_PARSING
1700
1714
  If the \c CLANG_ASSISTED_PARSING tag is set to \c YES, then doxygen will use the 
1701
 
  <a href="http://clang.llvm.org/">clang parser</a> for more acurate parsing 
 
1715
  <a href="http://clang.llvm.org/">clang parser</a> for more accurate parsing 
1702
1716
  at the cost of reduced performance. This can be particularly helpful with 
1703
1717
  template rich C++ code for which doxygen's built-in parser lacks the 
1704
1718
  necessary type information.
2191
2205
 \addindex BINARY_TOC
2192
2206
 The \c BINARY_TOC flag
2193
2207
 controls whether a binary table of contents is generated (\c YES) or a
2194
 
 normal table of contents (\c NO) in the `.chm` file.
 
2208
 normal table of contents (\c NO) in the `.chm` file. Furthermore it enables
 
2209
 the `Previous` and `Next` buttons.
2195
2210
 
2196
2211
 
2197
2212
The default value is: <code>NO</code>.
2544
2559
When the \c SERVER_BASED_SEARCH tag is enabled the search engine will be 
2545
2560
implemented using a web server instead of a web client using Javascript. 
2546
2561
 
2547
 
There are two flavours of web server based searching depending on the 
 
2562
There are two flavors of web server based searching depending on the 
2548
2563
\ref cfg_external_search "EXTERNAL_SEARCH" setting. When disabled, 
2549
2564
doxygen will generate a PHP script for searching and an index file used 
2550
2565
by the script. When \ref cfg_external_search "EXTERNAL_SEARCH" is 
2954
2969
 
2955
2970
 
2956
2971
This tag requires that the tag \ref cfg_generate_man "GENERATE_MAN" is set to \c YES.
 
2972
 \anchor cfg_man_subdir
 
2973
<dt>\c MAN_SUBDIR <dd>
 
2974
 \addindex MAN_SUBDIR
 
2975
 The \c MAN_SUBDIR tag determines the name of the directory created within \c MAN_OUTPUT
 
2976
 in which the man pages are placed. If defaults to man followed by \c MAN_EXTENSION
 
2977
 with the initial . removed.
 
2978
 
 
2979
 
 
2980
This tag requires that the tag \ref cfg_generate_man "GENERATE_MAN" is set to \c YES.
2957
2981
 \anchor cfg_man_links
2958
2982
<dt>\c MAN_LINKS <dd>
2959
2983
 \addindex MAN_LINKS
2992
3016
 
2993
3017
 
2994
3018
This tag requires that the tag \ref cfg_generate_xml "GENERATE_XML" is set to \c YES.
2995
 
 \anchor cfg_xml_schema
2996
 
<dt>\c XML_SCHEMA <dd>
2997
 
 \addindex XML_SCHEMA
2998
 
 The \c XML_SCHEMA tag can be used to specify a XML schema,
2999
 
 which can be used by a validating XML parser to check the
3000
 
 syntax of the XML files.
3001
 
 
3002
 
 
3003
 
This tag requires that the tag \ref cfg_generate_xml "GENERATE_XML" is set to \c YES.
3004
 
 \anchor cfg_xml_dtd
3005
 
<dt>\c XML_DTD <dd>
3006
 
 \addindex XML_DTD
3007
 
 The \c XML_DTD tag can be used to specify a XML DTD,
3008
 
 which can be used by a validating XML parser to check the
3009
 
 syntax of the XML files.
3010
 
 
3011
 
 
3012
 
This tag requires that the tag \ref cfg_generate_xml "GENERATE_XML" is set to \c YES.
3013
3019
 \anchor cfg_xml_programlisting
3014
3020
<dt>\c XML_PROGRAMLISTING <dd>
3015
3021
 \addindex XML_PROGRAMLISTING
3214
3220
<dt>\c SKIP_FUNCTION_MACROS <dd>
3215
3221
 \addindex SKIP_FUNCTION_MACROS
3216
3222
 If the \c SKIP_FUNCTION_MACROS tag is set to \c YES then 
3217
 
 doxygen's preprocessor will remove all refrences to function-like macros that are alone 
 
3223
 doxygen's preprocessor will remove all references to function-like macros that are alone 
3218
3224
 on a line, have an all uppercase name, and do not end with a semicolon. 
3219
3225
 Such function macros are typically 
3220
3226
 used for boiler-plate code, and will confuse the parser if not removed.
3247
3253
 See the section \ref external for more information about the use of tag files.
3248
3254
 
3249
3255
 \note
3250
 
  Each tag file must have an unique name 
 
3256
  Each tag file must have a unique name 
3251
3257
  (where the name does \e NOT include the path).
3252
3258
  If a tag file is not located in the directory in which doxygen 
3253
3259
  is run, you must also specify the path to the tagfile here.