From 835421dad74e8989002b592f703a23d87f211df0 Mon Sep 17 00:00:00 2001 From: DongHun Kwak Date: Fri, 15 Oct 2021 10:46:54 +0900 Subject: Imported Upstream version 1.8.5 --- .gitignore | 78 + .travis.yml | 11 + Doxyfile | 1 - Makefile.in | 5 +- PLATFORMS | 1 + README | 29 - README.md | 66 + addon/doxywizard/config.h | 9 + addon/doxywizard/configdoc.cpp | 2241 ++++++++++ addon/doxywizard/configdoc.h | 8 + addon/doxywizard/docintf.h | 12 + addon/doxywizard/doxywizard.cpp | 4 +- addon/doxywizard/doxywizard.pro.in | 10 +- addon/doxywizard/expert.cpp | 412 +- addon/doxywizard/expert.h | 13 +- addon/doxywizard/input.h | 2 + addon/doxywizard/inputbool.h | 4 +- addon/doxywizard/inputint.h | 3 + addon/doxywizard/inputstring.h | 3 + addon/doxywizard/inputstrlist.h | 4 +- configure | 52 +- configure.bin | 118 + doc/.gitignore | 1 + doc/Makefile.in | 5 +- doc/Makefile.win_make.in | 6 +- doc/Makefile.win_nmake.in | 5 +- doc/changelog.doc | 115 +- doc/commands.doc | 4 +- doc/config.doc | 2636 ++++++++---- doc/doxywizard_usage.doc | 9 + doc/htmlcmds.doc | 1 + doc/install.doc | 5 +- doc/language.doc | 50 +- doc/language.tpl | 1 - doc/maintainers.txt | 5 +- doc/markdown.doc | 3 + doc/preprocessing.doc | 16 +- doc/translator.py | 47 +- doc/translator_report.txt | 1477 ------- jquery/Makefile | 12 +- jquery/README | 1 + jquery/jquery.powertip-1.2.0.js | 1166 +++++ qtools/Doxyfile | 3 +- qtools/qcstring.h | 2 +- qtools/qfileinfo_win32.cpp | 1 + qtools/qregexp.cpp | 2 +- src/.gitignore | 47 - src/clangparser.cpp | 36 +- src/classdef.cpp | 318 +- src/classdef.h | 13 +- src/cmdmapper.cpp | 1 + src/cmdmapper.h | 3 +- src/code.h | 4 +- src/code.l | 120 +- src/commentcnv.l | 5 +- src/commentscan.l | 96 +- src/config.h | 130 +- src/config.l | 230 +- src/config.xml | 4792 ++++++++++++++------- src/configgen.py | 655 ++- src/configoptions.cpp | 4179 ++++++++++-------- src/configoptions.h | 3 - src/dbusxmlscanner.cpp | 1 + src/dbusxmlscanner.h | 1 + src/definition.cpp | 105 +- src/definition.h | 9 +- src/docbookgen.cpp | 58 +- src/docbookvisitor.cpp | 10 +- src/docparser.cpp | 251 +- src/doctokenizer.h | 7 +- src/doctokenizer.l | 34 +- src/dot.cpp | 13 +- src/doxygen.cpp | 65 +- src/doxygen.css | 175 +- src/doxygen.md | 4 +- src/doxygen.pro.in | 2 +- src/doxygen_css.h | 175 +- src/filedef.cpp | 18 +- src/fortrancode.l | 30 +- src/fortranscanner.h | 1 + src/fortranscanner.l | 59 +- src/ftvhelp.cpp | 1 + src/groupdef.cpp | 2 +- src/htmldocvisitor.cpp | 8 + src/htmlgen.cpp | 158 +- src/htmlgen.h | 21 +- src/index.cpp | 7 +- src/jquery_pt.js | 8 + src/jquery_pt_js.h | 8 + src/language.cpp | 51 +- src/latexdocvisitor.cpp | 17 +- src/latexgen.cpp | 32 +- src/latexgen.h | 5 +- src/layout.cpp | 2 +- src/libdoxycfg.t.in | 4 +- src/libdoxygen.pro.in | 5 +- src/libdoxygen.t.in | 3 + src/lockingptr.h | 162 - src/mandocvisitor.cpp | 21 +- src/mangen.h | 5 +- src/markdown.cpp | 14 +- src/markdown.h | 1 + src/memberdef.cpp | 59 +- src/memberdef.h | 1 + src/memberlist.cpp | 26 +- src/memberlist.h | 4 +- src/message.cpp | 4 +- src/msc.cpp | 2 +- src/namespacedef.cpp | 2 +- src/navtree.js | 44 +- src/navtree_js.h | 44 +- src/objcache.cpp | 2 +- src/outputgen.h | 61 +- src/outputlist.cpp | 26 + src/outputlist.h | 12 +- src/pagedef.cpp | 14 + src/pagedef.h | 2 +- src/parserintf.h | 4 + src/portable.cpp | 16 +- src/pre.l | 58 +- src/pycode.h | 4 +- src/pycode.l | 42 +- src/pyscanner.h | 1 + src/pyscanner.l | 1 + src/rtfdocvisitor.cpp | 11 +- src/rtfgen.h | 5 +- src/scanner.h | 1 + src/scanner.l | 55 +- src/sqlite3gen.cpp | 969 ++--- src/tagreader.cpp | 68 +- src/tclscanner.h | 1 + src/tclscanner.l | 2 + src/tooltip.cpp | 132 + src/tooltip.h | 37 + src/translator.cpp | 249 -- src/translator.h | 100 +- src/translator_adapter.h | 2 - src/translator_am.h | 309 +- src/translator_ar.h | 378 +- src/translator_br.h | 142 +- src/translator_ca.h | 412 +- src/translator_cn.h | 406 +- src/translator_cz.h | 112 +- src/translator_de.h | 345 +- src/translator_dk.h | 219 +- src/translator_en.h | 429 +- src/translator_eo.h | 64 +- src/translator_es.h | 443 +- src/translator_fa.h | 404 +- src/translator_fi.h | 470 +- src/translator_fr.h | 1149 ++--- src/translator_gr.h | 56 +- src/translator_hr.h | 303 +- src/translator_hu.h | 792 ++-- src/translator_id.h | 346 +- src/translator_it.h | 112 +- src/translator_je.h | 14 +- src/translator_jp.h | 795 ++-- src/translator_ke.h | 7 +- src/translator_kr.h | 1122 +++-- src/translator_lt.h | 598 ++- src/translator_lv.h | 817 ++-- src/translator_mk.h | 416 +- src/translator_nl.h | 337 +- src/translator_no.h | 448 +- src/translator_pl.h | 423 +- src/translator_pt.h | 201 +- src/translator_ro.h | 54 - src/translator_ru.h | 306 +- src/translator_sc.h | 420 +- src/translator_si.h | 325 +- src/translator_sk.h | 54 - src/translator_sr.h | 858 ++-- src/translator_sv.h | 517 +-- src/translator_tr.h | 448 +- src/translator_tw.h | 275 +- src/translator_ua.h | 58 +- src/translator_vi.h | 414 +- src/translator_za.h | 452 +- src/translatordecoder.h | 821 ---- src/util.cpp | 296 +- src/util.h | 3 +- src/vhdlcode.l | 79 +- src/vhdldocgen.cpp | 3 + src/vhdlscanner.h | 1 + src/vhdlscanner.l | 1 + src/xmldocvisitor.cpp | 153 +- src/xmlgen.cpp | 36 +- testing/001/indexpage.xml | 10 + testing/001_a.dox | 5 + testing/002/indexpage.xml | 15 + testing/002_addindex.dox | 5 + testing/003/indexpage.xml | 10 + testing/003_anchor.dox | 8 + testing/004/indexpage.xml | 13 + testing/004_arg.dox | 15 + testing/005/indexpage.xml | 35 + testing/005_attention.dox | 14 + testing/006/indexpage.xml | 25 + testing/006_author.dox | 9 + testing/007/indexpage.xml | 10 + testing/007_b.dox | 5 + testing/008/008__brief_8c.xml | 13 + testing/008_brief.c | 7 + testing/009/bug.xml | 26 + testing/009/class_bug.xml | 43 + testing/009/class_deprecated.xml | 41 + testing/009/class_reminder.xml | 48 + testing/009/class_test.xml | 48 + testing/009/class_todo.xml | 48 + testing/009/deprecated.xml | 25 + testing/009/reminders.xml | 25 + testing/009/test.xml | 25 + testing/009/todo.xml | 25 + testing/009_bug.cpp | 62 + testing/010/indexpage.xml | 11 + testing/010_c.dox | 7 + testing/011/category_integer_07_arithmetic_08.xml | 60 + testing/011/interface_integer.xml | 99 + testing/011_category.m | 30 + testing/012/citelist.xml | 20 + testing/012/indexpage.xml | 10 + testing/012_cite.dox | 7 + testing/013/class_t1.xml | 15 + testing/013/class_t2.xml | 15 + testing/013/class_t3.xml | 15 + testing/013/class_t4.xml | 15 + testing/013_class.h | 37 + testing/014/indexpage.xml | 48 + testing/014_code.dox | 14 + testing/015/015__cond_8c.xml | 26 + testing/015_cond.c | 30 + testing/016/016__copydoc_8c.xml | 76 + testing/016_copydoc.c | 23 + testing/017/indexpage.xml | 17 + testing/017_copyright.dox | 6 + testing/018/018__def_8c.xml | 125 + testing/018_def.c | 37 + testing/019/group__g1.xml | 28 + testing/019/group__g2.xml | 29 + testing/019/group__g3.xml | 42 + testing/019_defgroup.c | 48 + testing/020/indexpage.xml | 22 + testing/020_only.dox | 24 + testing/021/indexpage.xml | 10 + testing/021_dontinclude.cpp | 24 + testing/022/indexpage.xml | 17 + testing/022_dot.cpp | 22 + testing/023/indexpage.xml | 10 + testing/023_e.dox | 5 + testing/024/indexpage.xml | 10 + testing/024_if.dox | 21 + testing/025/class_test.xml | 36 + testing/025/example_test_8cpp-example.xml | 10 + testing/025_example.cpp | 26 + testing/026/class_test.xml | 52 + testing/026_exception.cpp | 21 + testing/027/struct_car.xml | 95 + testing/027/struct_object.xml | 105 + testing/027/struct_truck.xml | 95 + testing/027/struct_vehicle.xml | 132 + testing/027_extends.c | 93 + testing/028/indexpage.xml | 11 + testing/028_formula.c | 17 + testing/029/029__hideinit_8c.xml | 42 + testing/029_hideinit.c | 12 + testing/030/indexpage.xml | 11 + testing/030_htmlinclude.dox | 8 + testing/031/indexpage.xml | 12 + testing/031_image.dox | 9 + testing/032/indexpage.xml | 10 + testing/032_include.cpp | 11 + testing/033/indexpage.xml | 11 + testing/033_internal.dox | 12 + testing/034/indexpage.xml | 29 + testing/034_internal.dox | 21 + testing/035/035__invariant_8c.xml | 45 + testing/035_invariant.c | 15 + testing/036/036__link_8c.xml | 33 + testing/036_link.c | 16 + testing/037/class_receiver.xml | 42 + testing/037/class_sender.xml | 42 + testing/037_msc.cpp | 33 + testing/038/indexpage.xml | 12 + testing/038_n.dox | 7 + testing/039/class_test.xml | 74 + testing/039_name.cpp | 25 + testing/040/namespace_n_s.xml | 12 + testing/040_namespace.cpp | 10 + testing/041/class_test.xml | 100 + testing/041_overload.cpp | 33 + testing/042/namespaceorg_1_1doxygen_1_1_test.xml | 12 + testing/042_package.java | 8 + testing/043/another.xml | 10 + testing/043/mypage.xml | 34 + testing/043_page.dox | 22 + testing/044/struct_s.xml | 129 + testing/044_section.h | 28 + testing/045/indexpage.xml | 21 + testing/045_refitem.dox | 20 + testing/046/046__related_8cpp.xml | 28 + testing/046/class_test.xml | 80 + testing/046_related.cpp | 28 + testing/047/047__return_8cpp.xml | 58 + testing/047_return.cpp | 20 + testing/048/048__showinit_8c.xml | 42 + testing/048_showinit.c | 13 + testing/049/indexpage.xml | 10 + testing/049_snippet.cpp | 13 + testing/050/indexpage.xml | 18 + testing/050_verbatim.dox | 14 + testing/051/indexpage.xml | 10 + testing/051_escape.dox | 18 + testing/052/indexpage.xml | 10 + testing/052_tilde.dox | 9 + testing/053/indexpage.xml | 10 + testing/053_tilde.dox | 10 + testing/Doxyfile | 7 + testing/Makefile | 3 + testing/README | 48 + testing/example_test.cpp | 6 + testing/runtests.pl | 252 ++ testing/sample.bib | 7 + testing/sample.html | 1 + testing/sample.png | Bin 0 -> 3779 bytes testing/snippet_test.cpp | 41 + tmake/lib/aix-g++/app.t | 0 tmake/lib/aix-g++/lib.t | 0 tmake/lib/aix-g++/subdirs.t | 0 tmake/lib/aix-g++/tmake.conf | 0 tmake/lib/aix-xlc/app.t | 0 tmake/lib/aix-xlc/lib.t | 0 tmake/lib/aix-xlc/subdirs.t | 0 tmake/lib/aix-xlc/tmake.conf | 0 tmake/lib/beos-g++/app.t | 0 tmake/lib/beos-g++/lib.t | 0 tmake/lib/beos-g++/subdirs.t | 0 tmake/lib/beos-g++/tmake.conf | 0 tmake/lib/bsdi-g++/app.t | 0 tmake/lib/bsdi-g++/lib.t | 0 tmake/lib/bsdi-g++/subdirs.t | 0 tmake/lib/bsdi-g++/tmake.conf | 0 tmake/lib/dgux-g++/app.t | 0 tmake/lib/dgux-g++/lib.t | 0 tmake/lib/dgux-g++/subdirs.t | 0 tmake/lib/dgux-g++/tmake.conf | 0 tmake/lib/freebsd-g++/app.t | 0 tmake/lib/freebsd-g++/lib.t | 0 tmake/lib/freebsd-g++/subdirs.t | 0 tmake/lib/freebsd-g++/tmake.conf | 0 tmake/lib/gnu-g++/app.t | 0 tmake/lib/gnu-g++/lib.t | 0 tmake/lib/gnu-g++/subdirs.t | 0 tmake/lib/gnu-g++/tmake.conf | 0 tmake/lib/hpux-acc/app.t | 0 tmake/lib/hpux-acc/lib.t | 0 tmake/lib/hpux-acc/subdirs.t | 0 tmake/lib/hpux-acc/tmake.conf | 0 tmake/lib/hpux-cc/app.t | 0 tmake/lib/hpux-cc/lib.t | 0 tmake/lib/hpux-cc/subdirs.t | 0 tmake/lib/hpux-cc/tmake.conf | 0 tmake/lib/hpux-g++/app.t | 0 tmake/lib/hpux-g++/lib.t | 0 tmake/lib/hpux-g++/subdirs.t | 0 tmake/lib/hpux-g++/tmake.conf | 0 tmake/lib/irix-64/app.t | 0 tmake/lib/irix-64/lib.t | 0 tmake/lib/irix-64/subdirs.t | 0 tmake/lib/irix-64/tmake.conf | 0 tmake/lib/irix-dcc/app.t | 0 tmake/lib/irix-dcc/lib.t | 0 tmake/lib/irix-dcc/subdirs.t | 0 tmake/lib/irix-dcc/tmake.conf | 0 tmake/lib/irix-g++/app.t | 0 tmake/lib/irix-g++/lib.t | 0 tmake/lib/irix-g++/subdirs.t | 0 tmake/lib/irix-g++/tmake.conf | 0 tmake/lib/irix-n32/app.t | 0 tmake/lib/irix-n32/lib.t | 0 tmake/lib/irix-n32/subdirs.t | 0 tmake/lib/irix-n32/tmake.conf | 0 tmake/lib/irix-o32/app.t | 0 tmake/lib/irix-o32/lib.t | 0 tmake/lib/irix-o32/subdirs.t | 0 tmake/lib/irix-o32/tmake.conf | 0 tmake/lib/linux-g++/app.t | 0 tmake/lib/linux-g++/lib.t | 0 tmake/lib/linux-g++/subdirs.t | 0 tmake/lib/linux-g++/tmake.conf | 0 tmake/lib/m68k-atari-mint-g++/app.t | 0 tmake/lib/m68k-atari-mint-g++/lib.t | 0 tmake/lib/m68k-atari-mint-g++/subdirs.t | 0 tmake/lib/m68k-atari-mint-g++/tmake.conf | 0 tmake/lib/macosx-c++/app.t | 0 tmake/lib/macosx-c++/lib.t | 0 tmake/lib/macosx-c++/subdirs.t | 0 tmake/lib/macosx-c++/tmake.conf | 2 +- tmake/lib/macosx-uni-c++/tmake.conf | 2 +- tmake/lib/netbsd-g++/app.t | 0 tmake/lib/netbsd-g++/lib.t | 0 tmake/lib/netbsd-g++/subdirs.t | 0 tmake/lib/netbsd-g++/tmake.conf | 0 tmake/lib/openbsd-g++/app.t | 0 tmake/lib/openbsd-g++/lib.t | 0 tmake/lib/openbsd-g++/subdirs.t | 0 tmake/lib/openbsd-g++/tmake.conf | 0 tmake/lib/osf1-cxx/app.t | 0 tmake/lib/osf1-cxx/lib.t | 0 tmake/lib/osf1-cxx/subdirs.t | 0 tmake/lib/osf1-cxx/tmake.conf | 0 tmake/lib/osf1-g++/app.t | 0 tmake/lib/osf1-g++/lib.t | 0 tmake/lib/osf1-g++/subdirs.t | 0 tmake/lib/osf1-g++/tmake.conf | 0 tmake/lib/qnx-g++/app.t | 0 tmake/lib/qnx-g++/lib.t | 0 tmake/lib/qnx-g++/subdirs.t | 0 tmake/lib/qnx-g++/tmake.conf | 0 tmake/lib/sco-g++/app.t | 0 tmake/lib/sco-g++/lib.t | 0 tmake/lib/sco-g++/subdirs.t | 0 tmake/lib/sco-g++/tmake.conf | 0 tmake/lib/solaris-cc-gcc/app.t | 0 tmake/lib/solaris-cc-gcc/lib.t | 0 tmake/lib/solaris-cc-gcc/subdirs.t | 0 tmake/lib/solaris-cc-gcc/tmake.conf | 0 tmake/lib/solaris-cc/app.t | 0 tmake/lib/solaris-cc/lib.t | 0 tmake/lib/solaris-cc/subdirs.t | 0 tmake/lib/solaris-cc/tmake.conf | 0 tmake/lib/solaris-g++/app.t | 0 tmake/lib/solaris-g++/lib.t | 0 tmake/lib/solaris-g++/subdirs.t | 0 tmake/lib/solaris-g++/tmake.conf | 0 tmake/lib/sunos-g++/app.t | 0 tmake/lib/sunos-g++/lib.t | 0 tmake/lib/sunos-g++/subdirs.t | 0 tmake/lib/sunos-g++/tmake.conf | 0 tmake/lib/ultrix-g++/app.t | 0 tmake/lib/ultrix-g++/lib.t | 0 tmake/lib/ultrix-g++/subdirs.t | 0 tmake/lib/ultrix-g++/tmake.conf | 0 tmake/lib/unix/app.t | 0 tmake/lib/unix/generic.t | 0 tmake/lib/unix/lib.t | 0 tmake/lib/unix/subdirs.t | 0 tmake/lib/unixware-g++/app.t | 0 tmake/lib/unixware-g++/lib.t | 0 tmake/lib/unixware-g++/subdirs.t | 0 tmake/lib/unixware-g++/tmake.conf | 0 tmake/lib/unixware7-cc/app.t | 0 tmake/lib/unixware7-cc/lib.t | 0 tmake/lib/unixware7-cc/subdirs.t | 0 tmake/lib/unixware7-cc/tmake.conf | 0 tmake/lib/unixware7-g++/app.t | 0 tmake/lib/unixware7-g++/lib.t | 0 tmake/lib/unixware7-g++/subdirs.t | 0 tmake/lib/unixware7-g++/tmake.conf | 0 tmake/lib/win32-borland/app.t | 0 tmake/lib/win32-borland/generic.t | 0 tmake/lib/win32-borland/lib.t | 0 tmake/lib/win32-borland/subdirs.t | 0 tmake/lib/win32-borland/tmake.conf | 0 tmake/lib/win32-g++/app.t | 0 tmake/lib/win32-g++/generic.t | 0 tmake/lib/win32-g++/lib.t | 0 tmake/lib/win32-g++/subdirs.t | 0 tmake/lib/win32-g++/tmake.conf | 0 tmake/lib/win32-mingw/app.t | 0 tmake/lib/win32-mingw/generic.t | 0 tmake/lib/win32-mingw/lib.t | 0 tmake/lib/win32-mingw/subdirs.t | 0 tmake/lib/win32-mingw/tmake.conf | 0 tmake/lib/win32-msvc/app.t | 0 tmake/lib/win32-msvc/generic.t | 0 tmake/lib/win32-msvc/lib.t | 0 tmake/lib/win32-msvc/subdirs.t | 0 tmake/lib/win32-msvc/tmake.conf | 0 tmake/lib/win32-msvc/vcapp.t | 0 tmake/lib/win32-msvc/vclib.t | 0 tmake/lib/win32-symantec/app.t | 0 tmake/lib/win32-symantec/generic.t | 0 tmake/lib/win32-symantec/lib.t | 0 tmake/lib/win32-symantec/subdirs.t | 0 tmake/lib/win32-symantec/tmake.conf | 0 tmake/lib/win32-visage/app.t | 0 tmake/lib/win32-visage/generic.t | 0 tmake/lib/win32-visage/lib.t | 0 tmake/lib/win32-visage/subdirs.t | 0 tmake/lib/win32-visage/tmake.conf | 0 tmake/lib/win32-watcom/app.t | 0 tmake/lib/win32-watcom/generic.t | 0 tmake/lib/win32-watcom/lib.t | 0 tmake/lib/win32-watcom/subdirs.t | 0 tmake/lib/win32-watcom/tmake.conf | 0 tmake/lib/win32/subdirs.t | 0 winbuild/.gitignore | 7 + winbuild/Doxygen.vcproj | 52 +- winbuild/Doxywizard.vcproj | 1184 ++--- winbuild/doxyindexer.vcproj | 16 +- winbuild/pack_the_distribution_for_windows.py | 232 + 502 files changed, 27417 insertions(+), 18716 deletions(-) create mode 100644 .gitignore create mode 100644 .travis.yml delete mode 100644 README create mode 100644 README.md create mode 100644 addon/doxywizard/configdoc.cpp create mode 100644 addon/doxywizard/configdoc.h create mode 100644 addon/doxywizard/docintf.h create mode 100644 doc/.gitignore delete mode 100644 doc/translator_report.txt create mode 100644 jquery/jquery.powertip-1.2.0.js delete mode 100644 src/.gitignore create mode 100644 src/jquery_pt.js create mode 100644 src/jquery_pt_js.h delete mode 100644 src/lockingptr.h create mode 100644 src/tooltip.cpp create mode 100644 src/tooltip.h delete mode 100644 src/translator.cpp delete mode 100644 src/translatordecoder.h create mode 100644 testing/001/indexpage.xml create mode 100644 testing/001_a.dox create mode 100644 testing/002/indexpage.xml create mode 100644 testing/002_addindex.dox create mode 100644 testing/003/indexpage.xml create mode 100644 testing/003_anchor.dox create mode 100644 testing/004/indexpage.xml create mode 100644 testing/004_arg.dox create mode 100644 testing/005/indexpage.xml create mode 100644 testing/005_attention.dox create mode 100644 testing/006/indexpage.xml create mode 100644 testing/006_author.dox create mode 100644 testing/007/indexpage.xml create mode 100644 testing/007_b.dox create mode 100644 testing/008/008__brief_8c.xml create mode 100644 testing/008_brief.c create mode 100644 testing/009/bug.xml create mode 100644 testing/009/class_bug.xml create mode 100644 testing/009/class_deprecated.xml create mode 100644 testing/009/class_reminder.xml create mode 100644 testing/009/class_test.xml create mode 100644 testing/009/class_todo.xml create mode 100644 testing/009/deprecated.xml create mode 100644 testing/009/reminders.xml create mode 100644 testing/009/test.xml create mode 100644 testing/009/todo.xml create mode 100644 testing/009_bug.cpp create mode 100644 testing/010/indexpage.xml create mode 100644 testing/010_c.dox create mode 100644 testing/011/category_integer_07_arithmetic_08.xml create mode 100644 testing/011/interface_integer.xml create mode 100644 testing/011_category.m create mode 100644 testing/012/citelist.xml create mode 100644 testing/012/indexpage.xml create mode 100644 testing/012_cite.dox create mode 100644 testing/013/class_t1.xml create mode 100644 testing/013/class_t2.xml create mode 100644 testing/013/class_t3.xml create mode 100644 testing/013/class_t4.xml create mode 100644 testing/013_class.h create mode 100644 testing/014/indexpage.xml create mode 100644 testing/014_code.dox create mode 100644 testing/015/015__cond_8c.xml create mode 100644 testing/015_cond.c create mode 100644 testing/016/016__copydoc_8c.xml create mode 100644 testing/016_copydoc.c create mode 100644 testing/017/indexpage.xml create mode 100644 testing/017_copyright.dox create mode 100644 testing/018/018__def_8c.xml create mode 100644 testing/018_def.c create mode 100644 testing/019/group__g1.xml create mode 100644 testing/019/group__g2.xml create mode 100644 testing/019/group__g3.xml create mode 100644 testing/019_defgroup.c create mode 100644 testing/020/indexpage.xml create mode 100644 testing/020_only.dox create mode 100644 testing/021/indexpage.xml create mode 100644 testing/021_dontinclude.cpp create mode 100644 testing/022/indexpage.xml create mode 100644 testing/022_dot.cpp create mode 100644 testing/023/indexpage.xml create mode 100644 testing/023_e.dox create mode 100644 testing/024/indexpage.xml create mode 100644 testing/024_if.dox create mode 100644 testing/025/class_test.xml create mode 100644 testing/025/example_test_8cpp-example.xml create mode 100644 testing/025_example.cpp create mode 100644 testing/026/class_test.xml create mode 100644 testing/026_exception.cpp create mode 100644 testing/027/struct_car.xml create mode 100644 testing/027/struct_object.xml create mode 100644 testing/027/struct_truck.xml create mode 100644 testing/027/struct_vehicle.xml create mode 100644 testing/027_extends.c create mode 100644 testing/028/indexpage.xml create mode 100644 testing/028_formula.c create mode 100644 testing/029/029__hideinit_8c.xml create mode 100644 testing/029_hideinit.c create mode 100644 testing/030/indexpage.xml create mode 100644 testing/030_htmlinclude.dox create mode 100644 testing/031/indexpage.xml create mode 100644 testing/031_image.dox create mode 100644 testing/032/indexpage.xml create mode 100644 testing/032_include.cpp create mode 100644 testing/033/indexpage.xml create mode 100644 testing/033_internal.dox create mode 100644 testing/034/indexpage.xml create mode 100644 testing/034_internal.dox create mode 100644 testing/035/035__invariant_8c.xml create mode 100644 testing/035_invariant.c create mode 100644 testing/036/036__link_8c.xml create mode 100644 testing/036_link.c create mode 100644 testing/037/class_receiver.xml create mode 100644 testing/037/class_sender.xml create mode 100644 testing/037_msc.cpp create mode 100644 testing/038/indexpage.xml create mode 100644 testing/038_n.dox create mode 100644 testing/039/class_test.xml create mode 100644 testing/039_name.cpp create mode 100644 testing/040/namespace_n_s.xml create mode 100644 testing/040_namespace.cpp create mode 100644 testing/041/class_test.xml create mode 100644 testing/041_overload.cpp create mode 100644 testing/042/namespaceorg_1_1doxygen_1_1_test.xml create mode 100644 testing/042_package.java create mode 100644 testing/043/another.xml create mode 100644 testing/043/mypage.xml create mode 100644 testing/043_page.dox create mode 100644 testing/044/struct_s.xml create mode 100644 testing/044_section.h create mode 100644 testing/045/indexpage.xml create mode 100644 testing/045_refitem.dox create mode 100644 testing/046/046__related_8cpp.xml create mode 100644 testing/046/class_test.xml create mode 100644 testing/046_related.cpp create mode 100644 testing/047/047__return_8cpp.xml create mode 100644 testing/047_return.cpp create mode 100644 testing/048/048__showinit_8c.xml create mode 100644 testing/048_showinit.c create mode 100644 testing/049/indexpage.xml create mode 100644 testing/049_snippet.cpp create mode 100644 testing/050/indexpage.xml create mode 100644 testing/050_verbatim.dox create mode 100644 testing/051/indexpage.xml create mode 100644 testing/051_escape.dox create mode 100644 testing/052/indexpage.xml create mode 100644 testing/052_tilde.dox create mode 100644 testing/053/indexpage.xml create mode 100644 testing/053_tilde.dox create mode 100644 testing/Doxyfile create mode 100644 testing/Makefile create mode 100644 testing/README create mode 100644 testing/example_test.cpp create mode 100755 testing/runtests.pl create mode 100644 testing/sample.bib create mode 100644 testing/sample.html create mode 100644 testing/sample.png create mode 100644 testing/snippet_test.cpp mode change 100755 => 100644 tmake/lib/aix-g++/app.t mode change 100755 => 100644 tmake/lib/aix-g++/lib.t mode change 100755 => 100644 tmake/lib/aix-g++/subdirs.t mode change 100755 => 100644 tmake/lib/aix-g++/tmake.conf mode change 100755 => 100644 tmake/lib/aix-xlc/app.t mode change 100755 => 100644 tmake/lib/aix-xlc/lib.t mode change 100755 => 100644 tmake/lib/aix-xlc/subdirs.t mode change 100755 => 100644 tmake/lib/aix-xlc/tmake.conf mode change 100755 => 100644 tmake/lib/beos-g++/app.t mode change 100755 => 100644 tmake/lib/beos-g++/lib.t mode change 100755 => 100644 tmake/lib/beos-g++/subdirs.t mode change 100755 => 100644 tmake/lib/beos-g++/tmake.conf mode change 100755 => 100644 tmake/lib/bsdi-g++/app.t mode change 100755 => 100644 tmake/lib/bsdi-g++/lib.t mode change 100755 => 100644 tmake/lib/bsdi-g++/subdirs.t mode change 100755 => 100644 tmake/lib/bsdi-g++/tmake.conf mode change 100755 => 100644 tmake/lib/dgux-g++/app.t mode change 100755 => 100644 tmake/lib/dgux-g++/lib.t mode change 100755 => 100644 tmake/lib/dgux-g++/subdirs.t mode change 100755 => 100644 tmake/lib/dgux-g++/tmake.conf mode change 100755 => 100644 tmake/lib/freebsd-g++/app.t mode change 100755 => 100644 tmake/lib/freebsd-g++/lib.t mode change 100755 => 100644 tmake/lib/freebsd-g++/subdirs.t mode change 100755 => 100644 tmake/lib/freebsd-g++/tmake.conf mode change 100755 => 100644 tmake/lib/gnu-g++/app.t mode change 100755 => 100644 tmake/lib/gnu-g++/lib.t mode change 100755 => 100644 tmake/lib/gnu-g++/subdirs.t mode change 100755 => 100644 tmake/lib/gnu-g++/tmake.conf mode change 100755 => 100644 tmake/lib/hpux-acc/app.t mode change 100755 => 100644 tmake/lib/hpux-acc/lib.t mode change 100755 => 100644 tmake/lib/hpux-acc/subdirs.t mode change 100755 => 100644 tmake/lib/hpux-acc/tmake.conf mode change 100755 => 100644 tmake/lib/hpux-cc/app.t mode change 100755 => 100644 tmake/lib/hpux-cc/lib.t mode change 100755 => 100644 tmake/lib/hpux-cc/subdirs.t mode change 100755 => 100644 tmake/lib/hpux-cc/tmake.conf mode change 100755 => 100644 tmake/lib/hpux-g++/app.t mode change 100755 => 100644 tmake/lib/hpux-g++/lib.t mode change 100755 => 100644 tmake/lib/hpux-g++/subdirs.t mode change 100755 => 100644 tmake/lib/hpux-g++/tmake.conf mode change 100755 => 100644 tmake/lib/irix-64/app.t mode change 100755 => 100644 tmake/lib/irix-64/lib.t mode change 100755 => 100644 tmake/lib/irix-64/subdirs.t mode change 100755 => 100644 tmake/lib/irix-64/tmake.conf mode change 100755 => 100644 tmake/lib/irix-dcc/app.t mode change 100755 => 100644 tmake/lib/irix-dcc/lib.t mode change 100755 => 100644 tmake/lib/irix-dcc/subdirs.t mode change 100755 => 100644 tmake/lib/irix-dcc/tmake.conf mode change 100755 => 100644 tmake/lib/irix-g++/app.t mode change 100755 => 100644 tmake/lib/irix-g++/lib.t mode change 100755 => 100644 tmake/lib/irix-g++/subdirs.t mode change 100755 => 100644 tmake/lib/irix-g++/tmake.conf mode change 100755 => 100644 tmake/lib/irix-n32/app.t mode change 100755 => 100644 tmake/lib/irix-n32/lib.t mode change 100755 => 100644 tmake/lib/irix-n32/subdirs.t mode change 100755 => 100644 tmake/lib/irix-n32/tmake.conf mode change 100755 => 100644 tmake/lib/irix-o32/app.t mode change 100755 => 100644 tmake/lib/irix-o32/lib.t mode change 100755 => 100644 tmake/lib/irix-o32/subdirs.t mode change 100755 => 100644 tmake/lib/irix-o32/tmake.conf mode change 100755 => 100644 tmake/lib/linux-g++/app.t mode change 100755 => 100644 tmake/lib/linux-g++/lib.t mode change 100755 => 100644 tmake/lib/linux-g++/subdirs.t mode change 100755 => 100644 tmake/lib/linux-g++/tmake.conf mode change 100755 => 100644 tmake/lib/m68k-atari-mint-g++/app.t mode change 100755 => 100644 tmake/lib/m68k-atari-mint-g++/lib.t mode change 100755 => 100644 tmake/lib/m68k-atari-mint-g++/subdirs.t mode change 100755 => 100644 tmake/lib/m68k-atari-mint-g++/tmake.conf mode change 100755 => 100644 tmake/lib/macosx-c++/app.t mode change 100755 => 100644 tmake/lib/macosx-c++/lib.t mode change 100755 => 100644 tmake/lib/macosx-c++/subdirs.t mode change 100755 => 100644 tmake/lib/macosx-c++/tmake.conf mode change 100755 => 100644 tmake/lib/netbsd-g++/app.t mode change 100755 => 100644 tmake/lib/netbsd-g++/lib.t mode change 100755 => 100644 tmake/lib/netbsd-g++/subdirs.t mode change 100755 => 100644 tmake/lib/netbsd-g++/tmake.conf mode change 100755 => 100644 tmake/lib/openbsd-g++/app.t mode change 100755 => 100644 tmake/lib/openbsd-g++/lib.t mode change 100755 => 100644 tmake/lib/openbsd-g++/subdirs.t mode change 100755 => 100644 tmake/lib/openbsd-g++/tmake.conf mode change 100755 => 100644 tmake/lib/osf1-cxx/app.t mode change 100755 => 100644 tmake/lib/osf1-cxx/lib.t mode change 100755 => 100644 tmake/lib/osf1-cxx/subdirs.t mode change 100755 => 100644 tmake/lib/osf1-cxx/tmake.conf mode change 100755 => 100644 tmake/lib/osf1-g++/app.t mode change 100755 => 100644 tmake/lib/osf1-g++/lib.t mode change 100755 => 100644 tmake/lib/osf1-g++/subdirs.t mode change 100755 => 100644 tmake/lib/osf1-g++/tmake.conf mode change 100755 => 100644 tmake/lib/qnx-g++/app.t mode change 100755 => 100644 tmake/lib/qnx-g++/lib.t mode change 100755 => 100644 tmake/lib/qnx-g++/subdirs.t mode change 100755 => 100644 tmake/lib/qnx-g++/tmake.conf mode change 100755 => 100644 tmake/lib/sco-g++/app.t mode change 100755 => 100644 tmake/lib/sco-g++/lib.t mode change 100755 => 100644 tmake/lib/sco-g++/subdirs.t mode change 100755 => 100644 tmake/lib/sco-g++/tmake.conf mode change 100755 => 100644 tmake/lib/solaris-cc-gcc/app.t mode change 100755 => 100644 tmake/lib/solaris-cc-gcc/lib.t mode change 100755 => 100644 tmake/lib/solaris-cc-gcc/subdirs.t mode change 100755 => 100644 tmake/lib/solaris-cc-gcc/tmake.conf mode change 100755 => 100644 tmake/lib/solaris-cc/app.t mode change 100755 => 100644 tmake/lib/solaris-cc/lib.t mode change 100755 => 100644 tmake/lib/solaris-cc/subdirs.t mode change 100755 => 100644 tmake/lib/solaris-cc/tmake.conf mode change 100755 => 100644 tmake/lib/solaris-g++/app.t mode change 100755 => 100644 tmake/lib/solaris-g++/lib.t mode change 100755 => 100644 tmake/lib/solaris-g++/subdirs.t mode change 100755 => 100644 tmake/lib/solaris-g++/tmake.conf mode change 100755 => 100644 tmake/lib/sunos-g++/app.t mode change 100755 => 100644 tmake/lib/sunos-g++/lib.t mode change 100755 => 100644 tmake/lib/sunos-g++/subdirs.t mode change 100755 => 100644 tmake/lib/sunos-g++/tmake.conf mode change 100755 => 100644 tmake/lib/ultrix-g++/app.t mode change 100755 => 100644 tmake/lib/ultrix-g++/lib.t mode change 100755 => 100644 tmake/lib/ultrix-g++/subdirs.t mode change 100755 => 100644 tmake/lib/ultrix-g++/tmake.conf mode change 100755 => 100644 tmake/lib/unix/app.t mode change 100755 => 100644 tmake/lib/unix/generic.t mode change 100755 => 100644 tmake/lib/unix/lib.t mode change 100755 => 100644 tmake/lib/unix/subdirs.t mode change 100755 => 100644 tmake/lib/unixware-g++/app.t mode change 100755 => 100644 tmake/lib/unixware-g++/lib.t mode change 100755 => 100644 tmake/lib/unixware-g++/subdirs.t mode change 100755 => 100644 tmake/lib/unixware-g++/tmake.conf mode change 100755 => 100644 tmake/lib/unixware7-cc/app.t mode change 100755 => 100644 tmake/lib/unixware7-cc/lib.t mode change 100755 => 100644 tmake/lib/unixware7-cc/subdirs.t mode change 100755 => 100644 tmake/lib/unixware7-cc/tmake.conf mode change 100755 => 100644 tmake/lib/unixware7-g++/app.t mode change 100755 => 100644 tmake/lib/unixware7-g++/lib.t mode change 100755 => 100644 tmake/lib/unixware7-g++/subdirs.t mode change 100755 => 100644 tmake/lib/unixware7-g++/tmake.conf mode change 100755 => 100644 tmake/lib/win32-borland/app.t mode change 100755 => 100644 tmake/lib/win32-borland/generic.t mode change 100755 => 100644 tmake/lib/win32-borland/lib.t mode change 100755 => 100644 tmake/lib/win32-borland/subdirs.t mode change 100755 => 100644 tmake/lib/win32-borland/tmake.conf mode change 100755 => 100644 tmake/lib/win32-g++/app.t mode change 100755 => 100644 tmake/lib/win32-g++/generic.t mode change 100755 => 100644 tmake/lib/win32-g++/lib.t mode change 100755 => 100644 tmake/lib/win32-g++/subdirs.t mode change 100755 => 100644 tmake/lib/win32-g++/tmake.conf mode change 100755 => 100644 tmake/lib/win32-mingw/app.t mode change 100755 => 100644 tmake/lib/win32-mingw/generic.t mode change 100755 => 100644 tmake/lib/win32-mingw/lib.t mode change 100755 => 100644 tmake/lib/win32-mingw/subdirs.t mode change 100755 => 100644 tmake/lib/win32-mingw/tmake.conf mode change 100755 => 100644 tmake/lib/win32-msvc/app.t mode change 100755 => 100644 tmake/lib/win32-msvc/generic.t mode change 100755 => 100644 tmake/lib/win32-msvc/lib.t mode change 100755 => 100644 tmake/lib/win32-msvc/subdirs.t mode change 100755 => 100644 tmake/lib/win32-msvc/tmake.conf mode change 100755 => 100644 tmake/lib/win32-msvc/vcapp.t mode change 100755 => 100644 tmake/lib/win32-msvc/vclib.t mode change 100755 => 100644 tmake/lib/win32-symantec/app.t mode change 100755 => 100644 tmake/lib/win32-symantec/generic.t mode change 100755 => 100644 tmake/lib/win32-symantec/lib.t mode change 100755 => 100644 tmake/lib/win32-symantec/subdirs.t mode change 100755 => 100644 tmake/lib/win32-symantec/tmake.conf mode change 100755 => 100644 tmake/lib/win32-visage/app.t mode change 100755 => 100644 tmake/lib/win32-visage/generic.t mode change 100755 => 100644 tmake/lib/win32-visage/lib.t mode change 100755 => 100644 tmake/lib/win32-visage/subdirs.t mode change 100755 => 100644 tmake/lib/win32-visage/tmake.conf mode change 100755 => 100644 tmake/lib/win32-watcom/app.t mode change 100755 => 100644 tmake/lib/win32-watcom/generic.t mode change 100755 => 100644 tmake/lib/win32-watcom/lib.t mode change 100755 => 100644 tmake/lib/win32-watcom/subdirs.t mode change 100755 => 100644 tmake/lib/win32-watcom/tmake.conf mode change 100755 => 100644 tmake/lib/win32/subdirs.t create mode 100644 winbuild/.gitignore create mode 100644 winbuild/pack_the_distribution_for_windows.py diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..4abda47 --- /dev/null +++ b/.gitignore @@ -0,0 +1,78 @@ +*~ +.*sw? +\#* +.DS_Store + +*.rej +*.orig + +*.pro +/.makeconfig +/.tmakeconfig +/VERSION +/src/libdoxycfg.t +/src/libdoxygen.t +/packages/rpm/doxygen.spec +/libmd5/Makefile +/libmd5/Makefile.libmd5 +/qtools/Makefile +/qtools/Makefile.qtools +/src/Makefile.doxygen +/src/Makefile.libdoxycfg +/src/Makefile.libdoxygen +/addon/doxysearch/Makefile +/addon/doxysearch/Makefile.doxyindexer +/addon/doxysearch/Makefile.doxysearch +/addon/doxmlparser/examples/metrics/Makefile +/addon/doxmlparser/src/Makefile +/addon/doxmlparser/test/Makefile +/addon/doxyapp/Makefile +/addon/doxywizard/Makefile +/addon/doxywizard/Makefile.doxywizard +/addon/doxywizard/config_lex.cpp +/addon/doxywizard/moc +/addon/doxywizard/obj +/addon/doxywizard/rcc +/winbuild/config_lex.cpp +/winbuild/moc +/winbuild/obj +/winbuild/rcc +*.idb +*.pdb +/examples/Makefile +/Makefile + +/bin +/lib +/objects +/src/ce_lex.cpp +/src/ce_parse.cpp +/src/ce_parse.h +/src/code.cpp +/src/commentcnv.cpp +/src/commentscan.cpp +/src/config.cpp +/src/declinfo.cpp +/src/defargs.cpp +/src/doctokenizer.cpp +/src/fortrancode.cpp +/src/fortranscanner.cpp +/src/pre.cpp +/src/pycode.cpp +/src/pyscanner.cpp +/src/scanner.cpp +/src/tclscanner.cpp +/src/unistd.h +/src/version.cpp +/src/vhdlcode.cpp +/src/vhdlparser.cpp +/src/vhdlparser.h +/src/vhdlscanner.cpp +/src/Makefile + +/doc/Makefile +/doc/translator_report.txt + +/examples/*/html +/html +/latex diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..1206c68 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,11 @@ +language: cpp +compiler: + - gcc +before_install: + - sudo apt-get update -qq + - sudo apt-get install -qq texlive texlive-extra-utils libxml2-utils perl +script: + - ./configure --with-doxywizard + - make + - make docs + - make test diff --git a/Doxyfile b/Doxyfile index b2f4ea7..f3b3877 100644 --- a/Doxyfile +++ b/Doxyfile @@ -44,7 +44,6 @@ SUBGROUPING = YES INLINE_GROUPED_CLASSES = NO INLINE_SIMPLE_STRUCTS = NO TYPEDEF_HIDES_STRUCT = NO -SYMBOL_CACHE_SIZE = 0 LOOKUP_CACHE_SIZE = 0 #--------------------------------------------------------------------------- # Build related configuration options diff --git a/Makefile.in b/Makefile.in index 606804f..fed6560 100644 --- a/Makefile.in +++ b/Makefile.in @@ -82,7 +82,7 @@ pdf: docs DISTFILES = Doxyfile libmd5 addon tmake doc examples bin lib objects \ qtools src configure configure.bin Makefile.in Makefile.win_nmake.in \ Makefile.win_make.in INSTALL LANGUAGE.HOWTO LICENSE PLATFORMS \ - VERSION packages winbuild jquery + VERSION README.md packages winbuild jquery archive: clean tar zcvf dx`date +%y%m%d`.tgz $(DISTFILES) @@ -140,5 +140,8 @@ rpmbinary: dist ctags: ctags -R -f tags src addon/doxywizard qtools +test: FORCE + make -C testing + FORCE: diff --git a/PLATFORMS b/PLATFORMS index c358a1d..22a8d8c 100644 --- a/PLATFORMS +++ b/PLATFORMS @@ -29,3 +29,4 @@ sunos-g++ ultrix-g++ unixware-g++ win32-g++ +win32-mingw diff --git a/README b/README deleted file mode 100644 index 2ecb0a5..0000000 --- a/README +++ /dev/null @@ -1,29 +0,0 @@ -DOXYGEN Version 1.8.4 - -Please read INSTALL for compilation instructions. - -The latest version of doxygen can be obtained from: - http://www.doxygen.org/ - -There are three mailing lists: - doxygen-users@lists.sourceforge.net For doxygen users - doxygen-develop@lists.sourceforge.net For doxygen developers - doxygen-announce@lists.sourceforge.net Announcement of new releases only - -please follow the link in - - http://sourceforge.net/projects/doxygen - -to subscribe to the lists or to visit the archives. - -Use the bug tracker to report bugs: - - https://bugzilla.gnome.org/enter_bug.cgi?product=doxygen - -Before reporting a bug, please check that it has not already been reported. -Also, please use the bug tracker for reporting bugs rather than the help -forum. - -Enjoy, - -Dimitri van Heesch (dimitri@stack.nl) (19 May 2013) diff --git a/README.md b/README.md new file mode 100644 index 0000000..eb0e103 --- /dev/null +++ b/README.md @@ -0,0 +1,66 @@ +Doxygen +=============== +Doxygen is the de facto standard tool for generating documentation from +annotated C++ sources, but it also supports other popular programming +languages such as C, Objective-C, C#, PHP, Java, Python, IDL +(Corba, Microsoft, and UNO/OpenOffice flavors), Fortran, VHDL, Tcl, +and to some extent D. + +Doxygen can help you in three ways: + +1. It can generate an on-line documentation browser (in HTML) and/or an + off-line reference manual (in LaTeX) from a set of documented source files. + There is also support for generating output in RTF (MS-Word), PostScript, + hyperlinked PDF, compressed HTML, DocBook and Unix man pages. + The documentation is extracted directly from the sources, which makes + it much easier to keep the documentation consistent with the source code. +2. You can configure doxygen to extract the code structure from undocumented + source files. This is very useful to quickly find your way in large + source distributions. Doxygen can also visualize the relations between + the various elements by means of include dependency graphs, inheritance + diagrams, and collaboration diagrams, which are all generated automatically. +3. You can also use doxygen for creating normal documentation (as I did for + the doxygen user manual and doxygen web-site). + +Download +--------- +The latest binaries and source of Doxygen can be downloaded from: +* http://www.doxygen.org/ + +Developers +--------- +* Build Status: + +* Install + * Quick install see (./INSTALL) + * else http://www.doxygen.org/manual/install.html + +Issues, bugs, requests, ideas +---------------------------------- +Use the bug tracker to report bugs: +* current list: + * [Bugzilla](https://bugzilla.gnome.org/buglist.cgi?product=doxygen&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED) +* Submit a new bug or feature request + * [Enter bug](https://bugzilla.gnome.org/enter_bug.cgi?product=doxygen) + +Comms +---------------------------------- +### Mailing Lists ### + +There are three mailing lists: + +* doxygen-announce@lists.sourceforge.net - Announcement of new releases only +* doxygen-users@lists.sourceforge.net - for doxygen users +* doxygen-develop@lists.sourceforge.net - for doxygen developers +* To subscribe follow the link to + * http://sourceforge.net/projects/doxygen + +Source Code +---------------------------------- +In May 2013, Doxygen moved from +subversion to git hosted at github +* https://github.com/doxygen/doxygen + +Enjoy, + +Dimitri van Heesch (dimitri at stack.nl) diff --git a/addon/doxywizard/config.h b/addon/doxywizard/config.h index d40f1f4..147056a 100644 --- a/addon/doxywizard/config.h +++ b/addon/doxywizard/config.h @@ -15,4 +15,13 @@ bool parseConfig( void writeStringValue(QTextStream &t,QTextCodec *codec,const QString &s); +// directly copied from ../../src/config.h to be consistent +enum +{ + /*! Maximum length of an option in the config file. Used for + * alignment purposes. + */ + MAX_OPTION_LENGTH = 23 +}; + #endif diff --git a/addon/doxywizard/configdoc.cpp b/addon/doxywizard/configdoc.cpp new file mode 100644 index 0000000..c439322 --- /dev/null +++ b/addon/doxywizard/configdoc.cpp @@ -0,0 +1,2241 @@ +/* WARNING: This file is generated! + * Do not edit this file, but edit config.xml instead and run + * python configgen.py -wiz config.xml to regenerate this file! + */ +#include "configdoc.h" +#include "docintf.h" + +void addConfigDocs(DocIntf *doc) +{ + doc->setHeader( + "This file describes the settings to be used by the documentation system\n" + "doxygen (www.doxygen.org) for a project.\n" + "\n" + "All text after a double hash (##) is considered a comment and is placed in\n" + "front of the TAG it is preceding.\n" + "\n" + "All text after a single hash (#) is considered a comment and will be ignored.\n" + "The format is:\n" + "TAG = value [value, ...]\n" + "For lists, items can also be appended using:\n" + "TAG += value [value, ...]\n" + "Values that contain spaces should be placed between quotes (\\\" \\\")." + ); + doc->add( + "DOXYFILE_ENCODING", + "This tag specifies the encoding used for all characters in the config file\n" + "that follow. The default is UTF-8 which is also the encoding used for all text\n" + "before the first occurrence of this tag. Doxygen uses libiconv (or the iconv\n" + "built into libc) for the transcoding. See http://www.gnu.org/software/libiconv\n" + "for the list of possible encodings.\n" + "The default value is: UTF-8." + ); + doc->add( + "PROJECT_NAME", + "The PROJECT_NAME tag is a single word (or a sequence of words surrounded by\n" + "double-quotes, unless you are using Doxywizard) that should identify the\n" + "project for which the documentation is generated. This name is used in the\n" + "title of most generated pages and in a few other places.\n" + "The default value is: My Project." + ); + doc->add( + "PROJECT_NUMBER", + "The PROJECT_NUMBER tag can be used to enter a project or revision number. This\n" + "could be handy for archiving the generated documentation or if some version\n" + "control system is used." + ); + doc->add( + "PROJECT_BRIEF", + "Using the PROJECT_BRIEF tag one can provide an optional one line description\n" + "for a project that appears at the top of each page and should give viewer a\n" + "quick idea about the purpose of the project. Keep the description short." + ); + doc->add( + "PROJECT_LOGO", + "With the PROJECT_LOGO tag one can specify an logo or icon that is included in\n" + "the documentation. The maximum height of the logo should not exceed 55 pixels\n" + "and the maximum width should not exceed 200 pixels. Doxygen will copy the logo\n" + "to the output directory." + ); + doc->add( + "OUTPUT_DIRECTORY", + "The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path\n" + "into which the generated documentation will be written. If a relative path is\n" + "entered, it will be relative to the location where doxygen was started. If\n" + "left blank the current directory will be used." + ); + doc->add( + "CREATE_SUBDIRS", + "If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-\n" + "directories (in 2 levels) under the output directory of each output format and\n" + "will distribute the generated files over these directories. Enabling this\n" + "option can be useful when feeding doxygen a huge amount of source files, where\n" + "putting all generated files in the same directory would otherwise causes\n" + "performance problems for the file system.\n" + "The default value is: NO." + ); + doc->add( + "OUTPUT_LANGUAGE", + "The OUTPUT_LANGUAGE tag is used to specify the language in which all\n" + "documentation generated by doxygen is written. Doxygen will use this\n" + "information to generate all constant output in the proper language.\n" + "Possible values are: Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-\n" + "Traditional, Croatian, Czech, Danish, Dutch, English, Esperanto, Farsi,\n" + "Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en,\n" + "Korean, Korean-en, Latvian, Norwegian, Macedonian, Persian, Polish,\n" + "Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish,\n" + "Turkish, Ukrainian and Vietnamese.\n" + "The default value is: English." + ); + doc->add( + "BRIEF_MEMBER_DESC", + "If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member\n" + "descriptions after the members that are listed in the file and class\n" + "documentation (similar to Javadoc). Set to NO to disable this.\n" + "The default value is: YES." + ); + doc->add( + "REPEAT_BRIEF", + "If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief\n" + "description of a member or function before the detailed description\n" + "\n" + "Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the\n" + "brief descriptions will be completely suppressed.\n" + "The default value is: YES." + ); + doc->add( + "ABBREVIATE_BRIEF", + "This tag implements a quasi-intelligent brief description abbreviator that is\n" + "used to form the text in various listings. Each string in this list, if found\n" + "as the leading text of the brief description, will be stripped from the text\n" + "and the result, after processing the whole list, is used as the annotated\n" + "text. Otherwise, the brief description is used as-is. If left blank, the\n" + "following values are used ($name is automatically replaced with the name of\n" + "the entity):The $name class, The $name widget, The $name file, is, provides,\n" + "specifies, contains, represents, a, an and the." + ); + doc->add( + "ALWAYS_DETAILED_SEC", + "If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then\n" + "doxygen will generate a detailed section even if there is only a brief\n" + "description.\n" + "The default value is: NO." + ); + doc->add( + "INLINE_INHERITED_MEMB", + "If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all\n" + "inherited members of a class in the documentation of that class as if those\n" + "members were ordinary class members. Constructors, destructors and assignment\n" + "operators of the base classes will not be shown.\n" + "The default value is: NO." + ); + doc->add( + "FULL_PATH_NAMES", + "If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path\n" + "before files name in the file list and in the header files. If set to NO the\n" + "shortest path that makes the file name unique will be used\n" + "The default value is: YES." + ); + doc->add( + "STRIP_FROM_PATH", + "The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.\n" + "Stripping is only done if one of the specified strings matches the left-hand\n" + "part of the path. The tag can be used to show relative paths in the file list.\n" + "If left blank the directory from which doxygen is run is used as the path to\n" + "strip.\n" + "\n" + "Note that you can specify absolute paths here, but also relative paths, which\n" + "will be relative from the directory where doxygen is started.\n" + "This tag requires that the tag FULL_PATH_NAMES is set to YES." + ); + doc->add( + "STRIP_FROM_INC_PATH", + "The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the\n" + "path mentioned in the documentation of a class, which tells the reader which\n" + "header file to include in order to use a class. If left blank only the name of\n" + "the header file containing the class definition is used. Otherwise one should\n" + "specify the list of include paths that are normally passed to the compiler\n" + "using the -I flag." + ); + doc->add( + "SHORT_NAMES", + "If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but\n" + "less readable) file names. This can be useful is your file systems doesn't\n" + "support long names like on DOS, Mac, or CD-ROM.\n" + "The default value is: NO." + ); + doc->add( + "JAVADOC_AUTOBRIEF", + "If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the\n" + "first line (until the first dot) of a Javadoc-style comment as the brief\n" + "description. If set to NO, the Javadoc-style will behave just like regular Qt-\n" + "style comments (thus requiring an explicit @brief command for a brief\n" + "description.)\n" + "The default value is: NO." + ); + doc->add( + "QT_AUTOBRIEF", + "If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first\n" + "line (until the first dot) of a Qt-style comment as the brief description. If\n" + "set to NO, the Qt-style will behave just like regular Qt-style comments (thus\n" + "requiring an explicit \\brief command for a brief description.)\n" + "The default value is: NO." + ); + doc->add( + "MULTILINE_CPP_IS_BRIEF", + "The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a\n" + "multi-line C++ special comment block (i.e. a block of //! or /// comments) as\n" + "a brief description. This used to be the default behavior. The new default is\n" + "to treat a multi-line C++ comment block as a detailed description. Set this\n" + "tag to YES if you prefer the old behavior instead.\n" + "\n" + "Note that setting this tag to YES also means that rational rose comments are\n" + "not recognized any more.\n" + "The default value is: NO." + ); + doc->add( + "INHERIT_DOCS", + "If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the\n" + "documentation from any documented member that it re-implements.\n" + "The default value is: YES." + ); + doc->add( + "SEPARATE_MEMBER_PAGES", + "If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a\n" + "new page for each member. If set to NO, the documentation of a member will be\n" + "part of the file/class/namespace that contains it.\n" + "The default value is: NO." + ); + doc->add( + "TAB_SIZE", + "The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen\n" + "uses this value to replace tabs by spaces in code fragments.\n" + "Minimum value: 1, maximum value: 16, default value: 4." + ); + doc->add( + "ALIASES", + "This tag can be used to specify a number of aliases that act as commands in\n" + "the documentation. An alias has the form:\n" + "name=value\n" + "For example adding\n" + "\"sideeffect=@par Side Effects:\\n\"\n" + "will allow you to put the command \\sideeffect (or @sideeffect) in the\n" + "documentation, which will result in a user-defined paragraph with heading\n" + "\"Side Effects:\". You can put \\n's in the value part of an alias to insert\n" + "newlines." + ); + doc->add( + "TCL_SUBST", + "This tag can be used to specify a number of word-keyword mappings (TCL only).\n" + "A mapping has the form \"name=value\". For example adding \"class=itcl::class\"\n" + "will allow you to use the command class in the itcl::class meaning." + ); + doc->add( + "OPTIMIZE_OUTPUT_FOR_C", + "Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources\n" + "only. Doxygen will then generate output that is more tailored for C. For\n" + "instance, some of the names that are used will be different. The list of all\n" + "members will be omitted, etc.\n" + "The default value is: NO." + ); + doc->add( + "OPTIMIZE_OUTPUT_JAVA", + "Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or\n" + "Python sources only. Doxygen will then generate output that is more tailored\n" + "for that language. For instance, namespaces will be presented as packages,\n" + "qualified scopes will look different, etc.\n" + "The default value is: NO." + ); + doc->add( + "OPTIMIZE_FOR_FORTRAN", + "Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran\n" + "sources. Doxygen will then generate output that is tailored for Fortran.\n" + "The default value is: NO." + ); + doc->add( + "OPTIMIZE_OUTPUT_VHDL", + "Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL\n" + "sources. Doxygen will then generate output that is tailored for VHDL.\n" + "The default value is: NO." + ); + doc->add( + "EXTENSION_MAPPING", + "Doxygen selects the parser to use depending on the extension of the files it\n" + "parses. With this tag you can assign which parser to use for a given\n" + "extension. Doxygen has a built-in mapping, but you can override or extend it\n" + "using this tag. The format is ext=language, where ext is a file extension, and\n" + "language is one of the parsers supported by doxygen: IDL, Java, Javascript,\n" + "C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make\n" + "doxygen treat .inc files as Fortran files (default is PHP), and .f files as C\n" + "(default is Fortran), use: inc=Fortran f=C.\n" + "\n" + "Note For files without extension you can use no_extension as a placeholder.\n" + "\n" + "Note that for custom extensions you also need to set FILE_PATTERNS otherwise\n" + "the files are not read by doxygen." + ); + doc->add( + "MARKDOWN_SUPPORT", + "If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments\n" + "according to the Markdown format, which allows for more readable\n" + "documentation. See http://daringfireball.net/projects/markdown/ for details.\n" + "The output of markdown processing is further processed by doxygen, so you can\n" + "mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in\n" + "case of backward compatibilities issues.\n" + "The default value is: YES." + ); + doc->add( + "AUTOLINK_SUPPORT", + "When enabled doxygen tries to link words that correspond to documented\n" + "classes, or namespaces to their corresponding documentation. Such a link can\n" + "be prevented in individual cases by by putting a % sign in front of the word\n" + "or globally by setting AUTOLINK_SUPPORT to NO.\n" + "The default value is: YES." + ); + doc->add( + "BUILTIN_STL_SUPPORT", + "If you use STL classes (i.e. std::string, std::vector, etc.) but do not want\n" + "to include (a tag file for) the STL sources as input, then you should set this\n" + "tag to YES in order to let doxygen match functions declarations and\n" + "definitions whose arguments contain STL classes (e.g. func(std::string);\n" + "versus func(std::string) {}). This also make the inheritance and collaboration\n" + "diagrams that involve STL classes more complete and accurate.\n" + "The default value is: NO." + ); + doc->add( + "CPP_CLI_SUPPORT", + "If you use Microsoft's C++/CLI language, you should set this option to YES to\n" + "enable parsing support.\n" + "The default value is: NO." + ); + doc->add( + "SIP_SUPPORT", + "Set the SIP_SUPPORT tag to YES if your project consists of sip (see:\n" + "http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen\n" + "will parse them like normal C++ but will assume all classes use public instead\n" + "of private inheritance when no explicit protection keyword is present.\n" + "The default value is: NO." + ); + doc->add( + "IDL_PROPERTY_SUPPORT", + "For Microsoft's IDL there are propget and propput attributes to indicate\n" + "getter and setter methods for a property. Setting this option to YES will make\n" + "doxygen to replace the get and set methods by a property in the documentation.\n" + "This will only work if the methods are indeed getting or setting a simple\n" + "type. If this is not the case, or you want to show the methods anyway, you\n" + "should set this option to NO.\n" + "The default value is: YES." + ); + doc->add( + "DISTRIBUTE_GROUP_DOC", + "If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC\n" + "tag is set to YES, then doxygen will reuse the documentation of the first\n" + "member in the group (if any) for the other members of the group. By default\n" + "all members of a group must be documented explicitly.\n" + "The default value is: NO." + ); + doc->add( + "SUBGROUPING", + "Set the SUBGROUPING tag to YES to allow class member groups of the same type\n" + "(for instance a group of public functions) to be put as a subgroup of that\n" + "type (e.g. under the Public Functions section). Set it to NO to prevent\n" + "subgrouping. Alternatively, this can be done per class using the\n" + "\\nosubgrouping command.\n" + "The default value is: YES." + ); + doc->add( + "INLINE_GROUPED_CLASSES", + "When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions\n" + "are shown inside the group in which they are included (e.g. using \\ingroup)\n" + "instead of on a separate page (for HTML and Man pages) or section (for LaTeX\n" + "and RTF).\n" + "\n" + "Note that this feature does not work in combination with\n" + "SEPARATE_MEMBER_PAGES.\n" + "The default value is: NO." + ); + doc->add( + "INLINE_SIMPLE_STRUCTS", + "When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions\n" + "with only public data fields or simple typedef fields will be shown inline in\n" + "the documentation of the scope in which they are defined (i.e. file,\n" + "namespace, or group documentation), provided this scope is documented. If set\n" + "to NO, structs, classes, and unions are shown on a separate page (for HTML and\n" + "Man pages) or section (for LaTeX and RTF).\n" + "The default value is: NO." + ); + doc->add( + "TYPEDEF_HIDES_STRUCT", + "When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or\n" + "enum is documented as struct, union, or enum with the name of the typedef. So\n" + "typedef struct TypeS {} TypeT, will appear in the documentation as a struct\n" + "with name TypeT. When disabled the typedef will appear as a member of a file,\n" + "namespace, or class. And the struct will be named TypeS. This can typically be\n" + "useful for C code in case the coding convention dictates that all compound\n" + "types are typedef'ed and only the typedef is referenced, never the tag name.\n" + "The default value is: NO." + ); + doc->add( + "LOOKUP_CACHE_SIZE", + "The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This\n" + "cache is used to resolve symbols given their name and scope. Since this can be\n" + "an expensive process and often the same symbol appears multiple times in the\n" + "code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small\n" + "doxygen will become slower. If the cache is too large, memory is wasted. The\n" + "cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range\n" + "is 0..9, the default is 0, corresponding to a cache size of 2^16=65536\n" + "symbols. At the end of a run doxygen will report the cache usage and suggest\n" + "the optimal cache size from a speed point of view.\n" + "Minimum value: 0, maximum value: 9, default value: 0." + ); + doc->add( + "EXTRACT_ALL", + "If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in\n" + "documentation are documented, even if no documentation was available. Private\n" + "class members and static file members will be hidden unless the\n" + "EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.\n" + "Note: This will also disable the warnings about undocumented members that are\n" + "normally produced when WARNINGS is set to YES.\n" + "The default value is: NO." + ); + doc->add( + "EXTRACT_PRIVATE", + "If the EXTRACT_PRIVATE tag is set to YES all private members of a class will\n" + "be included in the documentation.\n" + "The default value is: NO." + ); + doc->add( + "EXTRACT_PACKAGE", + "If the EXTRACT_PACKAGE tag is set to YES all members with package or internal\n" + "scope will be included in the documentation.\n" + "The default value is: NO." + ); + doc->add( + "EXTRACT_STATIC", + "If the EXTRACT_STATIC tag is set to YES all static members of a file will be\n" + "included in the documentation.\n" + "The default value is: NO." + ); + doc->add( + "EXTRACT_LOCAL_CLASSES", + "If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined\n" + "locally in source files will be included in the documentation. If set to NO\n" + "only classes defined in header files are included. Does not have any effect\n" + "for Java sources.\n" + "The default value is: YES." + ); + doc->add( + "EXTRACT_LOCAL_METHODS", + "This flag is only useful for Objective-C code. When set to YES local methods,\n" + "which are defined in the implementation section but not in the interface are\n" + "included in the documentation. If set to NO only methods in the interface are\n" + "included.\n" + "The default value is: NO." + ); + doc->add( + "EXTRACT_ANON_NSPACES", + "If this flag is set to YES, the members of anonymous namespaces will be\n" + "extracted and appear in the documentation as a namespace called\n" + "'anonymous_namespace{file}', where file will be replaced with the base name of\n" + "the file that contains the anonymous namespace. By default anonymous namespace\n" + "are hidden.\n" + "The default value is: NO." + ); + doc->add( + "HIDE_UNDOC_MEMBERS", + "If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all\n" + "undocumented members inside documented classes or files. If set to NO these\n" + "members will be included in the various overviews, but no documentation\n" + "section is generated. This option has no effect if EXTRACT_ALL is enabled.\n" + "The default value is: NO." + ); + doc->add( + "HIDE_UNDOC_CLASSES", + "If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all\n" + "undocumented classes that are normally visible in the class hierarchy. If set\n" + "to NO these classes will be included in the various overviews. This option has\n" + "no effect if EXTRACT_ALL is enabled.\n" + "The default value is: NO." + ); + doc->add( + "HIDE_FRIEND_COMPOUNDS", + "If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend\n" + "(class|struct|union) declarations. If set to NO these declarations will be\n" + "included in the documentation.\n" + "The default value is: NO." + ); + doc->add( + "HIDE_IN_BODY_DOCS", + "If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any\n" + "documentation blocks found inside the body of a function. If set to NO these\n" + "blocks will be appended to the function's detailed documentation block.\n" + "The default value is: NO." + ); + doc->add( + "INTERNAL_DOCS", + "The INTERNAL_DOCS tag determines if documentation that is typed after a\n" + "\\internal command is included. If the tag is set to NO then the documentation\n" + "will be excluded. Set it to YES to include the internal documentation.\n" + "The default value is: NO." + ); + doc->add( + "CASE_SENSE_NAMES", + "If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file\n" + "names in lower-case letters. If set to YES upper-case letters are also\n" + "allowed. This is useful if you have classes or files whose names only differ\n" + "in case and if your file system supports case sensitive file names. Windows\n" + "and Mac users are advised to set this option to NO.\n" + "The default value is: system dependent." + ); + doc->add( + "HIDE_SCOPE_NAMES", + "If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with\n" + "their full class and namespace scopes in the documentation. If set to YES the\n" + "scope will be hidden.\n" + "The default value is: NO." + ); + doc->add( + "SHOW_INCLUDE_FILES", + "If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of\n" + "the files that are included by a file in the documentation of that file.\n" + "The default value is: YES." + ); + doc->add( + "FORCE_LOCAL_INCLUDES", + "If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include\n" + "files with double quotes in the documentation rather than with sharp brackets.\n" + "The default value is: NO." + ); + doc->add( + "INLINE_INFO", + "If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the\n" + "documentation for inline members.\n" + "The default value is: YES." + ); + doc->add( + "SORT_MEMBER_DOCS", + "If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the\n" + "(detailed) documentation of file and class members alphabetically by member\n" + "name. If set to NO the members will appear in declaration order.\n" + "The default value is: YES." + ); + doc->add( + "SORT_BRIEF_DOCS", + "If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief\n" + "descriptions of file, namespace and class members alphabetically by member\n" + "name. If set to NO the members will appear in declaration order.\n" + "The default value is: NO." + ); + doc->add( + "SORT_MEMBERS_CTORS_1ST", + "If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the\n" + "(brief and detailed) documentation of class members so that constructors and\n" + "destructors are listed first. If set to NO the constructors will appear in the\n" + "respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.\n" + "Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief\n" + "member documentation.\n" + "Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting\n" + "detailed member documentation.\n" + "The default value is: NO." + ); + doc->add( + "SORT_GROUP_NAMES", + "If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy\n" + "of group names into alphabetical order. If set to NO the group names will\n" + "appear in their defined order.\n" + "The default value is: NO." + ); + doc->add( + "SORT_BY_SCOPE_NAME", + "If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by\n" + "fully-qualified names, including namespaces. If set to NO, the class list will\n" + "be sorted only by class name, not including the namespace part.\n" + "Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.\n" + "Note: This option applies only to the class list, not to the alphabetical\n" + "list.\n" + "The default value is: NO." + ); + doc->add( + "STRICT_PROTO_MATCHING", + "If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper\n" + "type resolution of all parameters of a function it will reject a match between\n" + "the prototype and the implementation of a member function even if there is\n" + "only one candidate or it is obvious which candidate to choose by doing a\n" + "simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still\n" + "accept a match between prototype and implementation in such cases.\n" + "The default value is: NO." + ); + doc->add( + "GENERATE_TODOLIST", + "The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the\n" + "todo list. This list is created by putting \\todo commands in the\n" + "documentation.\n" + "The default value is: YES." + ); + doc->add( + "GENERATE_TESTLIST", + "The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the\n" + "test list. This list is created by putting \\test commands in the\n" + "documentation.\n" + "The default value is: YES." + ); + doc->add( + "GENERATE_BUGLIST", + "The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug\n" + "list. This list is created by putting \\bug commands in the documentation.\n" + "The default value is: YES." + ); + doc->add( + "GENERATE_DEPRECATEDLIST", + "The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)\n" + "the deprecated list. This list is created by putting \\deprecated commands in\n" + "the documentation.\n" + "The default value is: YES." + ); + doc->add( + "ENABLED_SECTIONS", + "The ENABLED_SECTIONS tag can be used to enable conditional documentation\n" + "sections, marked by \\if ... \\endif and \\cond \n" + "... \\endcond blocks." + ); + doc->add( + "MAX_INITIALIZER_LINES", + "The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the\n" + "initial value of a variable or macro / define can have for it to appear in the\n" + "documentation. If the initializer consists of more lines than specified here\n" + "it will be hidden. Use a value of 0 to hide initializers completely. The\n" + "appearance of the value of individual variables and macros / defines can be\n" + "controlled using \\showinitializer or \\hideinitializer command in the\n" + "documentation regardless of this setting.\n" + "Minimum value: 0, maximum value: 10000, default value: 30." + ); + doc->add( + "SHOW_USED_FILES", + "Set the SHOW_USED_FILES tag to NO to disable the list of files generated at\n" + "the bottom of the documentation of classes and structs. If set to YES the list\n" + "will mention the files that were used to generate the documentation.\n" + "The default value is: YES." + ); + doc->add( + "SHOW_FILES", + "Set the SHOW_FILES tag to NO to disable the generation of the Files page. This\n" + "will remove the Files entry from the Quick Index and from the Folder Tree View\n" + "(if specified).\n" + "The default value is: YES." + ); + doc->add( + "SHOW_NAMESPACES", + "Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces\n" + "page. This will remove the Namespaces entry from the Quick Index and from the\n" + "Folder Tree View (if specified).\n" + "The default value is: YES." + ); + doc->add( + "FILE_VERSION_FILTER", + "The FILE_VERSION_FILTER tag can be used to specify a program or script that\n" + "doxygen should invoke to get the current version for each file (typically from\n" + "the version control system). Doxygen will invoke the program by executing (via\n" + "popen()) the command command input-file, where command is the value of the\n" + "FILE_VERSION_FILTER tag, and input-file is the name of an input file provided\n" + "by doxygen. Whatever the program writes to standard output is used as the file\n" + "version. For an example see the documentation." + ); + doc->add( + "LAYOUT_FILE", + "The LAYOUT_FILE tag can be used to specify a layout file which will be parsed\n" + "by doxygen. The layout file controls the global structure of the generated\n" + "output files in an output format independent way. To create the layout file\n" + "that represents doxygen's defaults, run doxygen with the -l option. You can\n" + "optionally specify a file name after the option, if omitted DoxygenLayout.xml\n" + "will be used as the name of the layout file.\n" + "\n" + "Note that if you run doxygen from a directory containing a file called\n" + "DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE\n" + "tag is left empty." + ); + doc->add( + "CITE_BIB_FILES", + "The CITE_BIB_FILES tag can be used to specify one or more bib files containing\n" + "the reference definitions. This must be a list of .bib files. The .bib\n" + "extension is automatically appended if omitted. This requires the bibtex tool\n" + "to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.\n" + "For LaTeX the style of the bibliography can be controlled using\n" + "LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the\n" + "search path. Do not use file names with spaces, bibtex cannot handle them. See\n" + "also \\cite for info how to create references." + ); + doc->add( + "QUIET", + "The QUIET tag can be used to turn on/off the messages that are generated to\n" + "standard output by doxygen. If QUIET is set to YES this implies that the\n" + "messages are off.\n" + "The default value is: NO." + ); + doc->add( + "WARNINGS", + "The WARNINGS tag can be used to turn on/off the warning messages that are\n" + "generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES\n" + "this implies that the warnings are on.\n" + "\n" + "Tip: Turn warnings on while writing the documentation.\n" + "The default value is: YES." + ); + doc->add( + "WARN_IF_UNDOCUMENTED", + "If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate\n" + "warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag\n" + "will automatically be disabled.\n" + "The default value is: YES." + ); + doc->add( + "WARN_IF_DOC_ERROR", + "If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for\n" + "potential errors in the documentation, such as not documenting some parameters\n" + "in a documented function, or documenting parameters that don't exist or using\n" + "markup commands wrongly.\n" + "The default value is: YES." + ); + doc->add( + "WARN_NO_PARAMDOC", + "This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that\n" + "are documented, but have no documentation for their parameters or return\n" + "value. If set to NO doxygen will only warn about wrong or incomplete parameter\n" + "documentation, but not about the absence of documentation.\n" + "The default value is: NO." + ); + doc->add( + "WARN_FORMAT", + "The WARN_FORMAT tag determines the format of the warning messages that doxygen\n" + "can produce. The string should contain the $file, $line, and $text tags, which\n" + "will be replaced by the file and line number from which the warning originated\n" + "and the warning text. Optionally the format may contain $version, which will\n" + "be replaced by the version of the file (if it could be obtained via\n" + "FILE_VERSION_FILTER)\n" + "The default value is: $file:$line: $text." + ); + doc->add( + "WARN_LOGFILE", + "The WARN_LOGFILE tag can be used to specify a file to which warning and error\n" + "messages should be written. If left blank the output is written to standard\n" + "error (stderr)." + ); + doc->add( + "INPUT", + "The INPUT tag is used to specify the files and/or directories that contain\n" + "documented source files. You may enter file names like myfile.cpp or\n" + "directories like /usr/src/myproject. Separate the files or directories with\n" + "spaces.\n" + "Note: If this tag is empty the current directory is searched." + ); + doc->add( + "INPUT_ENCODING", + "This tag can be used to specify the character encoding of the source files\n" + "that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses\n" + "libiconv (or the iconv built into libc) for the transcoding. See the libiconv\n" + "documentation (see: http://www.gnu.org/software/libiconv) for the list of\n" + "possible encodings.\n" + "The default value is: UTF-8." + ); + doc->add( + "FILE_PATTERNS", + "If the value of the INPUT tag contains directories, you can use the\n" + "FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and\n" + "*.h) to filter out the source-files in the directories. If left blank the\n" + "following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,\n" + "*.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,\n" + "*.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,\n" + "*.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,\n" + "*.qsf, *.as and *.js." + ); + doc->add( + "RECURSIVE", + "The RECURSIVE tag can be used to specify whether or not subdirectories should\n" + "be searched for input files as well.\n" + "The default value is: NO." + ); + doc->add( + "EXCLUDE", + "The EXCLUDE tag can be used to specify files and/or directories that should be\n" + "excluded from the INPUT source files. This way you can easily exclude a\n" + "subdirectory from a directory tree whose root is specified with the INPUT tag.\n" + "\n" + "Note that relative paths are relative to the directory from which doxygen is\n" + "run." + ); + doc->add( + "EXCLUDE_SYMLINKS", + "The EXCLUDE_SYMLINKS tag can be used to select whether or not files or\n" + "directories that are symbolic links (a Unix file system feature) are excluded\n" + "from the input.\n" + "The default value is: NO." + ); + doc->add( + "EXCLUDE_PATTERNS", + "If the value of the INPUT tag contains directories, you can use the\n" + "EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude\n" + "certain files from those directories.\n" + "\n" + "Note that the wildcards are matched against the file with absolute path, so to\n" + "exclude all test directories for example use the pattern */test/*" + ); + doc->add( + "EXCLUDE_SYMBOLS", + "The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names\n" + "(namespaces, classes, functions, etc.) that should be excluded from the\n" + "output. The symbol name can be a fully qualified name, a word, or if the\n" + "wildcard * is used, a substring. Examples: ANamespace, AClass,\n" + "AClass::ANamespace, ANamespace::*Test\n" + "\n" + "Note that the wildcards are matched against the file with absolute path, so to\n" + "exclude all test directories use the pattern */test/*" + ); + doc->add( + "EXAMPLE_PATH", + "The EXAMPLE_PATH tag can be used to specify one or more files or directories\n" + "that contain example code fragments that are included (see the \\include\n" + "command)." + ); + doc->add( + "EXAMPLE_PATTERNS", + "If the value of the EXAMPLE_PATH tag contains directories, you can use the\n" + "EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and\n" + "*.h) to filter out the source-files in the directories. If left blank all\n" + "files are included." + ); + doc->add( + "EXAMPLE_RECURSIVE", + "If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be\n" + "searched for input files to be used with the \\include or \\dontinclude commands\n" + "irrespective of the value of the RECURSIVE tag.\n" + "The default value is: NO." + ); + doc->add( + "IMAGE_PATH", + "The IMAGE_PATH tag can be used to specify one or more files or directories\n" + "that contain images that are to be included in the documentation (see the\n" + "\\image command)." + ); + doc->add( + "INPUT_FILTER", + "The INPUT_FILTER tag can be used to specify a program that doxygen should\n" + "invoke to filter for each input file. Doxygen will invoke the filter program\n" + "by executing (via popen()) the command:\n" + "\n" + " \n" + "\n" + "where is the value of the INPUT_FILTER tag, and is the\n" + "name of an input file. Doxygen will then use the output that the filter\n" + "program writes to standard output. If FILTER_PATTERNS is specified, this tag\n" + "will be ignored.\n" + "\n" + "Note that the filter must not add or remove lines; it is applied before the\n" + "code is scanned, but not when the output code is generated. If lines are added\n" + "or removed, the anchors will not be placed correctly." + ); + doc->add( + "FILTER_PATTERNS", + "The FILTER_PATTERNS tag can be used to specify filters on a per file pattern\n" + "basis. Doxygen will compare the file name with each pattern and apply the\n" + "filter if there is a match. The filters are a list of the form: pattern=filter\n" + "(like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how\n" + "filters are used. If the FILTER_PATTERNS tag is empty or if none of the\n" + "patterns match the file name, INPUT_FILTER is applied." + ); + doc->add( + "FILTER_SOURCE_FILES", + "If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using\n" + "INPUT_FILTER ) will also be used to filter the input files that are used for\n" + "producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).\n" + "The default value is: NO." + ); + doc->add( + "FILTER_SOURCE_PATTERNS", + "The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file\n" + "pattern. A pattern will override the setting for FILTER_PATTERN (if any) and\n" + "it is also possible to disable source filtering for a specific pattern using\n" + "*.ext= (so without naming a filter).\n" + "This tag requires that the tag FILTER_SOURCE_FILES is set to YES." + ); + doc->add( + "USE_MDFILE_AS_MAINPAGE", + "If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that\n" + "is part of the input, its contents will be placed on the main page\n" + "(index.html). This can be useful if you have a project on for instance GitHub\n" + "and want to reuse the introduction page also for the doxygen output." + ); + doc->add( + "SOURCE_BROWSER", + "If the SOURCE_BROWSER tag is set to YES then a list of source files will be\n" + "generated. Documented entities will be cross-referenced with these sources.\n" + "\n" + "Note: To get rid of all source code in the generated output, make sure that\n" + "also VERBATIM_HEADERS is set to NO.\n" + "The default value is: NO." + ); + doc->add( + "INLINE_SOURCES", + "Setting the INLINE_SOURCES tag to YES will include the body of functions,\n" + "classes and enums directly into the documentation.\n" + "The default value is: NO." + ); + doc->add( + "STRIP_CODE_COMMENTS", + "Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any\n" + "special comment blocks from generated source code fragments. Normal C, C++ and\n" + "Fortran comments will always remain visible.\n" + "The default value is: YES." + ); + doc->add( + "REFERENCED_BY_RELATION", + "If the REFERENCED_BY_RELATION tag is set to YES then for each documented\n" + "function all documented functions referencing it will be listed.\n" + "The default value is: NO." + ); + doc->add( + "REFERENCES_RELATION", + "If the REFERENCES_RELATION tag is set to YES then for each documented function\n" + "all documented entities called/used by that function will be listed.\n" + "The default value is: NO." + ); + doc->add( + "REFERENCES_LINK_SOURCE", + "If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set\n" + "to YES, then the hyperlinks from functions in REFERENCES_RELATION and\n" + "REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will\n" + "link to the documentation.\n" + "The default value is: YES." + ); + doc->add( + "SOURCE_TOOLTIPS", + "If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the\n" + "source code will show a tooltip with additional information such as prototype,\n" + "brief description and links to the definition and documentation. Since this\n" + "will make the HTML file larger and loading of large files a bit slower, you\n" + "can opt to disable this feature.\n" + "The default value is: YES.\n" + "This tag requires that the tag SOURCE_BROWSER is set to YES." + ); + doc->add( + "USE_HTAGS", + "If the USE_HTAGS tag is set to YES then the references to source code will\n" + "point to the HTML generated by the htags(1) tool instead of doxygen built-in\n" + "source browser. The htags tool is part of GNU's global source tagging system\n" + "(see http://www.gnu.org/software/global/global.html). You will need version\n" + "4.8.6 or higher.\n" + "\n" + "To use it do the following:\n" + "- Install the latest version of global\n" + "- Enable SOURCE_BROWSER and USE_HTAGS in the config file\n" + "- Make sure the INPUT points to the root of the source tree\n" + "- Run doxygen as normal\n" + "\n" + "Doxygen will invoke htags (and that will in turn invoke gtags), so these\n" + "tools must be available from the command line (i.e. in the search path).\n" + "\n" + "The result: instead of the source browser generated by doxygen, the links to\n" + "source code will now point to the output of htags.\n" + "The default value is: NO.\n" + "This tag requires that the tag SOURCE_BROWSER is set to YES." + ); + doc->add( + "VERBATIM_HEADERS", + "If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a\n" + "verbatim copy of the header file for each class for which an include is\n" + "specified. Set to NO to disable this.\n" + "See also: Section \\class.\n" + "The default value is: YES." + ); + doc->add( + "CLANG_ASSISTED_PARSING", + "If the CLANG_ASSISTED_PARSING tag is set to YES, then doxygen will use the\n" + "clang parser (see: http://clang.llvm.org/) for more acurate parsing at the\n" + "cost of reduced performance. This can be particularly helpful with template\n" + "rich C++ code for which doxygen's built-in parser lacks the necessary type\n" + "information.\n" + "Note: The availability of this option depends on whether or not doxygen was\n" + "compiled with the --with-libclang option.\n" + "The default value is: NO." + ); + doc->add( + "CLANG_OPTIONS", + "If clang assisted parsing is enabled you can provide the compiler with command\n" + "line options that you would normally use when invoking the compiler. Note that\n" + "the include paths will already be set by doxygen for the files and directories\n" + "specified with INPUT and INCLUDE_PATH.\n" + "This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES." + ); + doc->add( + "ALPHABETICAL_INDEX", + "If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all\n" + "compounds will be generated. Enable this if the project contains a lot of\n" + "classes, structs, unions or interfaces.\n" + "The default value is: YES." + ); + doc->add( + "COLS_IN_ALPHA_INDEX", + "The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in\n" + "which the alphabetical index list will be split.\n" + "Minimum value: 1, maximum value: 20, default value: 5.\n" + "This tag requires that the tag ALPHABETICAL_INDEX is set to YES." + ); + doc->add( + "IGNORE_PREFIX", + "In case all classes in a project start with a common prefix, all classes will\n" + "be put under the same header in the alphabetical index. The IGNORE_PREFIX tag\n" + "can be used to specify a prefix (or a list of prefixes) that should be ignored\n" + "while generating the index headers.\n" + "This tag requires that the tag ALPHABETICAL_INDEX is set to YES." + ); + doc->add( + "GENERATE_HTML", + "If the GENERATE_HTML tag is set to YES doxygen will generate HTML output\n" + "The default value is: YES." + ); + doc->add( + "HTML_OUTPUT", + "The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a\n" + "relative path is entered the value of OUTPUT_DIRECTORY will be put in front of\n" + "it.\n" + "The default directory is: html.\n" + "This tag requires that the tag GENERATE_HTML is set to YES." + ); + doc->add( + "HTML_FILE_EXTENSION", + "The HTML_FILE_EXTENSION tag can be used to specify the file extension for each\n" + "generated HTML page (for example: .htm, .php, .asp).\n" + "The default value is: .html.\n" + "This tag requires that the tag GENERATE_HTML is set to YES." + ); + doc->add( + "HTML_HEADER", + "The HTML_HEADER tag can be used to specify a user-defined HTML header file for\n" + "each generated HTML page. If the tag is left blank doxygen will generate a\n" + "standard header.\n" + "\n" + "To get valid HTML the header file that includes any scripts and style sheets\n" + "that doxygen needs, which is dependent on the configuration options used (e.g.\n" + "the setting GENERATE_TREEVIEW). It is highly recommended to start with a\n" + "default header using\n" + "doxygen -w html new_header.html new_footer.html new_stylesheet.css\n" + "YourConfigFile\n" + "and then modify the file new_header.html. See also section \"Doxygen usage\"\n" + "for information on how to generate the default header that doxygen normally\n" + "uses.\n" + "Note: The header is subject to change so you typically have to regenerate the\n" + "default header when upgrading to a newer version of doxygen. For a description\n" + "of the possible markers and block names see the documentation.\n" + "This tag requires that the tag GENERATE_HTML is set to YES." + ); + doc->add( + "HTML_FOOTER", + "The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each\n" + "generated HTML page. If the tag is left blank doxygen will generate a standard\n" + "footer. See HTML_HEADER for more information on how to generate a default\n" + "footer and what special commands can be used inside the footer. See also\n" + "section \"Doxygen usage\" for information on how to generate the default footer\n" + "that doxygen normally uses.\n" + "This tag requires that the tag GENERATE_HTML is set to YES." + ); + doc->add( + "HTML_STYLESHEET", + "The HTML_STYLESHEET tag can be used to specify a user-defined cascading style\n" + "sheet that is used by each HTML page. It can be used to fine-tune the look of\n" + "the HTML output. If left blank doxygen will generate a default style sheet.\n" + "See also section \"Doxygen usage\" for information on how to generate the style\n" + "sheet that doxygen normally uses.\n" + "Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as\n" + "it is more robust and this tag (HTML_STYLESHEET) will in the future become\n" + "obsolete.\n" + "This tag requires that the tag GENERATE_HTML is set to YES." + ); + doc->add( + "HTML_EXTRA_STYLESHEET", + "The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-\n" + "defined cascading style sheet that is included after the standard style sheets\n" + "created by doxygen. Using this option one can overrule certain style aspects.\n" + "This is preferred over using HTML_STYLESHEET since it does not replace the\n" + "standard style sheet and is therefor more robust against future updates.\n" + "Doxygen will copy the style sheet file to the output directory. For an example\n" + "see the documentation.\n" + "This tag requires that the tag GENERATE_HTML is set to YES." + ); + doc->add( + "HTML_EXTRA_FILES", + "The HTML_EXTRA_FILES tag can be used to specify one or more extra images or\n" + "other source files which should be copied to the HTML output directory. Note\n" + "that these files will be copied to the base HTML output directory. Use the\n" + "$relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these\n" + "files. In the HTML_STYLESHEET file, use the file name only. Also note that the\n" + "files will be copied as-is; there are no commands or markers available.\n" + "This tag requires that the tag GENERATE_HTML is set to YES." + ); + doc->add( + "HTML_COLORSTYLE_HUE", + "The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen\n" + "will adjust the colors in the stylesheet and background images according to\n" + "this color. Hue is specified as an angle on a colorwheel, see\n" + "http://en.wikipedia.org/wiki/Hue for more information. For instance the value\n" + "0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300\n" + "purple, and 360 is red again.\n" + "Minimum value: 0, maximum value: 359, default value: 220.\n" + "This tag requires that the tag GENERATE_HTML is set to YES." + ); + doc->add( + "HTML_COLORSTYLE_SAT", + "The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors\n" + "in the HTML output. For a value of 0 the output will use grayscales only. A\n" + "value of 255 will produce the most vivid colors.\n" + "Minimum value: 0, maximum value: 255, default value: 100.\n" + "This tag requires that the tag GENERATE_HTML is set to YES." + ); + doc->add( + "HTML_COLORSTYLE_GAMMA", + "The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the\n" + "luminance component of the colors in the HTML output. Values below 100\n" + "gradually make the output lighter, whereas values above 100 make the output\n" + "darker. The value divided by 100 is the actual gamma applied, so 80 represents\n" + "a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not\n" + "change the gamma.\n" + "Minimum value: 40, maximum value: 240, default value: 80.\n" + "This tag requires that the tag GENERATE_HTML is set to YES." + ); + doc->add( + "HTML_TIMESTAMP", + "If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML\n" + "page will contain the date and time when the page was generated. Setting this\n" + "to NO can help when comparing the output of multiple runs.\n" + "The default value is: YES.\n" + "This tag requires that the tag GENERATE_HTML is set to YES." + ); + doc->add( + "HTML_DYNAMIC_SECTIONS", + "If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML\n" + "documentation will contain sections that can be hidden and shown after the\n" + "page has loaded.\n" + "The default value is: NO.\n" + "This tag requires that the tag GENERATE_HTML is set to YES." + ); + doc->add( + "HTML_INDEX_NUM_ENTRIES", + "With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries\n" + "shown in the various tree structured indices initially; the user can expand\n" + "and collapse entries dynamically later on. Doxygen will expand the tree to\n" + "such a level that at most the specified number of entries are visible (unless\n" + "a fully collapsed tree already exceeds this amount). So setting the number of\n" + "entries 1 will produce a full collapsed tree by default. 0 is a special value\n" + "representing an infinite number of entries and will result in a full expanded\n" + "tree by default.\n" + "Minimum value: 0, maximum value: 9999, default value: 100.\n" + "This tag requires that the tag GENERATE_HTML is set to YES." + ); + doc->add( + "GENERATE_DOCSET", + "If the GENERATE_DOCSET tag is set to YES, additional index files will be\n" + "generated that can be used as input for Apple's Xcode 3 integrated development\n" + "environment (see: http://developer.apple.com/tools/xcode/), introduced with\n" + "OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a\n" + "Makefile in the HTML output directory. Running make will produce the docset in\n" + "that directory and running make install will install the docset in\n" + "~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at\n" + "startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html\n" + "for more information.\n" + "The default value is: NO.\n" + "This tag requires that the tag GENERATE_HTML is set to YES." + ); + doc->add( + "DOCSET_FEEDNAME", + "This tag determines the name of the docset feed. A documentation feed provides\n" + "an umbrella under which multiple documentation sets from a single provider\n" + "(such as a company or product suite) can be grouped.\n" + "The default value is: Doxygen generated docs.\n" + "This tag requires that the tag GENERATE_DOCSET is set to YES." + ); + doc->add( + "DOCSET_BUNDLE_ID", + "This tag specifies a string that should uniquely identify the documentation\n" + "set bundle. This should be a reverse domain-name style string, e.g.\n" + "com.mycompany.MyDocSet. Doxygen will append .docset to the name.\n" + "The default value is: org.doxygen.Project.\n" + "This tag requires that the tag GENERATE_DOCSET is set to YES." + ); + doc->add( + "DOCSET_PUBLISHER_ID", + "The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify\n" + "the documentation publisher. This should be a reverse domain-name style\n" + "string, e.g. com.mycompany.MyDocSet.documentation.\n" + "The default value is: org.doxygen.Publisher.\n" + "This tag requires that the tag GENERATE_DOCSET is set to YES." + ); + doc->add( + "DOCSET_PUBLISHER_NAME", + "The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.\n" + "The default value is: Publisher.\n" + "This tag requires that the tag GENERATE_DOCSET is set to YES." + ); + doc->add( + "GENERATE_HTMLHELP", + "If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three\n" + "additional HTML index files: index.hhp, index.hhc, and index.hhk. The\n" + "index.hhp is a project file that can be read by Microsoft's HTML Help Workshop\n" + "(see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on\n" + "Windows.\n" + "\n" + "The HTML Help Workshop contains a compiler that can convert all HTML output\n" + "generated by doxygen into a single compiled HTML file (.chm). Compiled HTML\n" + "files are now used as the Windows 98 help format, and will replace the old\n" + "Windows help format (.hlp) on all Windows platforms in the future. Compressed\n" + "HTML files also contain an index, a table of contents, and you can search for\n" + "words in the documentation. The HTML workshop also contains a viewer for\n" + "compressed HTML files.\n" + "The default value is: NO.\n" + "This tag requires that the tag GENERATE_HTML is set to YES." + ); + doc->add( + "CHM_FILE", + "The CHM_FILE tag can be used to specify the file name of the resulting .chm\n" + "file. You can add a path in front of the file if the result should not be\n" + "written to the html output directory.\n" + "This tag requires that the tag GENERATE_HTMLHELP is set to YES." + ); + doc->add( + "HHC_LOCATION", + "The HHC_LOCATION tag can be used to specify the location (absolute path\n" + "including file name) of the HTML help compiler ( hhc.exe). If non-empty\n" + "doxygen will try to run the HTML help compiler on the generated index.hhp.\n" + "The file has to be specified with full path.\n" + "This tag requires that the tag GENERATE_HTMLHELP is set to YES." + ); + doc->add( + "GENERATE_CHI", + "The GENERATE_CHI flag controls if a separate .chi index file is generated (\n" + "YES) or that it should be included in the master .chm file ( NO).\n" + "The default value is: NO.\n" + "This tag requires that the tag GENERATE_HTMLHELP is set to YES." + ); + doc->add( + "CHM_INDEX_ENCODING", + "The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)\n" + "and project file content.\n" + "This tag requires that the tag GENERATE_HTMLHELP is set to YES." + ); + doc->add( + "BINARY_TOC", + "The BINARY_TOC flag controls whether a binary table of contents is generated (\n" + "YES) or a normal table of contents ( NO) in the .chm file.\n" + "The default value is: NO.\n" + "This tag requires that the tag GENERATE_HTMLHELP is set to YES." + ); + doc->add( + "TOC_EXPAND", + "The TOC_EXPAND flag can be set to YES to add extra items for group members to\n" + "the table of contents of the HTML help documentation and to the tree view.\n" + "The default value is: NO.\n" + "This tag requires that the tag GENERATE_HTMLHELP is set to YES." + ); + doc->add( + "GENERATE_QHP", + "If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and\n" + "QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that\n" + "can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help\n" + "(.qch) of the generated HTML documentation.\n" + "The default value is: NO.\n" + "This tag requires that the tag GENERATE_HTML is set to YES." + ); + doc->add( + "QCH_FILE", + "If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify\n" + "the file name of the resulting .qch file. The path specified is relative to\n" + "the HTML output folder.\n" + "This tag requires that the tag GENERATE_QHP is set to YES." + ); + doc->add( + "QHP_NAMESPACE", + "The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help\n" + "Project output. For more information please see Qt Help Project / Namespace\n" + "(see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).\n" + "The default value is: org.doxygen.Project.\n" + "This tag requires that the tag GENERATE_QHP is set to YES." + ); + doc->add( + "QHP_VIRTUAL_FOLDER", + "The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt\n" + "Help Project output. For more information please see Qt Help Project / Virtual\n" + "Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-\n" + "folders).\n" + "The default value is: doc.\n" + "This tag requires that the tag GENERATE_QHP is set to YES." + ); + doc->add( + "QHP_CUST_FILTER_NAME", + "If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom\n" + "filter to add. For more information please see Qt Help Project / Custom\n" + "Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-\n" + "filters).\n" + "This tag requires that the tag GENERATE_QHP is set to YES." + ); + doc->add( + "QHP_CUST_FILTER_ATTRS", + "The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the\n" + "custom filter to add. For more information please see Qt Help Project / Custom\n" + "Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-\n" + "filters).\n" + "This tag requires that the tag GENERATE_QHP is set to YES." + ); + doc->add( + "QHP_SECT_FILTER_ATTRS", + "The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this\n" + "project's filter section matches. Qt Help Project / Filter Attributes (see:\n" + "http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).\n" + "This tag requires that the tag GENERATE_QHP is set to YES." + ); + doc->add( + "QHG_LOCATION", + "The QHG_LOCATION tag can be used to specify the location of Qt's\n" + "qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the\n" + "generated .qhp file.\n" + "This tag requires that the tag GENERATE_QHP is set to YES." + ); + doc->add( + "GENERATE_ECLIPSEHELP", + "If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be\n" + "generated, together with the HTML files, they form an Eclipse help plugin. To\n" + "install this plugin and make it available under the help contents menu in\n" + "Eclipse, the contents of the directory containing the HTML and XML files needs\n" + "to be copied into the plugins directory of eclipse. The name of the directory\n" + "within the plugins directory should be the same as the ECLIPSE_DOC_ID value.\n" + "After copying Eclipse needs to be restarted before the help appears.\n" + "The default value is: NO.\n" + "This tag requires that the tag GENERATE_HTML is set to YES." + ); + doc->add( + "ECLIPSE_DOC_ID", + "A unique identifier for the Eclipse help plugin. When installing the plugin\n" + "the directory name containing the HTML and XML files should also have this\n" + "name. Each documentation set should have its own identifier.\n" + "The default value is: org.doxygen.Project.\n" + "This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES." + ); + doc->add( + "DISABLE_INDEX", + "If you want full control over the layout of the generated HTML pages it might\n" + "be necessary to disable the index and replace it with your own. The\n" + "DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top\n" + "of each HTML page. A value of NO enables the index and the value YES disables\n" + "it. Since the tabs in the index contain the same information as the navigation\n" + "tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.\n" + "The default value is: NO.\n" + "This tag requires that the tag GENERATE_HTML is set to YES." + ); + doc->add( + "GENERATE_TREEVIEW", + "The GENERATE_TREEVIEW tag is used to specify whether a tree-like index\n" + "structure should be generated to display hierarchical information. If the tag\n" + "value is set to YES, a side panel will be generated containing a tree-like\n" + "index structure (just like the one that is generated for HTML Help). For this\n" + "to work a browser that supports JavaScript, DHTML, CSS and frames is required\n" + "(i.e. any modern browser). Windows users are probably better off using the\n" + "HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can\n" + "further fine-tune the look of the index. As an example, the default style\n" + "sheet generated by doxygen has an example that shows how to put an image at\n" + "the root of the tree instead of the PROJECT_NAME. Since the tree basically has\n" + "the same information as the tab index, you could consider setting\n" + "DISABLE_INDEX to YES when enabling this option.\n" + "The default value is: NO.\n" + "This tag requires that the tag GENERATE_HTML is set to YES." + ); + doc->add( + "ENUM_VALUES_PER_LINE", + "The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that\n" + "doxygen will group on one line in the generated HTML documentation.\n" + "\n" + "Note that a value of 0 will completely suppress the enum values from appearing\n" + "in the overview section.\n" + "Minimum value: 0, maximum value: 20, default value: 4.\n" + "This tag requires that the tag GENERATE_HTML is set to YES." + ); + doc->add( + "TREEVIEW_WIDTH", + "If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used\n" + "to set the initial width (in pixels) of the frame in which the tree is shown.\n" + "Minimum value: 0, maximum value: 1500, default value: 250.\n" + "This tag requires that the tag GENERATE_HTML is set to YES." + ); + doc->add( + "EXT_LINKS_IN_WINDOW", + "When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to\n" + "external symbols imported via tag files in a separate window.\n" + "The default value is: NO.\n" + "This tag requires that the tag GENERATE_HTML is set to YES." + ); + doc->add( + "FORMULA_FONTSIZE", + "Use this tag to change the font size of LaTeX formulas included as images in\n" + "the HTML documentation. When you change the font size after a successful\n" + "doxygen run you need to manually remove any form_*.png images from the HTML\n" + "output directory to force them to be regenerated.\n" + "Minimum value: 8, maximum value: 50, default value: 10.\n" + "This tag requires that the tag GENERATE_HTML is set to YES." + ); + doc->add( + "FORMULA_TRANSPARENT", + "Use the FORMULA_TRANPARENT tag to determine whether or not the images\n" + "generated for formulas are transparent PNGs. Transparent PNGs are not\n" + "supported properly for IE 6.0, but are supported on all modern browsers.\n" + "\n" + "Note that when changing this option you need to delete any form_*.png files in\n" + "the HTML output directory before the changes have effect.\n" + "The default value is: YES.\n" + "This tag requires that the tag GENERATE_HTML is set to YES." + ); + doc->add( + "USE_MATHJAX", + "Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see\n" + "http://www.mathjax.org) which uses client side Javascript for the rendering\n" + "instead of using prerendered bitmaps. Use this if you do not have LaTeX\n" + "installed or if you want to formulas look prettier in the HTML output. When\n" + "enabled you may also need to install MathJax separately and configure the path\n" + "to it using the MATHJAX_RELPATH option.\n" + "The default value is: NO.\n" + "This tag requires that the tag GENERATE_HTML is set to YES." + ); + doc->add( + "MATHJAX_FORMAT", + "When MathJax is enabled you can set the default output format to be used for\n" + "the MathJax output. See the MathJax site (see:\n" + "http://docs.mathjax.org/en/latest/output.html) for more details.\n" + "Possible values are: HTML-CSS (which is slower, but has the best\n" + "compatibility), NativeMML (i.e. MathML) and SVG.\n" + "The default value is: HTML-CSS.\n" + "This tag requires that the tag USE_MATHJAX is set to YES." + ); + doc->add( + "MATHJAX_RELPATH", + "When MathJax is enabled you need to specify the location relative to the HTML\n" + "output directory using the MATHJAX_RELPATH option. The destination directory\n" + "should contain the MathJax.js script. For instance, if the mathjax directory\n" + "is located at the same level as the HTML output directory, then\n" + "MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax\n" + "Content Delivery Network so you can quickly see the result without installing\n" + "MathJax. However, it is strongly recommended to install a local copy of\n" + "MathJax from http://www.mathjax.org before deployment.\n" + "The default value is: http://cdn.mathjax.org/mathjax/latest.\n" + "This tag requires that the tag USE_MATHJAX is set to YES." + ); + doc->add( + "MATHJAX_EXTENSIONS", + "The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax\n" + "extension names that should be enabled during MathJax rendering. For example\n" + "MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols\n" + "This tag requires that the tag USE_MATHJAX is set to YES." + ); + doc->add( + "MATHJAX_CODEFILE", + "The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces\n" + "of code that will be used on startup of the MathJax code. See the MathJax site\n" + "(see: http://docs.mathjax.org/en/latest/output.html) for more details. For an\n" + "example see the documentation.\n" + "This tag requires that the tag USE_MATHJAX is set to YES." + ); + doc->add( + "SEARCHENGINE", + "When the SEARCHENGINE tag is enabled doxygen will generate a search box for\n" + "the HTML output. The underlying search engine uses javascript and DHTML and\n" + "should work on any modern browser. Note that when using HTML help\n" + "(GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)\n" + "there is already a search function so this one should typically be disabled.\n" + "For large projects the javascript based search engine can be slow, then\n" + "enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to\n" + "search using the keyboard; to jump to the search box use + S\n" + "(what the is depends on the OS and browser, but it is typically\n" + ", / + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + - - - + + + + + + + + + +