/[svn]/liblscp/trunk/doc/liblscp.doxygen.in
ViewVC logotype

Diff of /liblscp/trunk/doc/liblscp.doxygen.in

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 3865 by capela, Thu Dec 26 21:18:21 2019 UTC revision 3866 by capela, Sat Mar 27 12:17:51 2021 UTC
# Line 1  Line 1 
1  # Doxyfile 1.8.16  # Doxyfile 1.9.1
2    
3  # This file describes the settings to be used by the documentation system  # This file describes the settings to be used by the documentation system
4  # doxygen (www.doxygen.org) for a project.  # doxygen (www.doxygen.org) for a project.
# Line 32  DOXYFILE_ENCODING      = UTF-8 Line 32  DOXYFILE_ENCODING      = UTF-8
32  # title of most generated pages and in a few other places.  # title of most generated pages and in a few other places.
33  # The default value is: My Project.  # The default value is: My Project.
34    
35  PROJECT_NAME           = @PACKAGE@  PROJECT_NAME           = @PACKAGE_NAME@
36    
37  # The PROJECT_NUMBER tag can be used to enter a project or revision number. This  # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
38  # could be handy for archiving the generated documentation or if some version  # could be handy for archiving the generated documentation or if some version
39  # control system is used.  # control system is used.
40    
41  PROJECT_NUMBER         = @VERSION@  PROJECT_NUMBER         = @PACKAGE_VERSION@
42    
43  # Using the PROJECT_BRIEF tag one can provide an optional one line description  # Using the PROJECT_BRIEF tag one can provide an optional one line description
44  # for a project that appears at the top of each page and should give viewer a  # for a project that appears at the top of each page and should give viewer a
# Line 217  QT_AUTOBRIEF           = NO Line 217  QT_AUTOBRIEF           = NO
217    
218  MULTILINE_CPP_IS_BRIEF = NO  MULTILINE_CPP_IS_BRIEF = NO
219    
220    # By default Python docstrings are displayed as preformatted text and doxygen's
221    # special commands cannot be used. By setting PYTHON_DOCSTRING to NO the
222    # doxygen's special commands can be used and the contents of the docstring
223    # documentation blocks is shown as doxygen documentation.
224    # The default value is: YES.
225    
226    PYTHON_DOCSTRING       = YES
227    
228  # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the  # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
229  # documentation from any documented member that it re-implements.  # documentation from any documented member that it re-implements.
230  # The default value is: YES.  # The default value is: YES.
# Line 253  TAB_SIZE               = 4 Line 261  TAB_SIZE               = 4
261    
262  ALIASES                =  ALIASES                =
263    
 # This tag can be used to specify a number of word-keyword mappings (TCL only).  
 # A mapping has the form "name=value". For example adding "class=itcl::class"  
 # will allow you to use the command class in the itcl::class meaning.  
   
 TCL_SUBST              =  
   
264  # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources  # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
265  # only. Doxygen will then generate output that is more tailored for C. For  # only. Doxygen will then generate output that is more tailored for C. For
266  # instance, some of the names that are used will be different. The list of all  # instance, some of the names that are used will be different. The list of all
# Line 299  OPTIMIZE_OUTPUT_SLICE  = NO Line 301  OPTIMIZE_OUTPUT_SLICE  = NO
301  # parses. With this tag you can assign which parser to use for a given  # parses. With this tag you can assign which parser to use for a given
302  # extension. Doxygen has a built-in mapping, but you can override or extend it  # extension. Doxygen has a built-in mapping, but you can override or extend it
303  # using this tag. The format is ext=language, where ext is a file extension, and  # using this tag. The format is ext=language, where ext is a file extension, and
304  # language is one of the parsers supported by doxygen: IDL, Java, Javascript,  # language is one of the parsers supported by doxygen: IDL, Java, JavaScript,
305  # Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice,  # Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, VHDL,
306  # Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:  # Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
307  # FortranFree, unknown formatted Fortran: Fortran. In the later case the parser  # FortranFree, unknown formatted Fortran: Fortran. In the later case the parser
308  # tries to guess whether the code is fixed or free formatted code, this is the  # tries to guess whether the code is fixed or free formatted code, this is the
309  # default for Fortran type files), VHDL, tcl. For instance to make doxygen treat  # default for Fortran type files). For instance to make doxygen treat .inc files
310  # .inc files as Fortran files (default is PHP), and .f files as C (default is  # as Fortran files (default is PHP), and .f files as C (default is Fortran),
311  # Fortran), use: inc=Fortran f=C.  # use: inc=Fortran f=C.
312  #  #
313  # Note: For files without extension you can use no_extension as a placeholder.  # Note: For files without extension you can use no_extension as a placeholder.
314  #  #
315  # Note that for custom extensions you also need to set FILE_PATTERNS otherwise  # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
316  # the files are not read by doxygen.  # the files are not read by doxygen. When specifying no_extension you should add
317    # * to the FILE_PATTERNS.
318    #
319    # Note see also the list of default file extension mappings.
320    
321  EXTENSION_MAPPING      =  EXTENSION_MAPPING      =
322    
# Line 445  TYPEDEF_HIDES_STRUCT   = NO Line 450  TYPEDEF_HIDES_STRUCT   = NO
450    
451  LOOKUP_CACHE_SIZE      = 0  LOOKUP_CACHE_SIZE      = 0
452    
453    # The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use
454    # during processing. When set to 0 doxygen will based this on the number of
455    # cores available in the system. You can set it explicitly to a value larger
456    # than 0 to get more control over the balance between CPU load and processing
457    # speed. At this moment only the input processing can be done using multiple
458    # threads. Since this is still an experimental feature the default is set to 1,
459    # which efficively disables parallel processing. Please report any issues you
460    # encounter. Generating dot graphs in parallel is controlled by the
461    # DOT_NUM_THREADS setting.
462    # Minimum value: 0, maximum value: 32, default value: 1.
463    
464    NUM_PROC_THREADS       = 1
465    
466  #---------------------------------------------------------------------------  #---------------------------------------------------------------------------
467  # Build related configuration options  # Build related configuration options
468  #---------------------------------------------------------------------------  #---------------------------------------------------------------------------
# Line 508  EXTRACT_LOCAL_METHODS  = NO Line 526  EXTRACT_LOCAL_METHODS  = NO
526    
527  EXTRACT_ANON_NSPACES   = NO  EXTRACT_ANON_NSPACES   = NO
528    
529    # If this flag is set to YES, the name of an unnamed parameter in a declaration
530    # will be determined by the corresponding definition. By default unnamed
531    # parameters remain unnamed in the output.
532    # The default value is: YES.
533    
534    RESOLVE_UNNAMED_PARAMS = YES
535    
536  # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all  # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
537  # undocumented members inside documented classes or files. If set to NO these  # undocumented members inside documented classes or files. If set to NO these
538  # members will be included in the various overviews, but no documentation  # members will be included in the various overviews, but no documentation
# Line 525  HIDE_UNDOC_MEMBERS     = NO Line 550  HIDE_UNDOC_MEMBERS     = NO
550  HIDE_UNDOC_CLASSES     = NO  HIDE_UNDOC_CLASSES     = NO
551    
552  # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend  # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
553  # (class|struct|union) declarations. If set to NO, these declarations will be  # declarations. If set to NO, these declarations will be included in the
554  # included in the documentation.  # documentation.
555  # The default value is: NO.  # The default value is: NO.
556    
557  HIDE_FRIEND_COMPOUNDS  = NO  HIDE_FRIEND_COMPOUNDS  = NO
# Line 545  HIDE_IN_BODY_DOCS      = NO Line 570  HIDE_IN_BODY_DOCS      = NO
570    
571  INTERNAL_DOCS          = NO  INTERNAL_DOCS          = NO
572    
573  # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file  # With the correct setting of option CASE_SENSE_NAMES doxygen will better be
574  # names in lower-case letters. If set to YES, upper-case letters are also  # able to match the capabilities of the underlying filesystem. In case the
575  # allowed. This is useful if you have classes or files whose names only differ  # filesystem is case sensitive (i.e. it supports files in the same directory
576  # in case and if your file system supports case sensitive file names. Windows  # whose names only differ in casing), the option must be set to YES to properly
577  # (including Cygwin) ands Mac users are advised to set this option to NO.  # deal with such files in case they appear in the input. For filesystems that
578    # are not case sensitive the option should be be set to NO to properly deal with
579    # output files written for symbols that only differ in casing, such as for two
580    # classes, one named CLASS and the other named Class, and to also support
581    # references to files without having to specify the exact matching casing. On
582    # Windows (including Cygwin) and MacOS, users should typically set this option
583    # to NO, whereas on Linux or other Unix flavors it should typically be set to
584    # YES.
585  # The default value is: system dependent.  # The default value is: system dependent.
586    
587  CASE_SENSE_NAMES       = YES  CASE_SENSE_NAMES       = YES
# Line 788  WARN_IF_DOC_ERROR      = YES Line 820  WARN_IF_DOC_ERROR      = YES
820  WARN_NO_PARAMDOC       = NO  WARN_NO_PARAMDOC       = NO
821    
822  # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when  # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
823  # a warning is encountered.  # a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS
824    # then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but
825    # at the end of the doxygen process doxygen will return with a non-zero status.
826    # Possible values are: NO, YES and FAIL_ON_WARNINGS.
827  # The default value is: NO.  # The default value is: NO.
828    
829  WARN_AS_ERROR          = NO  WARN_AS_ERROR          = NO
# Line 824  INPUT                  = @top_srcdir@ Line 859  INPUT                  = @top_srcdir@
859  # This tag can be used to specify the character encoding of the source files  # This tag can be used to specify the character encoding of the source files
860  # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses  # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
861  # libiconv (or the iconv built into libc) for the transcoding. See the libiconv  # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
862  # documentation (see: https://www.gnu.org/software/libiconv/) for the list of  # documentation (see:
863  # possible encodings.  # https://www.gnu.org/software/libiconv/) for the list of possible encodings.
864  # The default value is: UTF-8.  # The default value is: UTF-8.
865    
866  INPUT_ENCODING         = UTF-8  INPUT_ENCODING         = UTF-8
# Line 838  INPUT_ENCODING         = UTF-8 Line 873  INPUT_ENCODING         = UTF-8
873  # need to set EXTENSION_MAPPING for the extension otherwise the files are not  # need to set EXTENSION_MAPPING for the extension otherwise the files are not
874  # read by doxygen.  # read by doxygen.
875  #  #
876    # Note the list of default checked file patterns might differ from the list of
877    # default file extension mappings.
878    #
879  # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,  # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
880  # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,  # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
881  # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,  # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
882  # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,  # *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment),
883  # *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice.  # *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, *.vhdl,
884    # *.ucf, *.qsf and *.ice.
885    
886  FILE_PATTERNS          = *.dox \  FILE_PATTERNS          = *.dox \
887                           *.h \                           *.h \
# Line 861  RECURSIVE              = YES Line 900  RECURSIVE              = YES
900  # Note that relative paths are relative to the directory from which doxygen is  # Note that relative paths are relative to the directory from which doxygen is
901  # run.  # run.
902    
903  EXCLUDE                = common.h \  EXCLUDE                =
                          common.c  
