var NAVTREE =
[
[ "Doxygen", "index.html", [
[ "Installation", "install.html", [
[ "Compiling from source on UNIX", "install.html#install_src_unix", null ],
[ "Installing the binaries on UNIX", "install.html#install_bin_unix", null ],
[ "Compiling from source on Windows", "install.html#install_src_windows", null ],
[ "Installing the binaries on Windows", "install.html#install_bin_windows", null ]
] ],
[ "Getting started", "starting.html", [
[ "Step 0: Check if doxygen supports your programming language", "starting.html#step0", null ],
[ "Step 1: Creating a configuration file", "starting.html#step1", null ],
[ "Step 2: Running doxygen", "starting.html#step2", [
[ "HTML output", "starting.html#html_out", null ],
[ "LaTeX output", "starting.html#latex_out", null ],
[ "RTF output", "starting.html#rtf_out", null ],
[ "XML output", "starting.html#xml_out", null ],
[ "Man page output", "starting.html#man_out", null ],
[ "DocBook output", "starting.html#docbook_out", null ]
] ],
[ "Step 3: Documenting the sources", "starting.html#step3", null ]
] ],
[ "Documenting the code", "docblocks.html", [
[ "Special comment blocks", "docblocks.html#specialblock", [
[ "Comment blocks for C-like languages (C/C++/C#/Objective-C/PHP/Java)", "docblocks.html#cppblock", [
[ "Putting documentation after members", "docblocks.html#memberdoc", null ],
[ "Examples", "docblocks.html#docexamples", null ],
[ "Documentation at other places", "docblocks.html#structuralcommands", null ]
] ],
[ "Comment blocks in Python", "docblocks.html#pythonblocks", null ],
[ "Comment blocks in VHDL", "docblocks.html#vhdlblocks", null ],
[ "Comment blocks in Fortran", "docblocks.html#fortranblocks", null ],
[ "Comment blocks in Tcl", "docblocks.html#tclblocks", null ]
] ],
[ "Anatomy of a comment block", "docblocks.html#docstructure", null ]
] ],
[ "Markdown support", "markdown.html", [
[ "Standard Markdown", "markdown.html#markdown_std", [
[ "Paragraphs", "markdown.html#md_para", null ],
[ "Headers", "markdown.html#md_headers", null ],
[ "Block quotes", "markdown.html#md_blockquotes", null ],
[ "Lists", "markdown.html#md_lists", null ],
[ "Code Blocks", "markdown.html#md_codeblock", null ],
[ "Horizontal Rulers", "markdown.html#md_rulers", null ],
[ "Emphasis", "markdown.html#md_emphasis", null ],
[ "code spans", "markdown.html#md_codespan", null ],
[ "Links", "markdown.html#md_links", [
[ "Inline Links", "markdown.html#md_inlinelinks", null ],
[ "Reference Links", "markdown.html#md_reflinks", null ]
] ],
[ "Images", "markdown.html#md_images", null ],
[ "Automatic Linking", "markdown.html#md_autolink", null ]
] ],
[ "Markdown Extensions", "markdown.html#markdown_extra", [
[ "Table of Contents", "markdown.html#md_toc", null ],
[ "Tables", "markdown.html#md_tables", null ],
[ "Fenced Code Blocks", "markdown.html#md_fenced", null ],
[ "Header Id Attributes", "markdown.html#md_header_id", null ]
] ],
[ "Doxygen specifics", "markdown.html#markdown_dox", [
[ "Including Markdown files as pages", "markdown.html#md_page_header", null ],
[ "Treatment of HTML blocks", "markdown.html#md_html_blocks", null ],
[ "Code Block Indentation", "markdown.html#mddox_code_blocks", null ],
[ "Emphasis limits", "markdown.html#mddox_emph_spans", null ],
[ "Code Spans Limits", "markdown.html#mddox_code_spans", null ],
[ "Lists Extensions", "markdown.html#mddox_lists", null ],
[ "Use of asterisks", "markdown.html#mddox_stars", null ],
[ "Limits on markup scope", "markdown.html#mddox_limits", null ]
] ],
[ "Debugging of problems", "markdown.html#markdown_debug", null ]
] ],
[ "Lists", "lists.html", null ],
[ "Grouping", "grouping.html", [
[ "Modules", "grouping.html#modules", null ],
[ "Member Groups", "grouping.html#memgroup", null ],
[ "Subpaging", "grouping.html#subpaging", null ]
] ],
[ "Including formulas", "formulas.html", null ],
[ "Including tables", "tables.html", null ],
[ "Graphs and diagrams", "diagrams.html", null ],
[ "Preprocessing", "preprocessing.html", null ],
[ "Automatic link generation", "autolink.html", [
[ "Links to web pages and mail addresses", "autolink.html#linkurl", null ],
[ "Links to classes", "autolink.html#linkclass", null ],
[ "Links to files", "autolink.html#linkfile", null ],
[ "Links to functions", "autolink.html#linkfunc", null ],
[ "Links to other members", "autolink.html#linkother", null ],
[ "typedefs", "autolink.html#resolving", null ]
] ],
[ "Output Formats", "output.html", null ],
[ "Searching", "searching.html", "searching" ],
[ "Customizing the output", "customize.html", [
[ "Minor Tweaks", "customize.html#minor_tweaks", [
[ "Overall Color", "customize.html#minor_tweaks_colors", null ],
[ "Navigation", "customize.html#minor_tweaks_treeview", null ],
[ "Dynamic Content", "customize.html#minor_tweaks_dynsection", null ],
[ "Header, Footer, and Stylesheet changes", "customize.html#minor_tweaks_header_css", null ]
] ],
[ "Changing the layout of pages", "customize.html#layout", null ],
[ "Using the XML output", "customize.html#xmlgenerator", null ]
] ],
[ "Custom Commands", "custcmd.html", [
[ "Simple aliases", "custcmd.html#custcmd_simple", null ],
[ "Aliases with arguments", "custcmd.html#custcmd_complex", null ],
[ "Nesting custom command", "custcmd.html#custcmd_nesting", null ]
] ],
[ "Linking to external documentation", "external.html", null ],
[ "Frequently Asked Questions", "faq.html", [
[ "How to get information on the index page in HTML?", "faq.html#faq_index", null ],
[ "Help, some/all of the members of my class / file / namespace are not documented?", "faq.html#fac_al", null ],
[ "When I set EXTRACT_ALL to NO none of my functions are shown in the documentation.", "faq.html#faq_extract_all", null ],
[ "My file with a custom extension is not parsed (properly) (anymore).", "faq.html#faq_ext_mapping", null ],
[ "How can I make doxygen ignore some code fragment?", "faq.html#faq_code", null ],
[ "How can I change what is after the #include
in the class documentation?", "faq.html#faq_code_inc", null ],
[ "How can I use tag files in combination with compressed HTML?", "faq.html#faq_chm", null ],
[ "I don't like the quick index that is put above each HTML page, what do I do?", "faq.html#faq_html", null ],
[ "The overall HTML output looks different, while I only wanted to use my own html header file", "faq.html#faq_html_header", null ],
[ "Why does doxygen use Qt?", "faq.html#faq_use_qt", null ],
[ "How can I exclude all test directories from my directory tree?", "faq.html#faq_excl_dir", null ],
[ "Doxygen automatically generates a link to the class MyClass somewhere in the running text. How do I prevent that at a certain place?", "faq.html#faq_class", null ],
[ "My favorite programming language is X. Can I still use doxygen?", "faq.html#faq_pgm_X", null ],
[ "Help! I get the cryptic message \"input buffer overflow, can't enlarge buffer because scanner uses REJECT\"", "faq.html#faq_lex", null ],
[ "When running make in the latex dir I get \"TeX capacity exceeded\". Now what?", "faq.html#faq_latex", null ],
[ "Why are dependencies via STL classes not shown in the dot graphs?", "faq.html#faq_stl", null ],
[ "I have problems getting the search engine to work with PHP5 and/or windows", "faq.html#faq_search", null ],
[ "Can I configure doxygen from the command line?", "faq.html#faq_cmdline", null ],
[ "How did doxygen get its name?", "faq.html#faq_name", null ],
[ "What was the reason to develop doxygen?", "faq.html#faq_why", null ]
] ],
[ "Troubleshooting", "trouble.html", [
[ "Known Problems", "trouble.html#knowproblems", null ],
[ "How to Help", "trouble.html#howtohelp", null ],
[ "How to report a bug", "trouble.html#bug_reports", null ]
] ],
[ "Features", "features.html", null ],
[ "Doxygen usage", "doxygen_usage.html", [
[ "Fine-tuning the output", "doxygen_usage.html#doxygen_finetune", null ]
] ],
[ "Doxywizard usage", "doxywizard_usage.html", null ],
[ "Configuration", "config.html", [
[ "Format", "config.html#config_format", null ],
[ "Project related configuration options", "config.html#config_project", null ],
[ "Build related configuration options", "config.html#config_build", null ],
[ "Configuration options related to warning and progress messages", "config.html#config_messages", null ],
[ "Configuration options related to the input files", "config.html#config_input", null ],
[ "Configuration options related to source browsing", "config.html#config_source_browser", null ],
[ "Configuration options related to the alphabetical class index", "config.html#config_index", null ],
[ "Configuration options related to the HTML output", "config.html#config_html", null ],
[ "Configuration options related to the LaTeX output", "config.html#config_latex", null ],
[ "Configuration options related to the RTF output", "config.html#config_rtf", null ],
[ "Configuration options related to the man page output", "config.html#config_man", null ],
[ "Configuration options related to the XML output", "config.html#config_xml", null ],
[ "Configuration options related to the DOCBOOK output", "config.html#config_docbook", null ],
[ "Configuration options for the AutoGen Definitions output", "config.html#config_autogen", null ],
[ "Configuration options related to the Perl module output", "config.html#config_perlmod", null ],
[ "Configuration options related to the preprocessor", "config.html#config_preprocessor", null ],
[ "Configuration options related to external references", "config.html#config_external", null ],
[ "Configuration options related to the dot tool", "config.html#config_dot", null ],
[ "Examples", "config.html#config_examples", null ]
] ],
[ "Special Commands", "commands.html", [
[ "Introduction", "commands.html#cmd_intro", null ],
[ "\\addtogroup [(title)]", "commands.html#cmdaddtogroup", null ],
[ "\\callgraph", "commands.html#cmdcallgraph", null ],
[ "\\hidecallgraph", "commands.html#cmdhidecallgraph", null ],
[ "\\callergraph", "commands.html#cmdcallergraph", null ],
[ "\\hidecallergraph", "commands.html#cmdhidecallergraph", null ],
[ "\\category [] []", "commands.html#cmdcategory", null ],
[ "\\class [] []", "commands.html#cmdclass", null ],
[ "\\def ", "commands.html#cmddef", null ],
[ "\\defgroup (group title)", "commands.html#cmddefgroup", null ],
[ "\\dir []", "commands.html#cmddir", null ],
[ "\\enum ", "commands.html#cmdenum", null ],
[ "\\example ", "commands.html#cmdexample", null ],
[ "\\endinternal", "commands.html#cmdendinternal", null ],
[ "\\extends ", "commands.html#cmdextends", null ],
[ "\\file []", "commands.html#cmdfile", null ],
[ "\\fn (function declaration)", "commands.html#cmdfn", null ],
[ "\\headerfile []", "commands.html#cmdheaderfile", null ],
[ "\\hideinitializer", "commands.html#cmdhideinitializer", null ],
[ "\\idlexcept ", "commands.html#cmdidlexcept", null ],
[ "\\implements ", "commands.html#cmdimplements", null ],
[ "\\ingroup ( [ ])", "commands.html#cmdingroup", null ],
[ "\\interface [] []", "commands.html#cmdinterface", null ],
[ "\\internal", "commands.html#cmdinternal", null ],
[ "\\mainpage [(title)]", "commands.html#cmdmainpage", null ],
[ "\\memberof ", "commands.html#cmdmemberof", null ],
[ "\\name [(header)]", "commands.html#cmdname", null ],
[ "\\namespace ", "commands.html#cmdnamespace", null ],
[ "\\nosubgrouping", "commands.html#cmdnosubgrouping", null ],
[ "\\overload [(function declaration)]", "commands.html#cmdoverload", null ],
[ "\\package ", "commands.html#cmdpackage", null ],
[ "\\page (title)", "commands.html#cmdpage", null ],
[ "\\private", "commands.html#cmdprivate", null ],
[ "\\privatesection", "commands.html#cmdprivatesection", null ],
[ "\\property (qualified property name)", "commands.html#cmdproperty", null ],
[ "\\protected", "commands.html#cmdprotected", null ],
[ "\\protectedsection", "commands.html#cmdprotectedsection", null ],
[ "\\protocol [] []", "commands.html#cmdprotocol", null ],
[ "\\public", "commands.html#cmdpublic", null ],
[ "\\publicsection", "commands.html#cmdpublicsection", null ],
[ "\\pure", "commands.html#cmdpure", null ],
[ "\\relates ", "commands.html#cmdrelates", null ],
[ "\\related ", "commands.html#cmdrelated", null ],
[ "\\relatesalso ", "commands.html#cmdrelatesalso", null ],
[ "\\relatedalso ", "commands.html#cmdrelatedalso", null ],
[ "\\showinitializer", "commands.html#cmdshowinitializer", null ],
[ "\\static", "commands.html#cmdstatic", null ],
[ "\\struct [] []", "commands.html#cmdstruct", null ],
[ "\\typedef (typedef declaration)", "commands.html#cmdtypedef", null ],
[ "\\union [] []", "commands.html#cmdunion", null ],
[ "\\var (variable declaration)", "commands.html#cmdvar", null ],
[ "\\vhdlflow [(title for the flow chart)]", "commands.html#cmdvhdlflow", null ],
[ "\\weakgroup [(title)]", "commands.html#cmdweakgroup", null ],
[ "\\attention { attention text }", "commands.html#cmdattention", null ],
[ "\\author { list of authors }", "commands.html#cmdauthor", null ],
[ "\\authors { list of authors }", "commands.html#cmdauthors", null ],
[ "\\brief { brief description }", "commands.html#cmdbrief", null ],
[ "\\bug { bug description }", "commands.html#cmdbug", null ],
[ "\\cond [(section-label)]", "commands.html#cmdcond", null ],
[ "\\copyright { copyright description }", "commands.html#cmdcopyright", null ],
[ "\\date { date description }", "commands.html#cmddate", null ],
[ "\\deprecated { description }", "commands.html#cmddeprecated", null ],
[ "\\details { detailed description }", "commands.html#cmddetails", null ],
[ "\\else", "commands.html#cmdelse", null ],
[ "\\elseif (section-label)", "commands.html#cmdelseif", null ],
[ "\\endcond", "commands.html#cmdendcond", null ],
[ "\\endif", "commands.html#cmdendif", null ],
[ "\\exception { exception description }", "commands.html#cmdexception", null ],
[ "\\if (section-label)", "commands.html#cmdif", null ],
[ "\\ifnot (section-label)", "commands.html#cmdifnot", null ],
[ "\\invariant { description of invariant }", "commands.html#cmdinvariant", null ],
[ "\\note { text }", "commands.html#cmdnote", null ],
[ "\\par [(paragraph title)] { paragraph }", "commands.html#cmdpar", null ],
[ "\\param [(dir)] { parameter description }", "commands.html#cmdparam", null ],
[ "\\parblock", "commands.html#cmdparblock", null ],
[ "\\endparblock", "commands.html#cmdendparblock", null ],
[ "\\tparam { description }", "commands.html#cmdtparam", null ],
[ "\\post { description of the postcondition }", "commands.html#cmdpost", null ],
[ "\\pre { description of the precondition }", "commands.html#cmdpre", null ],
[ "\\remark { remark text }", "commands.html#cmdremark", null ],
[ "\\remarks { remark text }", "commands.html#cmdremarks", null ],
[ "\\result { description of the result value }", "commands.html#cmdresult", null ],
[ "\\return { description of the return value }", "commands.html#cmdreturn", null ],
[ "\\returns { description of the return value }", "commands.html#cmdreturns", null ],
[ "\\retval { description }", "commands.html#cmdretval", null ],
[ "\\sa { references }", "commands.html#cmdsa", null ],
[ "\\see { references }", "commands.html#cmdsee", null ],
[ "\\short { short description }", "commands.html#cmdshort", null ],
[ "\\since { text }", "commands.html#cmdsince", null ],
[ "\\test { paragraph describing a test case }", "commands.html#cmdtest", null ],
[ "\\throw { exception description }", "commands.html#cmdthrow", null ],
[ "\\throws { exception description }", "commands.html#cmdthrows", null ],
[ "\\todo { paragraph describing what is to be done }", "commands.html#cmdtodo", null ],
[ "\\version { version number }", "commands.html#cmdversion", null ],
[ "\\warning { warning message }", "commands.html#cmdwarning", null ],
[ "\\xrefitem \"(heading)\" \"(list title)\" { text }", "commands.html#cmdxrefitem", null ],
[ "\\addindex (text)", "commands.html#cmdaddindex", null ],
[ "\\anchor ", "commands.html#cmdanchor", null ],
[ "\\cite