{ "info": { "author": "Pawe\u0142 Tomulik", "author_email": "ptomulik@meil.pw.edu.pl", "bugtrack_url": null, "classifiers": [], "description": "scons-tool-doxyfile\n===================\n\n.. image:: https://badge.fury.io/py/scons-tool-doxyfile.svg\n :target: https://badge.fury.io/py/scons-tool-doxyfile\n :alt: PyPi package version\n\n.. image:: https://travis-ci.org/ptomulik/scons-tool-doxyfile.svg?branch=master\n :target: https://travis-ci.org/ptomulik/scons-tool-doxyfile\n :alt: Travis CI build status\n\n.. image:: https://ci.appveyor.com/api/projects/status/github/ptomulik/scons-tool-doxyfile?svg=true\n :target: https://ci.appveyor.com/project/ptomulik/scons-tool-doxyfile\n\nSCons_ tool to generate Doxyfile for Doxygen_. The generated Doxyfile may be\nfurther used by scons_doxygen_ tool.\n\n\nInstallation\n------------\n\nThere are few ways to install this tool for your project.\n\nFrom pypi_\n^^^^^^^^^^\n\nThis method may be preferable if you build your project under a virtualenv. To\nadd doxyfile tool from pypi_, type (within your wirtualenv):\n\n.. code-block:: shell\n\n pip install scons-tool-loader scons-tool-doxyfile\n\nor, if your project uses pipenv_:\n\n.. code-block:: shell\n\n pipenv install --dev scons-tool-loader scons-tool-doxyfile\n\nAlternatively, you may add this to your ``Pipfile``\n\n.. code-block::\n\n [dev-packages]\n scons-tool-loader = \"*\"\n scons-tool-doxyfile = \"*\"\n\n\nThe tool will be installed as a namespaced package ``sconstool.doxyfile``\nin project's virtual environment. You may further use scons-tool-loader_\nto load the tool.\n\nAs a git submodule\n^^^^^^^^^^^^^^^^^^\n\n#. Create new git repository:\n\n .. code-block:: shell\n\n mkdir /tmp/prj && cd /tmp/prj\n touch README.rst\n git init\n\n#. Add the `scons-tool-doxyfile`_ as a submodule:\n\n .. code-block:: shell\n\n git submodule add git://github.com/ptomulik/scons-tool-doxyfile.git site_scons/site_tools/doxyfile\n\n#. For python 2.x create ``__init__.py`` in ``site_tools`` directory:\n\n .. code-block:: shell\n\n touch site_scons/site_tools/__init__.py\n\n this will allow to directly import ``site_tools.doxyfile`` (this may be required by other tools).\n\nUsage example\n-------------\n\nGit-based projects\n^^^^^^^^^^^^^^^^^^\n\n#. Copy doxygen template to ``src/``, for example::\n\n mkdir src && cp site_scons/site_tools/doxyfile/Doxyfile.in src/\n\n#. Create some source files, for example ``src/test.hpp``:\n\n .. code-block:: cpp\n\n // src/test.hpp\n /**\n * @brief Test class\n */\n class TestClass { };\n\n#. Write ``SConstruct`` file:\n\n .. code-block:: python\n\n # SConstruct\n env = Environment(tools=['doxyfile', 'doxygen'])\n SConscript('src/SConscript', exports=['env'], variant_dir='build', duplicate=0)\n\n#. Write ``src/SConscript``:\n\n .. code-block:: python\n\n # src/SConscript\n Import(['env'])\n doxyfile = env.Doxyfile( INPUT = '.', RECURSIVE = True)\n env.Doxygen(doxyfile)\n\n#. Try it out::\n\n scons\n\n This shall create documentation under ``build`` directory.\n\n#. Check the generated documentation (it should contain docs for ``TestClass``\n under ``Classes`` tab)::\n\n firefox build/html/index.html\n\nDetails\n-------\n\nModule contents and description\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nThe **scons-tool-doxyfile** contains these crucial files:\n\n* ``__init__.py``, ``doxyoptions.py`` and ``about.py`` files,\n* ``Doxyfile.in`` template,\n* ``SConstruct`` script, and\n* this ``README.rst``\n\nThe tool provides a ``Doxyfile()`` builder which generates ``Doxyfile``\nconfiguration file from ``Doxyfile.in`` template. It accepts several *options*\nto customize the generated ``Doxyfile``. The options are passed as keyword\narguments to ``Doxyfile``:\n\n.. code-block:: python\n\n env.Doxyfile(INPUT='.', RECURSIVE=True, STRIP_FROM_INC_PATH='.', ...)\n\nSame template may be used to generate documentation for several sub-projects by\nusing different sets of options (and variant builds, if necessary).\nYou may also use your own template file, instead of default ``Doxyfile.in``\nshipped along with this tool.\n\nOption types\n^^^^^^^^^^^^\n\nThe options ``Doxyfile()`` builder accepts are categorized into several types:\n\n+---------------+--------------------------+----------------------------+----------------------------+\n| Type | Note | Example value in SConscript| Example output to Doxyfile |\n+===============+==========================+============================+============================+\n| *int* | integer | 3 | 3 |\n+---------------+--------------------------+----------------------------+----------------------------+\n| *str* | string | 'str1' or 'str 2' | str1 or \"str 2\" |\n+---------------+--------------------------+----------------------------+----------------------------+\n| *list* | list | ['a b', False, 3] | \"a b\" False 3 |\n+---------------+--------------------------+----------------------------+----------------------------+\n| *dict* | dictionary | {'a' : 'A', 'b' : 'B'} | a=A b=B |\n+---------------+--------------------------+----------------------------+----------------------------+\n| *bool* | boolean | True or False | YES or NO |\n+---------------+--------------------------+----------------------------+----------------------------+\n| *entry* | ref to file or directory | 'foo' | /tmp/prj/build/foo |\n+---------------+--------------------------+----------------------------+----------------------------+\n| *file* | ref to file | 'bar.txt' | /tmp/prj/build/bar.txt |\n+---------------+--------------------------+----------------------------+----------------------------+\n| *dir* | ref to directory | '.' | /tmp/prj/build |\n+---------------+--------------------------+----------------------------+----------------------------+\n| *srcentry* | ref to source file or dir| 'foo' | /tmp/prj/src/foo |\n+---------------+--------------------------+----------------------------+----------------------------+\n| *srcfile* | ref to source file | 'foo.txt' | /tmp/prj/src/foo.txt |\n+---------------+--------------------------+----------------------------+----------------------------+\n| *srcdir* | ref to source directory | '.' | /tmp/prj/src |\n+---------------+--------------------------+----------------------------+----------------------------+\n| *dualentry* | ref to entry + its source| 'foo' | | /tmp/prj/build/foo \\\\ |\n| | | | | /tmp/prj/src/foo |\n+---------------+--------------------------+----------------------------+----------------------------+\n| *dualfile* | ref to file + its source | 'foo.txt' | | /tmp/prj/build/foo.txt \\\\|\n| | | | | /tmp/prj/src/foo.txt |\n+---------------+--------------------------+----------------------------+----------------------------+\n| *dualdir* | ref to dir + its source | '.' | | /tmp/prj/build \\\\ |\n| | | | | /tmp/prj/src |\n+---------------+--------------------------+----------------------------+----------------------------+\n| *entries* | list of entries | ['foo', 'bar/gez'] | | /tmp/prj/build/foo \\\\ |\n| | | | | /tmp/prj/build/bar/geez |\n+---------------+--------------------------+----------------------------+----------------------------+\n| *files* | list of files | ['foo', 'bar.txt'] | | /tmp/prj/build/foo \\\\ |\n| | | | | /tmp/prj/build/bar.txt |\n+---------------+--------------------------+----------------------------+----------------------------+\n| *dirs* | list of directories | ['.', 'foo'] | | /tmp/prj/build \\\\ |\n| | | | | /tmp/prj/build/foo |\n+---------------+--------------------------+----------------------------+----------------------------+\n| *srcentries* | list of source entries | ['.', 'foo'] | | /tmp/prj/src \\\\ |\n| | | | | /tmp/prj/src/foo |\n+---------------+--------------------------+----------------------------+----------------------------+\n| *srcfiles* | list of source files | ['a.txt', 'b.txt'] | | /tmp/prj/src/a.txt \\\\ |\n| | | | | /tmp/prj/src/b.txt |\n+---------------+--------------------------+----------------------------+----------------------------+\n| *srcdirs* | list of source dirs | ['.', 'foo'] | | /tmp/prj/src \\\\ |\n| | | | | /tmp/prj/src/foo |\n+---------------+--------------------------+----------------------------+----------------------------+\n| *dualentries* | list of dual entries | ['.', 'foo'] | | /tmp/prj/build \\\\ |\n| | | | | /tmp/prj/src \\\\ |\n| | | | | /tmp/prj/build/foo \\\\ |\n| | | | | /tmp/prj/src/foo |\n+---------------+--------------------------+----------------------------+----------------------------+\n| *dualfiles* | list of dual files | ['a.txt', 'b.txt'] | | /tmp/prj/build/a.txt \\\\ |\n| | | | | /tmp/prj/src/a.txt \\\\ |\n| | | | | /tmp/prj/build/b.txt \\\\ |\n| | | | | /tmp/prj/src/b.txt |\n+---------------+--------------------------+----------------------------+----------------------------+\n| *dualdirs* | list of dual directories | ['.', 'foo'] | | /tmp/prj/build \\\\ |\n| | | | | /tmp/prj/src \\\\ |\n| | | | | /tmp/prj/build/foo \\\\ |\n| | | | | /tmp/prj/src/foo |\n+---------------+--------------------------+----------------------------+----------------------------+\n\nAn *entry* is a path to file or directory (undecided). For each value of type\n*entry*, *file* or *dir* a single path is outputted to Doxyfile. If\nrelative paths are provided by user, they are assumed to be relative to a\ndirectory containing the calling ``SConscript``. Note, that ``SCons`` will\nwrite absolute paths to Doxyfile, so you should consider using\n``STRIP_FROM_PATH``, ``STRIP_FROM_INC_PATH`` and similar options.\n\nIn variant builds, the *entry*, *file* and *directory*, if given as\nrelative paths, will point to a file or subdirectory of build dir.\n\nA *srcentry*, *srcfile*, or *srcdir* will generate a path pointing to a\nsource file or directory corresponding to given file. This, of course, becomes\nrelevant when variant builds are used.\n\nDual entry, file (or directory) results with a single path or two\npaths being emitted to Doxyfile. For variant builds, pair of paths is written\nto Doxyfile: the first one in build dir and the second pointing to a\ncorresponding source file or dir.\n\nThe values written to Doxyfile are automatically quoted if they contain\nwhite spaces. For example, the hash ``{'a' : 'be ce'}`` will result with\n``a=\"be ce\"``.\n\nValues being assigned to Doxyfile options are subject of simple validation.\n\nSupported options\n^^^^^^^^^^^^^^^^^\n\nThe supported options are summarized in the following table:\n\n======================== ========== =====================================\nOption Type Default\n======================== ========== =====================================\nABBREVIATE_BRIEF_ str\nALIASES_ str\nALLEXTERNALS_ bool NO\nALPHABETICAL_INDEX_ bool YES\nALWAYS_DETAILED_SEC_ bool NO\nAUTOLINK_SUPPORT_ bool YES\nBINARY_TOC_ bool NO\nBRIEF_MEMBER_DESC_ bool YES\nBUILTIN_STL_SUPPORT_ bool NO\nCALLER_GRAPH_ bool NO\nCALL_GRAPH_ bool NO\nCASE_SENSE_NAMES_ bool *OS specific*\nCHM_FILE_ srcfile\nCHM_INDEX_ENCODING_ str\nCITE_BIB_FILES_ files\nCLANG_ASSISTED_PARSING_ bool NO\nCLANG_OPTIONS_ str\nCLASS_DIAGRAMS_ bool YES\nCLASS_GRAPH_ bool YES\nCOLLABORATION_GRAPH_ bool YES\nCOLS_IN_ALPHA_INDEX_ str\nCOMPACT_LATEX_ bool NO\nCOMPACT_RTF_ bool NO\nCPP_CLI_SUPPORT_ bool NO\nCREATE_SUBDIRS_ bool NO\nDIRECTORY_GRAPH_ bool YES\nDISABLE_INDEX_ bool NO\nDISTRIBUTE_GROUP_DOC_ bool NO\nDOCBOOK_OUTPUT_ dir\nDOCSET_BUNDLE_ID_ str org.doxygen.Project\nDOCSET_FEEDNAME_ str \"Doxygen generated docs\"\nDOCSET_PUBLISHER_ID_ str org.doxygen.Publisher\nDOCSET_PUBLISHER_NAME_ str Publisher\nDOTFILE_DIRS_ srcdirs\nDOT_CLEANUP_ bool YES\nDOT_FONTNAME_ str Helvetica\nDOT_FONTPATH_ srcdir\nDOT_FONTSIZE_ int 10\nDOT_GRAPH_MAX_NODES_ int 50\nDOT_IMAGE_FORMAT_ str png\nDOT_MULTI_TARGETS_ bool NO\nDOT_NUM_THREADS_ int 0\nDOT_PATH_ str\nDOT_TRANSPARENT_ bool NO\nDOXYFILE_ENCODING_ str UTF-8\nECLIPSE_DOC_ID_ str org.doxygen.Project\nENABLED_SECTIONS_ str\nENABLE_PREPROCESSING_ bool YES\nENUM_VALUES_PER_LINE_ int 4\nEXAMPLE_PATH_ srcdirs\nEXAMPLE_PATTERNS_ str\nEXAMPLE_RECURSIVE_ bool NO\nEXCLUDE_ srcdirs\nEXCLUDE_PATTERNS_ str\nEXCLUDE_SYMBOLS_ str\nEXCLUDE_SYMLINKS_ bool NO\nEXPAND_AS_DEFINED_ list\nEXPAND_ONLY_PREDEF_ bool NO\nEXTENSION_MAPPING_ str\nEXTERNAL_GROUPS_ bool YES\nEXTERNAL_PAGES_ bool YES\nEXTERNAL_SEARCH_ bool NO\nEXTERNAL_SEARCH_ID_ str\nEXTRACT_ALL_ bool NO\nEXTRACT_ANON_NSPACES_ bool NO\nEXTRACT_LOCAL_CLASSES_ bool YES\nEXTRACT_LOCAL_METHODS_ bool NO\nEXTRACT_PACKAGE_ bool NO\nEXTRACT_PRIVATE_ bool NO\nEXTRACT_STATIC_ bool NO\nEXTRA_PACKAGES_ str\nEXTRA_SEARCH_MAPPINGS_ str\nEXT_LINKS_IN_WINDOW_ bool NO\nFILE_PATTERNS_ str\nFILE_VERSION_FILTER_ str\nFILTER_PATTERNS_ dict\nFILTER_SOURCE_FILES_ bool NO\nFILTER_SOURCE_PATTERNS_ dict\nFORCE_LOCAL_INCLUDES_ bool NO\nFORMULA_FONTSIZE_ int 10\nFORMULA_TRANSPARENT_ bool YES\nFULL_PATH_NAMES_ bool YES\nGENERATE_AUTOGEN_DEF_ bool NO\nGENERATE_BUGLIST_ bool YES\nGENERATE_CHI_ bool NO\nGENERATE_DEPRECATEDLIST_ bool YES\nGENERATE_DOCBOOK_ bool NO\nGENERATE_DOCSET_ bool NO\nGENERATE_ECLIPSEHELP_ bool NO\nGENERATE_HTML_ bool YES\nGENERATE_HTMLHELP_ bool NO\nGENERATE_LATEX_ bool YES\nGENERATE_LEGEND_ bool YES\nGENERATE_MAN_ bool NO\nGENERATE_PERLMOD_ bool NO\nGENERATE_QHP_ bool NO\nGENERATE_RTF_ bool NO\nGENERATE_TAGFILE_ file\nGENERATE_TESTLIST_ bool YES\nGENERATE_TODOLIST_ bool YES\nGENERATE_TREEVIEW_ bool NO\nGENERATE_XML_ bool NO\nGRAPHICAL_HIERARCHY_ bool YES\nGROUP_GRAPHS_ bool YES\nHAVE_DOT_ bool NO\nHHC_LOCATION_ str\nHIDE_FRIEND_COMPOUNDS_ bool NO\nHIDE_IN_BODY_DOCS_ bool NO\nHIDE_SCOPE_NAMES_ bool NO\nHIDE_UNDOC_CLASSES_ bool NO\nHIDE_UNDOC_MEMBERS_ bool NO\nHIDE_UNDOC_RELATIONS_ bool YES\nHTML_COLORSTYLE_GAMMA_ int 80\nHTML_COLORSTYLE_HUE_ int 220\nHTML_COLORSTYLE_SAT_ int 100\nHTML_DYNAMIC_SECTIONS_ bool NO\nHTML_EXTRA_FILES_ srcfiles\nHTML_EXTRA_STYLESHEET_ srcfile\nHTML_FILE_EXTENSION_ str .html\nHTML_FOOTER_ srcfile\nHTML_HEADER_ srcfile\nHTML_INDEX_NUM_ENTRIES_ int 100\nHTML_OUTPUT_ str html\nHTML_STYLESHEET_ srcfile\nHTML_TIMESTAMP_ bool YES\nIDL_PROPERTY_SUPPORT_ bool YES\nIGNORE_PREFIX_ str\nIMAGE_PATH_ srcdirs\nINCLUDED_BY_GRAPH_ bool YES\nINCLUDE_FILE_PATTERNS_ str\nINCLUDE_GRAPH_ bool YES\nINCLUDE_PATH_ srcdirs\nINHERIT_DOCS_ bool YES\nINLINE_GROUPED_CLASSES_ bool NO\nINLINE_INFO_ bool YES\nINLINE_INHERITED_MEMB_ bool NO\nINLINE_SIMPLE_STRUCTS_ bool NO\nINLINE_SOURCES_ bool NO\nINPUT_ srcentries\nINPUT_ENCODING_ str UTF-8\nINPUT_FILTER_ str\nINTERACTIVE_SVG_ bool NO\nINTERNAL_DOCS_ bool NO\nJAVADOC_AUTOBRIEF_ bool NO\nLATEX_BATCHMODE_ bool NO\nLATEX_BIB_STYLE_ str\nLATEX_CMD_NAME_ str latex\nLATEX_EXTRA_FILES_ srcfiles\nLATEX_FOOTER_ srcfile\nLATEX_HEADER_ srcfile\nLATEX_HIDE_INDICES_ bool NO\nLATEX_OUTPUT_ str latex\nLATEX_SOURCE_CODE_ bool NO\nLAYOUT_FILE_ srcfile\nLOOKUP_CACHE_SIZE_ int 0\nMACRO_EXPANSION_ bool NO\nMAKEINDEX_CMD_NAME_ str makeindex\nMAN_EXTENSION_ str .3\nMAN_LINKS_ bool NO\nMAN_OUTPUT_ str man\nMARKDOWN_SUPPORT_ bool YES\nMATHJAX_CODEFILE_ srcfile\nMATHJAX_EXTENSIONS_ str\nMATHJAX_FORMAT_ str HTML-CSS\nMATHJAX_RELPATH_ str http://cdn.mathjax.org/mathjax/latest\nMAX_DOT_GRAPH_DEPTH_ int 0\nMAX_INITIALIZER_LINES_ int 30\nMSCFILE_DIRS_ dirs\nMSCGEN_PATH_ str\nMULTILINE_CPP_IS_BRIEF_ bool NO\nOPTIMIZE_FOR_FORTRAN_ bool NO\nOPTIMIZE_OUTPUT_FOR_C_ bool NO\nOPTIMIZE_OUTPUT_JAVA_ bool NO\nOPTIMIZE_OUTPUT_VHDL_ bool NO\nOUTPUT_DIRECTORY_ dir\nOUTPUT_LANGUAGE_ str English\nPAPER_TYPE_ str a4\nPDF_HYPERLINKS_ bool YES\nPERLMOD_LATEX_ bool NO\nPERLMOD_MAKEVAR_PREFIX_ str\nPERLMOD_PRETTY_ bool YES\nPERL_PATH_ str /usr/bin/perl\nPREDEFINED_ list\nPROJECT_BRIEF_ str\nPROJECT_LOGO_ str\nPROJECT_NAME_ str \"My Project\"\nPROJECT_NUMBER_ str\nQCH_FILE_ str\nQHG_LOCATION_ str\nQHP_CUST_FILTER_ATTRS_ str\nQHP_CUST_FILTER_NAME_ str\nQHP_NAMESPACE_ str\nQHP_SECT_FILTER_ATTRS_ str\nQHP_VIRTUAL_FOLDER_ str doc\nQT_AUTOBRIEF_ bool NO\nQUIET_ bool NO\nRECURSIVE_ bool NO\nREFERENCED_BY_RELATION_ bool NO\nREFERENCES_LINK_SOURCE_ bool YES\nREFERENCES_RELATION_ bool NO\nREPEAT_BRIEF_ bool YES\nRTF_EXTENSIONS_FILE_ file\nRTF_HYPERLINKS_ bool NO\nRTF_OUTPUT_ str rtf\nRTF_STYLESHEET_FILE_ file\nSEARCHDATA_FILE_ str searchdata.xml\nSEARCHENGINE_ bool YES\nSEARCHENGINE_URL_ str\nSEARCH_INCLUDES_ bool YES\nSEPARATE_MEMBER_PAGES_ bool NO\nSERVER_BASED_SEARCH_ bool NO\nSHORT_NAMES_ bool NO\nSHOW_FILES_ bool YES\nSHOW_INCLUDE_FILES_ bool YES\nSHOW_NAMESPACES_ bool YES\nSHOW_USED_FILES_ bool YES\nSIP_SUPPORT_ bool NO\nSKIP_FUNCTION_MACROS_ bool YES\nSORT_BRIEF_DOCS_ bool NO\nSORT_BY_SCOPE_NAME_ bool NO\nSORT_GROUP_NAMES_ bool NO\nSORT_MEMBERS_CTORS_1ST_ bool NO\nSORT_MEMBER_DOCS_ bool YES\nSOURCE_BROWSER_ bool NO\nSOURCE_TOOLTIPS_ bool YES\nSTRICT_PROTO_MATCHING_ bool NO\nSTRIP_CODE_COMMENTS_ bool YES\nSTRIP_FROM_INC_PATH_ srcdirs\nSTRIP_FROM_PATH_ srcdirs\nSUBGROUPING_ bool YES\nTAB_SIZE_ int 4\nTAGFILES_ str\nTCL_SUBST_ str\nTEMPLATE_RELATIONS_ bool NO\nTOC_EXPAND_ bool NO\nTREEVIEW_WIDTH_ int 250\nTYPEDEF_HIDES_STRUCT_ bool NO\nUML_LIMIT_NUM_FIELDS_ int 10\nUML_LOOK_ bool NO\nUSE_HTAGS_ bool NO\nUSE_MATHJAX_ bool NO\nUSE_MDFILE_AS_MAINPAGE_ srcfile\nUSE_PDFLATEX_ bool YES\nVERBATIM_HEADERS_ bool YES\nWARNINGS_ bool YES\nWARN_FORMAT_ str \"$file:$line: $text\"\nWARN_IF_DOC_ERROR_ bool YES\nWARN_IF_UNDOCUMENTED_ bool YES\nWARN_LOGFILE_ file\nWARN_NO_PARAMDOC_ bool NO\nXML_DTD_ str\nXML_OUTPUT_ str xml\nXML_PROGRAMLISTING_ bool YES\nXML_SCHEMA_ str\n======================== ========== =====================================\n\n.. _ABBREVIATE_BRIEF: http://doxygen.org/manual/config.html#cfg_abbreviate_brief\n.. _ALIASES: http://doxygen.org/manual/config.html#cfg_aliases\n.. _ALLEXTERNALS: http://doxygen.org/manual/config.html#cfg_allexternals\n.. _ALPHABETICAL_INDEX: http://doxygen.org/manual/config.html#cfg_alphabetical_index\n.. _ALWAYS_DETAILED_SEC: http://doxygen.org/manual/config.html#cfg_always_detailed_sec\n.. _AUTOLINK_SUPPORT: http://doxygen.org/manual/config.html#cfg_autolink_support\n.. _BINARY_TOC: http://doxygen.org/manual/config.html#cfg_binary_toc\n.. _BRIEF_MEMBER_DESC: http://doxygen.org/manual/config.html#cfg_brief_member_desc\n.. _BUILTIN_STL_SUPPORT: http://doxygen.org/manual/config.html#cfg_builtin_stl_support\n.. _CALLER_GRAPH: http://doxygen.org/manual/config.html#cfg_caller_graph\n.. _CALL_GRAPH: http://doxygen.org/manual/config.html#cfg_call_graph\n.. _CASE_SENSE_NAMES: http://doxygen.org/manual/config.html#cfg_case_sense_names\n.. _CHM_FILE: http://doxygen.org/manual/config.html#cfg_chm_file\n.. _CHM_INDEX_ENCODING: http://doxygen.org/manual/config.html#cfg_chm_index_encoding\n.. _CITE_BIB_FILES: http://doxygen.org/manual/config.html#cfg_cite_bib_files\n.. _CLANG_ASSISTED_PARSING: http://doxygen.org/manual/config.html#cfg_clang_assisted_parsing\n.. _CLANG_OPTIONS: http://doxygen.org/manual/config.html#cfg_clang_options\n.. _CLASS_DIAGRAMS: http://doxygen.org/manual/config.html#cfg_class_diagrams\n.. _CLASS_GRAPH: http://doxygen.org/manual/config.html#cfg_class_graph\n.. _COLLABORATION_GRAPH: http://doxygen.org/manual/config.html#cfg_collaboration_graph\n.. _COLS_IN_ALPHA_INDEX: http://doxygen.org/manual/config.html#cfg_cols_in_alpha_index\n.. _COMPACT_LATEX: http://doxygen.org/manual/config.html#cfg_compact_latex\n.. _COMPACT_RTF: http://doxygen.org/manual/config.html#cfg_compact_rtf\n.. _CPP_CLI_SUPPORT: http://doxygen.org/manual/config.html#cfg_cpp_cli_support\n.. _CREATE_SUBDIRS: http://doxygen.org/manual/config.html#cfg_create_subdirs\n.. _DIRECTORY_GRAPH: http://doxygen.org/manual/config.html#cfg_directory_graph\n.. _DISABLE_INDEX: http://doxygen.org/manual/config.html#cfg_disable_index\n.. _DISTRIBUTE_GROUP_DOC: http://doxygen.org/manual/config.html#cfg_distribute_group_doc\n.. _DOCBOOK_OUTPUT: http://doxygen.org/manual/config.html#cfg_docbook_output\n.. _DOCSET_BUNDLE_ID: http://doxygen.org/manual/config.html#cfg_docset_bundle_id\n.. _DOCSET_FEEDNAME: http://doxygen.org/manual/config.html#cfg_docset_feedname\n.. _DOCSET_PUBLISHER_ID: http://doxygen.org/manual/config.html#cfg_docset_publisher_id\n.. _DOCSET_PUBLISHER_NAME: http://doxygen.org/manual/config.html#cfg_docset_publisher_name\n.. _DOTFILE_DIRS: http://doxygen.org/manual/config.html#cfg_dotfile_dirs\n.. _DOT_CLEANUP: http://doxygen.org/manual/config.html#cfg_dot_cleanup\n.. _DOT_FONTNAME: http://doxygen.org/manual/config.html#cfg_dot_fontname\n.. _DOT_FONTPATH: http://doxygen.org/manual/config.html#cfg_dot_fontpath\n.. _DOT_FONTSIZE: http://doxygen.org/manual/config.html#cfg_dot_fontsize\n.. _DOT_GRAPH_MAX_NODES: http://doxygen.org/manual/config.html#cfg_dot_graph_max_nodes\n.. _DOT_IMAGE_FORMAT: http://doxygen.org/manual/config.html#cfg_dot_image_format\n.. _DOT_MULTI_TARGETS: http://doxygen.org/manual/config.html#cfg_dot_multi_targets\n.. _DOT_NUM_THREADS: http://doxygen.org/manual/config.html#cfg_dot_num_threads\n.. _DOT_PATH: http://doxygen.org/manual/config.html#cfg_dot_path\n.. _DOT_TRANSPARENT: http://doxygen.org/manual/config.html#cfg_dot_transparent\n.. _DOXYFILE_ENCODING: http://doxygen.org/manual/config.html#cfg_doxyfile_encoding\n.. _ECLIPSE_DOC_ID: http://doxygen.org/manual/config.html#cfg_eclipse_doc_id\n.. _ENABLED_SECTIONS: http://doxygen.org/manual/config.html#cfg_enabled_sections\n.. _ENABLE_PREPROCESSING: http://doxygen.org/manual/config.html#cfg_enable_preprocessing\n.. _ENUM_VALUES_PER_LINE: http://doxygen.org/manual/config.html#cfg_enum_values_per_line\n.. _EXAMPLE_PATH: http://doxygen.org/manual/config.html#cfg_example_path\n.. _EXAMPLE_PATTERNS: http://doxygen.org/manual/config.html#cfg_example_patterns\n.. _EXAMPLE_RECURSIVE: http://doxygen.org/manual/config.html#cfg_example_recursive\n.. _EXCLUDE: http://doxygen.org/manual/config.html#cfg_exclude\n.. _EXCLUDE_PATTERNS: http://doxygen.org/manual/config.html#cfg_exclude_patterns\n.. _EXCLUDE_SYMBOLS: http://doxygen.org/manual/config.html#cfg_exclude_symbols\n.. _EXCLUDE_SYMLINKS: http://doxygen.org/manual/config.html#cfg_exclude_symlinks\n.. _EXPAND_AS_DEFINED: http://doxygen.org/manual/config.html#cfg_expand_as_defined\n.. _EXPAND_ONLY_PREDEF: http://doxygen.org/manual/config.html#cfg_expand_only_predef\n.. _EXTENSION_MAPPING: http://doxygen.org/manual/config.html#cfg_extension_mapping\n.. _EXTERNAL_GROUPS: http://doxygen.org/manual/config.html#cfg_external_groups\n.. _EXTERNAL_PAGES: http://doxygen.org/manual/config.html#cfg_external_pages\n.. _EXTERNAL_SEARCH: http://doxygen.org/manual/config.html#cfg_external_search\n.. _EXTERNAL_SEARCH_ID: http://doxygen.org/manual/config.html#cfg_external_search_id\n.. _EXTRACT_ALL: http://doxygen.org/manual/config.html#cfg_extract_all\n.. _EXTRACT_ANON_NSPACES: http://doxygen.org/manual/config.html#cfg_extract_anon_nspaces\n.. _EXTRACT_LOCAL_CLASSES: http://doxygen.org/manual/config.html#cfg_extract_local_classes\n.. _EXTRACT_LOCAL_METHODS: http://doxygen.org/manual/config.html#cfg_extract_local_methods\n.. _EXTRACT_PACKAGE: http://doxygen.org/manual/config.html#cfg_extract_package\n.. _EXTRACT_PRIVATE: http://doxygen.org/manual/config.html#cfg_extract_private\n.. _EXTRACT_STATIC: http://doxygen.org/manual/config.html#cfg_extract_static\n.. _EXTRA_PACKAGES: http://doxygen.org/manual/config.html#cfg_extra_packages\n.. _EXTRA_SEARCH_MAPPINGS: http://doxygen.org/manual/config.html#cfg_extra_search_mappings\n.. _EXT_LINKS_IN_WINDOW: http://doxygen.org/manual/config.html#cfg_ext_links_in_window\n.. _FILE_PATTERNS: http://doxygen.org/manual/config.html#cfg_file_patterns\n.. _FILE_VERSION_FILTER: http://doxygen.org/manual/config.html#cfg_file_version_filter\n.. _FILTER_PATTERNS: http://doxygen.org/manual/config.html#cfg_filter_patterns\n.. _FILTER_SOURCE_FILES: http://doxygen.org/manual/config.html#cfg_filter_source_files\n.. _FILTER_SOURCE_PATTERNS: http://doxygen.org/manual/config.html#cfg_filter_source_patterns\n.. _FORCE_LOCAL_INCLUDES: http://doxygen.org/manual/config.html#cfg_force_local_includes\n.. _FORMULA_FONTSIZE: http://doxygen.org/manual/config.html#cfg_formula_fontsize\n.. _FORMULA_TRANSPARENT: http://doxygen.org/manual/config.html#cfg_formula_transparent\n.. _FULL_PATH_NAMES: http://doxygen.org/manual/config.html#cfg_full_path_names\n.. _GENERATE_AUTOGEN_DEF: http://doxygen.org/manual/config.html#cfg_generate_autogen_def\n.. _GENERATE_BUGLIST: http://doxygen.org/manual/config.html#cfg_generate_buglist\n.. _GENERATE_CHI: http://doxygen.org/manual/config.html#cfg_generate_chi\n.. _GENERATE_DEPRECATEDLIST: http://doxygen.org/manual/config.html#cfg_generate_deprecatedlist\n.. _GENERATE_DOCBOOK: http://doxygen.org/manual/config.html#cfg_generate_docbook\n.. _GENERATE_DOCSET: http://doxygen.org/manual/config.html#cfg_generate_docset\n.. _GENERATE_ECLIPSEHELP: http://doxygen.org/manual/config.html#cfg_generate_eclipsehelp\n.. _GENERATE_HTML: http://doxygen.org/manual/config.html#cfg_generate_html\n.. _GENERATE_HTMLHELP: http://doxygen.org/manual/config.html#cfg_generate_htmlhelp\n.. _GENERATE_LATEX: http://doxygen.org/manual/config.html#cfg_generate_latex\n.. _GENERATE_LEGEND: http://doxygen.org/manual/config.html#cfg_generate_legend\n.. _GENERATE_MAN: http://doxygen.org/manual/config.html#cfg_generate_man\n.. _GENERATE_PERLMOD: http://doxygen.org/manual/config.html#cfg_generate_perlmod\n.. _GENERATE_QHP: http://doxygen.org/manual/config.html#cfg_generate_qhp\n.. _GENERATE_RTF: http://doxygen.org/manual/config.html#cfg_generate_rtf\n.. _GENERATE_TAGFILE: http://doxygen.org/manual/config.html#cfg_generate_tagfile\n.. _GENERATE_TESTLIST: http://doxygen.org/manual/config.html#cfg_generate_testlist\n.. _GENERATE_TODOLIST: http://doxygen.org/manual/config.html#cfg_generate_todolist\n.. _GENERATE_TREEVIEW: http://doxygen.org/manual/config.html#cfg_generate_treeview\n.. _GENERATE_XML: http://doxygen.org/manual/config.html#cfg_generate_xml\n.. _GRAPHICAL_HIERARCHY: http://doxygen.org/manual/config.html#cfg_graphical_hierarchy\n.. _GROUP_GRAPHS: http://doxygen.org/manual/config.html#cfg_group_graphs\n.. _HAVE_DOT: http://doxygen.org/manual/config.html#cfg_have_dot\n.. _HHC_LOCATION: http://doxygen.org/manual/config.html#cfg_hhc_location\n.. _HIDE_FRIEND_COMPOUNDS: http://doxygen.org/manual/config.html#cfg_hide_friend_compounds\n.. _HIDE_IN_BODY_DOCS: http://doxygen.org/manual/config.html#cfg_hide_in_body_docs\n.. _HIDE_SCOPE_NAMES: http://doxygen.org/manual/config.html#cfg_hide_scope_names\n.. _HIDE_UNDOC_CLASSES: http://doxygen.org/manual/config.html#cfg_hide_undoc_classes\n.. _HIDE_UNDOC_MEMBERS: http://doxygen.org/manual/config.html#cfg_hide_undoc_members\n.. _HIDE_UNDOC_RELATIONS: http://doxygen.org/manual/config.html#cfg_hide_undoc_relations\n.. _HTML_COLORSTYLE_GAMMA: http://doxygen.org/manual/config.html#cfg_html_colorstyle_gamma\n.. _HTML_COLORSTYLE_HUE: http://doxygen.org/manual/config.html#cfg_html_colorstyle_hue\n.. _HTML_COLORSTYLE_SAT: http://doxygen.org/manual/config.html#cfg_html_colorstyle_sat\n.. _HTML_DYNAMIC_SECTIONS: http://doxygen.org/manual/config.html#cfg_html_dynamic_sections\n.. _HTML_EXTRA_FILES: http://doxygen.org/manual/config.html#cfg_html_extra_files\n.. _HTML_EXTRA_STYLESHEET: http://doxygen.org/manual/config.html#cfg_html_extra_stylesheet\n.. _HTML_FILE_EXTENSION: http://doxygen.org/manual/config.html#cfg_html_file_extension\n.. _HTML_FOOTER: http://doxygen.org/manual/config.html#cfg_html_footer\n.. _HTML_HEADER: http://doxygen.org/manual/config.html#cfg_html_header\n.. _HTML_INDEX_NUM_ENTRIES: http://doxygen.org/manual/config.html#cfg_html_index_num_entries\n.. _HTML_OUTPUT: http://doxygen.org/manual/config.html#cfg_html_output\n.. _HTML_STYLESHEET: http://doxygen.org/manual/config.html#cfg_html_stylesheet\n.. _HTML_TIMESTAMP: http://doxygen.org/manual/config.html#cfg_html_timestamp\n.. _IDL_PROPERTY_SUPPORT: http://doxygen.org/manual/config.html#cfg_idl_property_support\n.. _IGNORE_PREFIX: http://doxygen.org/manual/config.html#cfg_ignore_prefix\n.. _IMAGE_PATH: http://doxygen.org/manual/config.html#cfg_image_path\n.. _INCLUDED_BY_GRAPH: http://doxygen.org/manual/config.html#cfg_included_by_graph\n.. _INCLUDE_FILE_PATTERNS: http://doxygen.org/manual/config.html#cfg_include_file_patterns\n.. _INCLUDE_GRAPH: http://doxygen.org/manual/config.html#cfg_include_graph\n.. _INCLUDE_PATH: http://doxygen.org/manual/config.html#cfg_include_path\n.. _INHERIT_DOCS: http://doxygen.org/manual/config.html#cfg_inherit_docs\n.. _INLINE_GROUPED_CLASSES: http://doxygen.org/manual/config.html#cfg_inline_grouped_classes\n.. _INLINE_INFO: http://doxygen.org/manual/config.html#cfg_inline_info\n.. _INLINE_INHERITED_MEMB: http://doxygen.org/manual/config.html#cfg_inline_inherited_memb\n.. _INLINE_SIMPLE_STRUCTS: http://doxygen.org/manual/config.html#cfg_inline_simple_structs\n.. _INLINE_SOURCES: http://doxygen.org/manual/config.html#cfg_inline_sources\n.. _INPUT: http://doxygen.org/manual/config.html#cfg_input\n.. _INPUT_ENCODING: http://doxygen.org/manual/config.html#cfg_input_encoding\n.. _INPUT_FILTER: http://doxygen.org/manual/config.html#cfg_input_filter\n.. _INTERACTIVE_SVG: http://doxygen.org/manual/config.html#cfg_interactive_svg\n.. _INTERNAL_DOCS: http://doxygen.org/manual/config.html#cfg_internal_docs\n.. _JAVADOC_AUTOBRIEF: http://doxygen.org/manual/config.html#cfg_javadoc_autobrief\n.. _LATEX_BATCHMODE: http://doxygen.org/manual/config.html#cfg_latex_batchmode\n.. _LATEX_BIB_STYLE: http://doxygen.org/manual/config.html#cfg_latex_bib_style\n.. _LATEX_CMD_NAME: http://doxygen.org/manual/config.html#cfg_latex_cmd_name\n.. _LATEX_EXTRA_FILES: http://doxygen.org/manual/config.html#cfg_latex_extra_files\n.. _LATEX_FOOTER: http://doxygen.org/manual/config.html#cfg_latex_footer\n.. _LATEX_HEADER: http://doxygen.org/manual/config.html#cfg_latex_header\n.. _LATEX_HIDE_INDICES: http://doxygen.org/manual/config.html#cfg_latex_hide_indices\n.. _LATEX_OUTPUT: http://doxygen.org/manual/config.html#cfg_latex_output\n.. _LATEX_SOURCE_CODE: http://doxygen.org/manual/config.html#cfg_latex_source_code\n.. _LAYOUT_FILE: http://doxygen.org/manual/config.html#cfg_layout_file\n.. _LOOKUP_CACHE_SIZE: http://doxygen.org/manual/config.html#cfg_lookup_cache_size\n.. _MACRO_EXPANSION: http://doxygen.org/manual/config.html#cfg_macro_expansion\n.. _MAKEINDEX_CMD_NAME: http://doxygen.org/manual/config.html#cfg_makeindex_cmd_name\n.. _MAN_EXTENSION: http://doxygen.org/manual/config.html#cfg_man_extension\n.. _MAN_LINKS: http://doxygen.org/manual/config.html#cfg_man_links\n.. _MAN_OUTPUT: http://doxygen.org/manual/config.html#cfg_man_output\n.. _MARKDOWN_SUPPORT: http://doxygen.org/manual/config.html#cfg_markdown_support\n.. _MATHJAX_CODEFILE: http://doxygen.org/manual/config.html#cfg_mathjax_codefile\n.. _MATHJAX_EXTENSIONS: http://doxygen.org/manual/config.html#cfg_mathjax_extensions\n.. _MATHJAX_FORMAT: http://doxygen.org/manual/config.html#cfg_mathjax_format\n.. _MATHJAX_RELPATH: http://doxygen.org/manual/config.html#cfg_mathjax_relpath\n.. _MAX_DOT_GRAPH_DEPTH: http://doxygen.org/manual/config.html#cfg_max_dot_graph_depth\n.. _MAX_INITIALIZER_LINES: http://doxygen.org/manual/config.html#cfg_max_initializer_lines\n.. _MSCFILE_DIRS: http://doxygen.org/manual/config.html#cfg_mscfile_dirs\n.. _MSCGEN_PATH: http://doxygen.org/manual/config.html#cfg_mscgen_path\n.. _MULTILINE_CPP_IS_BRIEF: http://doxygen.org/manual/config.html#cfg_multiline_cpp_is_brief\n.. _OPTIMIZE_FOR_FORTRAN: http://doxygen.org/manual/config.html#cfg_optimize_for_fortran\n.. _OPTIMIZE_OUTPUT_FOR_C: http://doxygen.org/manual/config.html#cfg_optimize_output_for_c\n.. _OPTIMIZE_OUTPUT_JAVA: http://doxygen.org/manual/config.html#cfg_optimize_output_java\n.. _OPTIMIZE_OUTPUT_VHDL: http://doxygen.org/manual/config.html#cfg_optimize_output_vhdl\n.. _OUTPUT_DIRECTORY: http://doxygen.org/manual/config.html#cfg_output_directory\n.. _OUTPUT_LANGUAGE: http://doxygen.org/manual/config.html#cfg_output_language\n.. _PAPER_TYPE: http://doxygen.org/manual/config.html#cfg_paper_type\n.. _PDF_HYPERLINKS: http://doxygen.org/manual/config.html#cfg_pdf_hyperlinks\n.. _PERLMOD_LATEX: http://doxygen.org/manual/config.html#cfg_perlmod_latex\n.. _PERLMOD_MAKEVAR_PREFIX: http://doxygen.org/manual/config.html#cfg_perlmod_makevar_prefix\n.. _PERLMOD_PRETTY: http://doxygen.org/manual/config.html#cfg_perlmod_pretty\n.. _PERL_PATH: http://doxygen.org/manual/config.html#cfg_perl_path\n.. _PREDEFINED: http://doxygen.org/manual/config.html#cfg_predefined\n.. _PROJECT_BRIEF: http://doxygen.org/manual/config.html#cfg_project_brief\n.. _PROJECT_LOGO: http://doxygen.org/manual/config.html#cfg_project_logo\n.. _PROJECT_NAME: http://doxygen.org/manual/config.html#cfg_project_name\n.. _PROJECT_NUMBER: http://doxygen.org/manual/config.html#cfg_project_number\n.. _QCH_FILE: http://doxygen.org/manual/config.html#cfg_qch_file\n.. _QHG_LOCATION: http://doxygen.org/manual/config.html#cfg_qhg_location\n.. _QHP_CUST_FILTER_ATTRS: http://doxygen.org/manual/config.html#cfg_qhp_cust_filter_attrs\n.. _QHP_CUST_FILTER_NAME: http://doxygen.org/manual/config.html#cfg_qhp_cust_filter_name\n.. _QHP_NAMESPACE: http://doxygen.org/manual/config.html#cfg_qhp_namespace\n.. _QHP_SECT_FILTER_ATTRS: http://doxygen.org/manual/config.html#cfg_qhp_sect_filter_attrs\n.. _QHP_VIRTUAL_FOLDER: http://doxygen.org/manual/config.html#cfg_qhp_virtual_folder\n.. _QT_AUTOBRIEF: http://doxygen.org/manual/config.html#cfg_qt_autobrief\n.. _QUIET: http://doxygen.org/manual/config.html#cfg_quiet\n.. _RECURSIVE: http://doxygen.org/manual/config.html#cfg_recursive\n.. _REFERENCED_BY_RELATION: http://doxygen.org/manual/config.html#cfg_referenced_by_relation\n.. _REFERENCES_LINK_SOURCE: http://doxygen.org/manual/config.html#cfg_references_link_source\n.. _REFERENCES_RELATION: http://doxygen.org/manual/config.html#cfg_references_relation\n.. _REPEAT_BRIEF: http://doxygen.org/manual/config.html#cfg_repeat_brief\n.. _RTF_EXTENSIONS_FILE: http://doxygen.org/manual/config.html#cfg_rtf_extensions_file\n.. _RTF_HYPERLINKS: http://doxygen.org/manual/config.html#cfg_rtf_hyperlinks\n.. _RTF_OUTPUT: http://doxygen.org/manual/config.html#cfg_rtf_output\n.. _RTF_STYLESHEET_FILE: http://doxygen.org/manual/config.html#cfg_rtf_stylesheet_file\n.. _SEARCHDATA_FILE: http://doxygen.org/manual/config.html#cfg_searchdata_file\n.. _SEARCHENGINE: http://doxygen.org/manual/config.html#cfg_searchengine\n.. _SEARCHENGINE_URL: http://doxygen.org/manual/config.html#cfg_searchengine_url\n.. _SEARCH_INCLUDES: http://doxygen.org/manual/config.html#cfg_search_includes\n.. _SEPARATE_MEMBER_PAGES: http://doxygen.org/manual/config.html#cfg_separate_member_pages\n.. _SERVER_BASED_SEARCH: http://doxygen.org/manual/config.html#cfg_server_based_search\n.. _SHORT_NAMES: http://doxygen.org/manual/config.html#cfg_short_names\n.. _SHOW_FILES: http://doxygen.org/manual/config.html#cfg_show_files\n.. _SHOW_INCLUDE_FILES: http://doxygen.org/manual/config.html#cfg_show_include_files\n.. _SHOW_NAMESPACES: http://doxygen.org/manual/config.html#cfg_show_namespaces\n.. _SHOW_USED_FILES: http://doxygen.org/manual/config.html#cfg_show_used_files\n.. _SIP_SUPPORT: http://doxygen.org/manual/config.html#cfg_sip_support\n.. _SKIP_FUNCTION_MACROS: http://doxygen.org/manual/config.html#cfg_skip_function_macros\n.. _SORT_BRIEF_DOCS: http://doxygen.org/manual/config.html#cfg_sort_brief_docs\n.. _SORT_BY_SCOPE_NAME: http://doxygen.org/manual/config.html#cfg_sort_by_scope_name\n.. _SORT_GROUP_NAMES: http://doxygen.org/manual/config.html#cfg_sort_group_names\n.. _SORT_MEMBERS_CTORS_1ST: http://doxygen.org/manual/config.html#cfg_sort_members_ctors_1st\n.. _SORT_MEMBER_DOCS: http://doxygen.org/manual/config.html#cfg_sort_member_docs\n.. _SOURCE_BROWSER: http://doxygen.org/manual/config.html#cfg_source_browser\n.. _SOURCE_TOOLTIPS: http://doxygen.org/manual/config.html#cfg_source_tooltips\n.. _STRICT_PROTO_MATCHING: http://doxygen.org/manual/config.html#cfg_strict_proto_matching\n.. _STRIP_CODE_COMMENTS: http://doxygen.org/manual/config.html#cfg_strip_code_comments\n.. _STRIP_FROM_INC_PATH: http://doxygen.org/manual/config.html#cfg_strip_from_inc_path\n.. _STRIP_FROM_PATH: http://doxygen.org/manual/config.html#cfg_strip_from_path\n.. _SUBGROUPING: http://doxygen.org/manual/config.html#cfg_subgrouping\n.. _TAB_SIZE: http://doxygen.org/manual/config.html#cfg_tab_size\n.. _TAGFILES: http://doxygen.org/manual/config.html#cfg_tagfiles\n.. _TCL_SUBST: http://doxygen.org/manual/config.html#cfg_tcl_subst\n.. _TEMPLATE_RELATIONS: http://doxygen.org/manual/config.html#cfg_template_relations\n.. _TOC_EXPAND: http://doxygen.org/manual/config.html#cfg_toc_expand\n.. _TREEVIEW_WIDTH: http://doxygen.org/manual/config.html#cfg_treeview_width\n.. _TYPEDEF_HIDES_STRUCT: http://doxygen.org/manual/config.html#cfg_typedef_hides_struct\n.. _UML_LIMIT_NUM_FIELDS: http://doxygen.org/manual/config.html#cfg_uml_limit_num_fields\n.. _UML_LOOK: http://doxygen.org/manual/config.html#cfg_uml_look\n.. _USE_HTAGS: http://doxygen.org/manual/config.html#cfg_use_htags\n.. _USE_MATHJAX: http://doxygen.org/manual/config.html#cfg_use_mathjax\n.. _USE_MDFILE_AS_MAINPAGE: http://doxygen.org/manual/config.html#cfg_use_mdfile_as_mainpage\n.. _USE_PDFLATEX: http://doxygen.org/manual/config.html#cfg_use_pdflatex\n.. _VERBATIM_HEADERS: http://doxygen.org/manual/config.html#cfg_verbatim_headers\n.. _WARNINGS: http://doxygen.org/manual/config.html#cfg_warnings\n.. _WARN_FORMAT: http://doxygen.org/manual/config.html#cfg_warn_format\n.. _WARN_IF_DOC_ERROR: http://doxygen.org/manual/config.html#cfg_warn_if_doc_error\n.. _WARN_IF_UNDOCUMENTED: http://doxygen.org/manual/config.html#cfg_warn_if_undocumented\n.. _WARN_LOGFILE: http://doxygen.org/manual/config.html#cfg_warn_logfile\n.. _WARN_NO_PARAMDOC: http://doxygen.org/manual/config.html#cfg_warn_no_paramdoc\n.. _XML_DTD: http://doxygen.org/manual/config.html#cfg_xml_dtd\n.. _XML_OUTPUT: http://doxygen.org/manual/config.html#cfg_xml_output\n.. _XML_PROGRAMLISTING: http://doxygen.org/manual/config.html#cfg_xml_programlisting\n.. _XML_SCHEMA: http://doxygen.org/manual/config.html#cfg_xml_schema\n\n.. \n.. _SCons: http://scons.org\n.. _Doxygen: http://doxygen.org\n.. _scons_doxygen: https://bitbucket.org/russel/scons_doxygen\n.. _scons-doxygen-template: https://github.com/ptomulik/scons-doxygen-template\n.. _scons-tool-loader: https://github.com/ptomulik/scons-tool-loader\n.. _pipenv: https://pipenv.readthedocs.io/\n.. _pypi: https://pypi.org/\n\nNotes to developers\n-------------------\n\nRegenerating documentation for options\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nIf you change some options in ``doxyoptions.py``, then you should regenerate\noption's documentation in ``README.rst``. New documentation may be generated by\nrunning::\n\n scons -Q doc-options\n\nAfter that, copy-paste the output of the above command to an appropriate place\nin this ``README.rst`` (note, just skip scons messages).\n\nLICENSE\n-------\n\nCopyright (c) 2013-2018 by Pawel Tomulik \n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE\n\n.. \n\n\n", "description_content_type": "text/x-rst", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/ptomulik/scons-tool-doxyfile", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "scons-tool-doxyfile", "package_url": "https://pypi.org/project/scons-tool-doxyfile/", "platform": "", "project_url": "https://pypi.org/project/scons-tool-doxyfile/", "project_urls": { "Homepage": "https://github.com/ptomulik/scons-tool-doxyfile" }, "release_url": "https://pypi.org/project/scons-tool-doxyfile/0.1.1/", "requires_dist": null, "requires_python": ">=2.7", "summary": "SCons tool to generate Doxyfile for Doxygen", "version": "0.1.1" }, "last_serial": 5176577, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "1e155b20e3f245b927502b438a433e0b", "sha256": "145c087435c8448e61c8022f9efabc1626ce43c5c5e531880a98f486d1149a59" }, "downloads": -1, "filename": "scons_tool_doxyfile-0.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "1e155b20e3f245b927502b438a433e0b", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=2.7", "size": 18901, "upload_time": "2018-11-05T13:47:40", "url": "https://files.pythonhosted.org/packages/95/6f/e27d9a6953c42b0303bbd104e58abda4de972c19bffc031e13b470878839/scons_tool_doxyfile-0.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "54646d3d769a6d54f6d1bf56375fa825", "sha256": "f1042bc637e271f23187e79abf8df399fda66d35f1c7947200725bca46cd8003" }, "downloads": -1, "filename": "scons-tool-doxyfile-0.1.0.tar.gz", "has_sig": false, "md5_digest": "54646d3d769a6d54f6d1bf56375fa825", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7", "size": 33708, "upload_time": "2018-11-05T13:47:42", "url": "https://files.pythonhosted.org/packages/57/32/28501054dcbf1e88ddccdcdafe78d596e0b7b4edcfd0c33597912992a80a/scons-tool-doxyfile-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "365075a33c346055fdb0cfb434372b93", "sha256": "f1059a8677917dcf39be6df7d5a939fce28c3ed993245f7f8408ea192c053be3" }, "downloads": -1, "filename": "scons_tool_doxyfile-0.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "365075a33c346055fdb0cfb434372b93", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=2.7", "size": 19256, "upload_time": "2019-04-23T10:40:25", "url": "https://files.pythonhosted.org/packages/f2/a4/5247576c8e8d952774503decbda196b92700faab0f617cdd11d4e0332f27/scons_tool_doxyfile-0.1.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "d80ed4e53dc98b2cf063bf4d98a29046", "sha256": "c7f2068f7c5503c5ba8c3ee7e7542f646ba9eafb89a703965be035017cd76169" }, "downloads": -1, "filename": "scons-tool-doxyfile-0.1.1.tar.gz", "has_sig": false, "md5_digest": "d80ed4e53dc98b2cf063bf4d98a29046", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7", "size": 34522, "upload_time": "2019-04-23T10:40:26", "url": "https://files.pythonhosted.org/packages/83/3b/58c476abc794ffa8455e8d56eb300a2104443d648d330660533df315cd22/scons-tool-doxyfile-0.1.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "365075a33c346055fdb0cfb434372b93", "sha256": "f1059a8677917dcf39be6df7d5a939fce28c3ed993245f7f8408ea192c053be3" }, "downloads": -1, "filename": "scons_tool_doxyfile-0.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "365075a33c346055fdb0cfb434372b93", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=2.7", "size": 19256, "upload_time": "2019-04-23T10:40:25", "url": "https://files.pythonhosted.org/packages/f2/a4/5247576c8e8d952774503decbda196b92700faab0f617cdd11d4e0332f27/scons_tool_doxyfile-0.1.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "d80ed4e53dc98b2cf063bf4d98a29046", "sha256": "c7f2068f7c5503c5ba8c3ee7e7542f646ba9eafb89a703965be035017cd76169" }, "downloads": -1, "filename": "scons-tool-doxyfile-0.1.1.tar.gz", "has_sig": false, "md5_digest": "d80ed4e53dc98b2cf063bf4d98a29046", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7", "size": 34522, "upload_time": "2019-04-23T10:40:26", "url": "https://files.pythonhosted.org/packages/83/3b/58c476abc794ffa8455e8d56eb300a2104443d648d330660533df315cd22/scons-tool-doxyfile-0.1.1.tar.gz" } ] }