904    
905  # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or  # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
906  # directories that are symbolic links (a Unix file system feature) are excluded  # directories that are symbolic links (a Unix file system feature) are excluded
# Line 878  EXCLUDE_SYMLINKS       = NO Line 916  EXCLUDE_SYMLINKS       = NO
916  # Note that the wildcards are matched against the file with absolute path, so to  # Note that the wildcards are matched against the file with absolute path, so to
917  # exclude all test directories for example use the pattern */test/*  # exclude all test directories for example use the pattern */test/*
918    
919  EXCLUDE_PATTERNS       =  EXCLUDE_PATTERNS       = *common.h *common.c *examples/* *CMakeFiles*
920    
921  # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names  # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
922  # (namespaces, classes, functions, etc.) that should be excluded from the  # (namespaces, classes, functions, etc.) that should be excluded from the
# Line 1071  VERBATIM_HEADERS       = YES Line 1109  VERBATIM_HEADERS       = YES
1109    
1110  ALPHABETICAL_INDEX     = NO  ALPHABETICAL_INDEX     = NO
1111    
 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in  
 # which the alphabetical index list will be split.  
 # Minimum value: 1, maximum value: 20, default value: 5.  
 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.  
   
 COLS_IN_ALPHA_INDEX    = 5  
   
1112  # In case all classes in a project start with a common prefix, all classes will  # In case all classes in a project start with a common prefix, all classes will
1113  # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag  # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1114  # can be used to specify a prefix (or a list of prefixes) that should be ignored  # can be used to specify a prefix (or a list of prefixes) that should be ignored
# Line 1216  HTML_TIMESTAMP         = NO Line 1247  HTML_TIMESTAMP         = NO
1247    
1248  # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML  # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
1249  # documentation will contain a main index with vertical navigation menus that  # documentation will contain a main index with vertical navigation menus that
1250  # are dynamically created via Javascript. If disabled, the navigation index will  # are dynamically created via JavaScript. If disabled, the navigation index will
1251  # consists of multiple levels of tabs that are statically embedded in every HTML  # consists of multiple levels of tabs that are statically embedded in every HTML
1252  # page. Disable this option to support browsers that do not have Javascript,  # page. Disable this option to support browsers that do not have JavaScript,
1253  # like the Qt help browser.  # like the Qt help browser.
1254  # The default value is: YES.  # The default value is: YES.
1255  # This tag requires that the tag GENERATE_HTML is set to YES.  # This tag requires that the tag GENERATE_HTML is set to YES.
# Line 1248  HTML_INDEX_NUM_ENTRIES = 100 Line 1279  HTML_INDEX_NUM_ENTRIES = 100
1279    
1280  # If the GENERATE_DOCSET tag is set to YES, additional index files will be  # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1281  # generated that can be used as input for Apple's Xcode 3 integrated development  # generated that can be used as input for Apple's Xcode 3 integrated development
1282  # environment (see: https://developer.apple.com/xcode/), introduced with OSX  # environment (see:
1283  # 10.5 (Leopard). To create a documentation set, doxygen will generate a  # https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To
1284  # Makefile in the HTML output directory. Running make will produce the docset in  # create a documentation set, doxygen will generate a Makefile in the HTML
1285  # that directory and running make install will install the docset in  # output directory. Running make will produce the docset in that directory and
1286    # running make install will install the docset in
1287  # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at  # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1288  # startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy  # startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy
1289  # genXcode/_index.html for more information.  # genXcode/_index.html for more information.
# Line 1293  DOCSET_PUBLISHER_NAME  = Publisher Line 1325  DOCSET_PUBLISHER_NAME  = Publisher
1325  # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three  # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1326  # additional HTML index files: index.hhp, index.hhc, and index.hhk. The  # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1327  # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop  # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1328  # (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on  # (see:
1329  # Windows.  # https://www.microsoft.com/en-us/download/details.aspx?id=21138) on Windows.
1330  #  #
1331  # The HTML Help Workshop contains a compiler that can convert all HTML output  # The HTML Help Workshop contains a compiler that can convert all HTML output
1332  # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML  # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
# Line 1324  CHM_FILE               = Line 1356  CHM_FILE               =
1356  HHC_LOCATION           =  HHC_LOCATION           =
1357    
1358  # The GENERATE_CHI flag controls if a separate .chi index file is generated  # The GENERATE_CHI flag controls if a separate .chi index file is generated
1359  # (YES) or that it should be included in the master .chm file (NO).  # (YES) or that it should be included in the main .chm file (NO).
1360  # The default value is: NO.  # The default value is: NO.
1361  # This tag requires that the tag GENERATE_HTMLHELP is set to YES.  # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1362    
# Line 1369  QCH_FILE               = Line 1401  QCH_FILE               =
1401    
1402  # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help  # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1403  # Project output. For more information please see Qt Help Project / Namespace  # Project output. For more information please see Qt Help Project / Namespace
1404  # (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).  # (see:
1405    # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
1406  # The default value is: org.doxygen.Project.  # The default value is: org.doxygen.Project.
1407  # This tag requires that the tag GENERATE_QHP is set to YES.  # This tag requires that the tag GENERATE_QHP is set to YES.
1408    
# Line 1377  QHP_NAMESPACE          = org.doxygen.Pro Line 1410  QHP_NAMESPACE          = org.doxygen.Pro
1410    
1411  # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt  # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1412  # Help Project output. For more information please see Qt Help Project / Virtual  # Help Project output. For more information please see Qt Help Project / Virtual
1413  # Folders (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-  # Folders (see:
1414  # folders).  # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders).
1415  # The default value is: doc.  # The default value is: doc.
1416  # This tag requires that the tag GENERATE_QHP is set to YES.  # This tag requires that the tag GENERATE_QHP is set to YES.
1417    
# Line 1386  QHP_VIRTUAL_FOLDER     = doc Line 1419  QHP_VIRTUAL_FOLDER     = doc
1419    
1420  # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom  # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1421  # filter to add. For more information please see Qt Help Project / Custom  # filter to add. For more information please see Qt Help Project / Custom
1422  # Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-  # Filters (see:
1423  # filters).  # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
1424  # This tag requires that the tag GENERATE_QHP is set to YES.  # This tag requires that the tag GENERATE_QHP is set to YES.
1425    
1426  QHP_CUST_FILTER_NAME   =  QHP_CUST_FILTER_NAME   =
1427    
1428  # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the  # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1429  # custom filter to add. For more information please see Qt Help Project / Custom  # custom filter to add. For more information please see Qt Help Project / Custom
1430  # Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-  # Filters (see:
1431  # filters).  # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
1432  # This tag requires that the tag GENERATE_QHP is set to YES.  # This tag requires that the tag GENERATE_QHP is set to YES.
1433    
1434  QHP_CUST_FILTER_ATTRS  =  QHP_CUST_FILTER_ATTRS  =
# Line 1407  QHP_CUST_FILTER_ATTRS  = Line 1440  QHP_CUST_FILTER_ATTRS  =
1440    
1441  QHP_SECT_FILTER_ATTRS  =  QHP_SECT_FILTER_ATTRS  =
1442    
1443  # The QHG_LOCATION tag can be used to specify the location of Qt's  # The QHG_LOCATION tag can be used to specify the location (absolute path
1444  # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the  # including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to
1445  # generated .qhp file.  # run qhelpgenerator on the generated .qhp file.
1446  # This tag requires that the tag GENERATE_QHP is set to YES.  # This tag requires that the tag GENERATE_QHP is set to YES.
1447    
1448  QHG_LOCATION           =  QHG_LOCATION           =
# Line 1486  TREEVIEW_WIDTH         = 250 Line 1519  TREEVIEW_WIDTH         = 250
1519    
1520  EXT_LINKS_IN_WINDOW    = NO  EXT_LINKS_IN_WINDOW    = NO
1521    
1522    # If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg
1523    # tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see
1524    # https://inkscape.org) to generate formulas as SVG images instead of PNGs for
1525    # the HTML output. These images will generally look nicer at scaled resolutions.
1526    # Possible values are: png (the default) and svg (looks nicer but requires the
1527    # pdf2svg or inkscape tool).
1528    # The default value is: png.
1529    # This tag requires that the tag GENERATE_HTML is set to YES.
1530    
1531    HTML_FORMULA_FORMAT    = png
1532    
1533  # Use this tag to change the font size of LaTeX formulas included as images in  # Use this tag to change the font size of LaTeX formulas included as images in
1534  # the HTML documentation. When you change the font size after a successful  # the HTML documentation. When you change the font size after a successful
1535  # doxygen run you need to manually remove any form_*.png images from the HTML  # doxygen run you need to manually remove any form_*.png images from the HTML
# Line 1506  FORMULA_FONTSIZE       = 10 Line 1550  FORMULA_FONTSIZE       = 10
1550    
1551  FORMULA_TRANSPARENT    = YES  FORMULA_TRANSPARENT    = YES
1552    
1553    # The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands
1554    # to create new LaTeX commands to be used in formulas as building blocks. See
1555    # the section "Including formulas" for details.
1556    
1557    FORMULA_MACROFILE      =
1558    
1559  # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see  # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1560  # https://www.mathjax.org) which uses client side Javascript for the rendering  # https://www.mathjax.org) which uses client side JavaScript for the rendering
1561  # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX  # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1562  # installed or if you want to formulas look prettier in the HTML output. When  # installed or if you want to formulas look prettier in the HTML output. When
1563  # enabled you may also need to install MathJax separately and configure the path  # enabled you may also need to install MathJax separately and configure the path
# Line 1519  USE_MATHJAX            = NO Line 1569  USE_MATHJAX            = NO
1569    
1570  # When MathJax is enabled you can set the default output format to be used for  # When MathJax is enabled you can set the default output format to be used for
1571  # the MathJax output. See the MathJax site (see:  # the MathJax output. See the MathJax site (see:
1572  # http://docs.mathjax.org/en/latest/output.html) for more details.  # http://docs.mathjax.org/en/v2.7-latest/output.html) for more details.
1573  # Possible values are: HTML-CSS (which is slower, but has the best  # Possible values are: HTML-CSS (which is slower, but has the best
1574  # compatibility), NativeMML (i.e. MathML) and SVG.  # compatibility), NativeMML (i.e. MathML) and SVG.
1575  # The default value is: HTML-CSS.  # The default value is: HTML-CSS.
# Line 1535  MATHJAX_FORMAT         = HTML-CSS Line 1585  MATHJAX_FORMAT         = HTML-CSS
1585  # Content Delivery Network so you can quickly see the result without installing  # Content Delivery Network so you can quickly see the result without installing
1586  # MathJax. However, it is strongly recommended to install a local copy of  # MathJax. However, it is strongly recommended to install a local copy of
1587  # MathJax from https://www.mathjax.org before deployment.  # MathJax from https://www.mathjax.org before deployment.
1588  # The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/.  # The default value is: https://cdn.jsdelivr.net/npm/mathjax@2.
1589  # This tag requires that the tag USE_MATHJAX is set to YES.  # This tag requires that the tag USE_MATHJAX is set to YES.
1590    
1591  MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest  MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
# Line 1549  MATHJAX_EXTENSIONS     = Line 1599  MATHJAX_EXTENSIONS     =
1599    
1600  # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces  # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1601  # of code that will be used on startup of the MathJax code. See the MathJax site  # of code that will be used on startup of the MathJax code. See the MathJax site
1602  # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an  # (see:
1603    # http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an
1604  # example see the documentation.  # example see the documentation.
1605  # This tag requires that the tag USE_MATHJAX is set to YES.  # This tag requires that the tag USE_MATHJAX is set to YES.
1606    
# Line 1577  MATHJAX_CODEFILE       = Line 1628  MATHJAX_CODEFILE       =
1628  SEARCHENGINE           = NO  SEARCHENGINE           = NO
1629    
1630  # When the SERVER_BASED_SEARCH tag is enabled the search engine will be  # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1631  # implemented using a web server instead of a web client using Javascript. There  # implemented using a web server instead of a web client using JavaScript. There
1632  # are two flavors of web server based searching depending on the EXTERNAL_SEARCH  # are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1633  # setting. When disabled, doxygen will generate a PHP script for searching and  # setting. When disabled, doxygen will generate a PHP script for searching and
1634  # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing  # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
# Line 1596  SERVER_BASED_SEARCH    = NO Line 1647  SERVER_BASED_SEARCH    = NO
1647  #  #
1648  # Doxygen ships with an example indexer (doxyindexer) and search engine  # Doxygen ships with an example indexer (doxyindexer) and search engine
1649  # (doxysearch.cgi) which are based on the open source search engine library  # (doxysearch.cgi) which are based on the open source search engine library
1650  # Xapian (see: https://xapian.org/).  # Xapian (see:
1651    # https://xapian.org/).
1652  #  #
1653  # See the section "External Indexing and Searching" for details.  # See the section "External Indexing and Searching" for details.
1654  # The default value is: NO.  # The default value is: NO.
# Line 1609  EXTERNAL_SEARCH        = NO Line 1661  EXTERNAL_SEARCH        = NO
1661  #  #
1662  # Doxygen ships with an example indexer (doxyindexer) and search engine  # Doxygen ships with an example indexer (doxyindexer) and search engine
1663  # (doxysearch.cgi) which are based on the open source search engine library  # (doxysearch.cgi) which are based on the open source search engine library
1664  # Xapian (see: https://xapian.org/). See the section "External Indexing and  # Xapian (see:
1665  # Searching" for details.  # https://xapian.org/). See the section "External Indexing and Searching" for
1666    # details.
1667  # This tag requires that the tag SEARCHENGINE is set to YES.  # This tag requires that the tag SEARCHENGINE is set to YES.
1668    
1669  SEARCHENGINE_URL       =  SEARCHENGINE_URL       =
# Line 1774  LATEX_EXTRA_FILES      = Line 1827  LATEX_EXTRA_FILES      =
1827    
1828  PDF_HYPERLINKS         = NO  PDF_HYPERLINKS         = NO
1829    
1830  # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate  # If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as
1831  # the PDF file directly from the LaTeX files. Set this option to YES, to get a  # specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX
1832  # higher quality PDF documentation.  # files. Set this option to YES, to get a higher quality PDF documentation.
1833    #
1834    # See also section LATEX_CMD_NAME for selecting the engine.
1835  # The default value is: YES.  # The default value is: YES.
1836  # This tag requires that the tag GENERATE_LATEX is set to YES.  # This tag requires that the tag GENERATE_LATEX is set to YES.
1837    
# Line 2287  UML_LOOK               = NO Line 2342  UML_LOOK               = NO
2342  # but if the number exceeds 15, the total amount of fields shown is limited to  # but if the number exceeds 15, the total amount of fields shown is limited to
2343  # 10.  # 10.
2344  # Minimum value: 0, maximum value: 100, default value: 10.  # Minimum value: 0, maximum value: 100, default value: 10.
2345  # This tag requires that the tag HAVE_DOT is set to YES.  # This tag requires that the tag UML_LOOK is set to YES.
2346    
2347  UML_LIMIT_NUM_FIELDS   = 10  UML_LIMIT_NUM_FIELDS   = 10
2348    
2349    # If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and
2350    # methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS
2351    # tag is set to YES, doxygen will add type and arguments for attributes and
2352    # methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen
2353    # will not generate fields with class member information in the UML graphs. The
2354    # class diagrams will look similar to the default class diagrams but using UML
2355    # notation for the relationships.
2356    # Possible values are: NO, YES and NONE.
2357    # The default value is: NO.
2358    # This tag requires that the tag UML_LOOK is set to YES.
2359    
2360    DOT_UML_DETAILS        = NO
2361    
2362    # The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters
2363    # to display on a single line. If the actual line length exceeds this threshold
2364    # significantly it will wrapped across multiple lines. Some heuristics are apply
2365    # to avoid ugly line breaks.
2366    # Minimum value: 0, maximum value: 1000, default value: 17.
2367    # This tag requires that the tag HAVE_DOT is set to YES.
2368    
2369    DOT_WRAP_THRESHOLD     = 17
2370    
2371  # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and  # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2372  # collaboration graphs will show the relations between templates and their  # collaboration graphs will show the relations between templates and their
2373  # instances.  # instances.
# Line 2480  DOT_MULTI_TARGETS      = NO Line 2557  DOT_MULTI_TARGETS      = NO
2557    
2558  GENERATE_LEGEND        = YES  GENERATE_LEGEND        = YES
2559    
2560  # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot  # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate
2561  # files that are used to generate the various graphs.  # files that are used to generate the various graphs.
2562    #
2563    # Note: This setting is not only used for dot files but also for msc and
2564    # plantuml temporary files.
2565  # The default value is: YES.  # The default value is: YES.
 # This tag requires that the tag HAVE_DOT is set to YES.  
2566    
2567  DOT_CLEANUP            = YES  DOT_CLEANUP            = YES

Legend:
Removed from v.3865  
changed lines
  Added in v.3866

  ViewVC Help
Powered by ViewVC