/usr/share/doc/doxygen-1.8.5/html/

File Upload :
llllll

Current File: //usr/share/doc/doxygen-1.8.5/html/navtree.js
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 ], [ "Known compilation problems for UNIX", "install.html#unix_problems", null ], [ "Compiling from source on Windows", "install.html#install_src_windows", null ], [ "Installing the binaries on Windows", "install.html#install_bin_windows", null ], [ "Tools used to develop doxygen", "install.html#build_tools", 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 ], [ "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", 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 <name> [(title)]", "commands.html#cmdaddtogroup", null ], [ "\\callgraph", "commands.html#cmdcallgraph", null ], [ "\\callergraph", "commands.html#cmdcallergraph", null ], [ "\\category <name> [<header-file>] [<header-name>]", "commands.html#cmdcategory", null ], [ "\\class <name> [<header-file>] [<header-name>]", "commands.html#cmdclass", null ], [ "\\def <name>", "commands.html#cmddef", null ], [ "\\defgroup <name> (group title)", "commands.html#cmddefgroup", null ], [ "\\dir [<path fragment>]", "commands.html#cmddir", null ], [ "\\enum <name>", "commands.html#cmdenum", null ], [ "\\example <file-name>", "commands.html#cmdexample", null ], [ "\\endinternal", "commands.html#cmdendinternal", null ], [ "\\extends <name>", "commands.html#cmdextends", null ], [ "\\file [<name>]", "commands.html#cmdfile", null ], [ "\\fn (function declaration)", "commands.html#cmdfn", null ], [ "\\headerfile <header-file> [<header-name>]", "commands.html#cmdheaderfile", null ], [ "\\hideinitializer", "commands.html#cmdhideinitializer", null ], [ "\\idlexcept <name>", "commands.html#cmdidlexcept", null ], [ "\\implements <name>", "commands.html#cmdimplements", null ], [ "\\ingroup (<groupname> [<groupname> <groupname>])", "commands.html#cmdingroup", null ], [ "\\interface <name> [<header-file>] [<header-name>]", "commands.html#cmdinterface", null ], [ "\\internal", "commands.html#cmdinternal", null ], [ "\\mainpage [(title)]", "commands.html#cmdmainpage", null ], [ "\\memberof <name>", "commands.html#cmdmemberof", null ], [ "\\name [(header)]", "commands.html#cmdname", null ], [ "\\namespace <name>", "commands.html#cmdnamespace", null ], [ "\\nosubgrouping", "commands.html#cmdnosubgrouping", null ], [ "\\overload [(function declaration)]", "commands.html#cmdoverload", null ], [ "\\package <name>", "commands.html#cmdpackage", null ], [ "\\page <name> (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 <name> [<header-file>] [<header-name>]", "commands.html#cmdprotocol", null ], [ "\\public", "commands.html#cmdpublic", null ], [ "\\publicsection", "commands.html#cmdpublicsection", null ], [ "\\pure", "commands.html#cmdpure", null ], [ "\\relates <name>", "commands.html#cmdrelates", null ], [ "\\related <name>", "commands.html#cmdrelated", null ], [ "\\relatesalso <name>", "commands.html#cmdrelatesalso", null ], [ "\\relatedalso <name>", "commands.html#cmdrelatedalso", null ], [ "\\showinitializer", "commands.html#cmdshowinitializer", null ], [ "\\static", "commands.html#cmdstatic", null ], [ "\\struct <name> [<header-file>] [<header-name>]", "commands.html#cmdstruct", null ], [ "\\typedef (typedef declaration)", "commands.html#cmdtypedef", null ], [ "\\union <name> [<header-file>] [<header-name>]", "commands.html#cmdunion", null ], [ "\\var (variable declaration)", "commands.html#cmdvar", null ], [ "\\vhdlflow [(title for the flow chart)]", "commands.html#cmdvhdlflow", null ], [ "\\weakgroup <name> [(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-object> { 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-name> { parameter description }", "commands.html#cmdparam", null ], [ "\\tparam <template-parameter-name> { 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 <return value> { 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-object> { exception description }", "commands.html#cmdthrow", null ], [ "\\throws <exception-object> { 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 <key> \"(heading)\" \"(list title)\" { text }", "commands.html#cmdxrefitem", null ], [ "\\addindex (text)", "commands.html#cmdaddindex", null ], [ "\\anchor <word>", "commands.html#cmdanchor", null ], [ "\\cite <label>", "commands.html#cmdcite", null ], [ "\\endlink", "commands.html#cmdendlink", null ], [ "\\link <link-object>", "commands.html#cmdlink", null ], [ "\\ref <name> [\"(text)\"]", "commands.html#cmdref", null ], [ "\\refitem <name>", "commands.html#cmdrefitem", null ], [ "\\secreflist", "commands.html#cmdsecreflist", null ], [ "\\endsecreflist", "commands.html#cmdendsecreflist", null ], [ "\\subpage <name> [\"(text)\"]", "commands.html#cmdsubpage", null ], [ "\\tableofcontents", "commands.html#cmdtableofcontents", null ], [ "\\section <section-name> (section title)", "commands.html#cmdsection", null ], [ "\\subsection <subsection-name> (subsection title)", "commands.html#cmdsubsection", null ], [ "\\subsubsection <subsubsection-name> (subsubsection title)", "commands.html#cmdsubsubsection", null ], [ "\\paragraph <paragraph-name> (paragraph title)", "commands.html#cmdparagraph", null ], [ "\\dontinclude <file-name>", "commands.html#cmddontinclude", null ], [ "\\include <file-name>", "commands.html#cmdinclude", null ], [ "\\includelineno <file-name>", "commands.html#cmdincludelineno", null ], [ "\\line ( pattern )", "commands.html#cmdline", null ], [ "\\skip ( pattern )", "commands.html#cmdskip", null ], [ "\\skipline ( pattern )", "commands.html#cmdskipline", null ], [ "\\snippet <file-name> ( block_id )", "commands.html#cmdsnippet", null ], [ "\\until ( pattern )", "commands.html#cmduntil", null ], [ "\\verbinclude <file-name>", "commands.html#cmdverbinclude", null ], [ "\\htmlinclude <file-name>", "commands.html#cmdhtmlinclude", null ], [ "\\a <word>", "commands.html#cmda", null ], [ "\\arg { item-description }", "commands.html#cmdarg", null ], [ "\\b <word>", "commands.html#cmdb", null ], [ "\\c <word>", "commands.html#cmdc", null ], [ "\\code [ '{'<word>'}']", "commands.html#cmdcode", null ], [ "\\copydoc <link-object>", "commands.html#cmdcopydoc", null ], [ "\\copybrief <link-object>", "commands.html#cmdcopybrief", null ], [ "\\copydetails <link-object>", "commands.html#cmdcopydetails", null ], [ "\\docbookonly", "commands.html#cmddocbookonly", null ], [ "\\dot", "commands.html#cmddot", null ], [ "\\msc", "commands.html#cmdmsc", null ], [ "\\dotfile <file> [\"caption\"]", "commands.html#cmddotfile", null ], [ "\\mscfile <file> [\"caption\"]", "commands.html#cmdmscfile", null ], [ "\\e <word>", "commands.html#cmde", null ], [ "\\em <word>", "commands.html#cmdem", null ], [ "\\endcode", "commands.html#cmdendcode", null ], [ "\\enddocbookonly", "commands.html#cmdenddocbookonly", null ], [ "\\enddot", "commands.html#cmdenddot", null ], [ "\\endmsc", "commands.html#cmdendmsc", null ], [ "\\endhtmlonly", "commands.html#cmdendhtmlonly", null ], [ "\\endlatexonly", "commands.html#cmdendlatexonly", null ], [ "\\endmanonly", "commands.html#cmdendmanonly", null ], [ "\\endrtfonly", "commands.html#cmdendrtfonly", null ], [ "\\endverbatim", "commands.html#cmdendverbatim", null ], [ "\\endxmlonly", "commands.html#cmdendxmlonly", null ], [ "\\f$", "commands.html#cmdfdollar", null ], [ "\\f[", "commands.html#cmdfbropen", null ], [ "\\f]", "commands.html#cmdfbrclose", null ], [ "\\f{environment}{", "commands.html#cmdfcurlyopen", null ], [ "\\f}", "commands.html#cmdfcurlyclose", null ], [ "\\htmlonly", "commands.html#cmdhtmlonly", null ], [ "\\image <format> <file> [\"caption\"] [<sizeindication>=<size>]", "commands.html#cmdimage", null ], [ "\\latexonly", "commands.html#cmdlatexonly", null ], [ "\\manonly", "commands.html#cmdmanonly", null ], [ "\\li { item-description }", "commands.html#cmdli", null ], [ "\\n", "commands.html#cmdn", null ], [ "\\p <word>", "commands.html#cmdp", null ], [ "\\rtfonly", "commands.html#cmdrtfonly", null ], [ "\\verbatim", "commands.html#cmdverbatim", null ], [ "\\xmlonly", "commands.html#cmdxmlonly", null ], [ "\\\\", "commands.html#cmdbackslash", null ], [ "\\@", "commands.html#cmdat", null ], [ "\\~[LanguageId]", "commands.html#cmdtilde", null ], [ "\\&", "commands.html#cmdamp", null ], [ "\\$", "commands.html#cmddollar", null ], [ "\\#", "commands.html#cmdhash", null ], [ "\\<", "commands.html#cmdlt", null ], [ "\\>", "commands.html#cmdgt", null ], [ "\\%", "commands.html#cmdperc", null ], [ "\\\"", "commands.html#cmdquot", null ], [ "\\.", "commands.html#cmdchardot", null ], [ "\\::", "commands.html#cmddcolon", null ], [ "\\|", "commands.html#cmdpipe", null ] ] ], [ "HTML Commands", "htmlcmds.html", null ], [ "XML Commands", "xmlcmds.html", null ], [ "Internationalization", "langhowto.html", null ], [ "Perl Module Output", "perlmod.html", [ [ "Usage", "perlmod.html#using_perlmod_fmt", null ], [ "Using the LaTeX generator.", "perlmod.html#perlmod_latex", [ [ "Creation of PDF and DVI output", "perlmod.html#pm_pdf_gen", null ] ] ], [ "Documentation format.", "perlmod.html#doxydocs_format", null ], [ "Data structure", "perlmod.html#doxymodel_format", null ] ] ], [ "Perl Module Tree Nodes", "perlmod_tree.html", null ], [ "Doxygen's Internals", "arch.html", null ], [ "Changelog", "changelog.html", [ [ "1.8 Series", "changelog.html#log_1_8", [ [ "Release 1.8.5", "changelog.html#log_1_8_5", null ], [ "Release 1.8.4", "changelog.html#log_1_8_4", null ], [ "Release 1.8.3.1", "changelog.html#log_1_8_3_1", null ], [ "Release 1.8.3", "changelog.html#log_1_8_3", null ], [ "Release 1.8.2", "changelog.html#log_1_8_2", null ], [ "Release 1.8.1.2", "changelog.html#log_1_8_1_2", null ], [ "Release 1.8.1.1", "changelog.html#log_1_8_1_1", null ], [ "Release 1.8.1", "changelog.html#log_1_8_1", null ], [ "Release 1.8.0", "changelog.html#log_1_8_0", null ] ] ], [ "1.7 Series", "changelog.html#log_1_7", null ], [ "1.6 Series", "changelog.html#log_1_6", null ] ] ] ] ] ]; var NAVTREEINDEX = [ "arch.html", "faq.html" ]; var SYNCONMSG = 'click to disable panel synchronisation'; var SYNCOFFMSG = 'click to enable panel synchronisation'; var SYNCONMSG = 'click to disable panel synchronisation'; var SYNCOFFMSG = 'click to enable panel synchronisation'; var navTreeSubIndices = new Array(); function getData(varName) { var i = varName.lastIndexOf('/'); var n = i>=0 ? varName.substring(i+1) : varName; return eval(n.replace(/\-/g,'_')); } function stripPath(uri) { return uri.substring(uri.lastIndexOf('/')+1); } function stripPath2(uri) { var i = uri.lastIndexOf('/'); var s = uri.substring(i+1); var m = uri.substring(0,i+1).match(/\/d\w\/d\w\w\/$/); return m ? uri.substring(i-6) : s; } function localStorageSupported() { try { return 'localStorage' in window && window['localStorage'] !== null && window.localStorage.getItem; } catch(e) { return false; } } function storeLink(link) { if (!$("#nav-sync").hasClass('sync') && localStorageSupported()) { window.localStorage.setItem('navpath',link); } } function deleteLink() { if (localStorageSupported()) { window.localStorage.setItem('navpath',''); } } function cachedLink() { if (localStorageSupported()) { return window.localStorage.getItem('navpath'); } else { return ''; } } function getScript(scriptName,func,show) { var head = document.getElementsByTagName("head")[0]; var script = document.createElement('script'); script.id = scriptName; script.type = 'text/javascript'; script.onload = func; script.src = scriptName+'.js'; if ($.browser.msie && $.browser.version<=8) { // script.onload does not work with older versions of IE script.onreadystatechange = function() { if (script.readyState=='complete' || script.readyState=='loaded') { func(); if (show) showRoot(); } } } head.appendChild(script); } function createIndent(o,domNode,node,level) { var level=-1; var n = node; while (n.parentNode) { level++; n=n.parentNode; } if (node.childrenData) { var imgNode = document.createElement("img"); imgNode.style.paddingLeft=(16*level).toString()+'px'; imgNode.width = 16; imgNode.height = 22; imgNode.border = 0; node.plus_img = imgNode; node.expandToggle = document.createElement("a"); node.expandToggle.href = "javascript:void(0)"; node.expandToggle.onclick = function() { if (node.expanded) { $(node.getChildrenUL()).slideUp("fast"); node.plus_img.src = node.relpath+"ftv2pnode.png"; node.expanded = false; } else { expandNode(o, node, false, false); } } node.expandToggle.appendChild(imgNode); domNode.appendChild(node.expandToggle); imgNode.src = node.relpath+"ftv2pnode.png"; } else { var span = document.createElement("span"); span.style.display = 'inline-block'; span.style.width = 16*(level+1)+'px'; span.style.height = '22px'; span.innerHTML = '&nbsp;'; domNode.appendChild(span); } } var animationInProgress = false; function gotoAnchor(anchor,aname,updateLocation) { var pos, docContent = $('#doc-content'); if (anchor.parent().attr('class')=='memItemLeft' || anchor.parent().attr('class')=='fieldtype' || anchor.parent().is(':header')) { pos = anchor.parent().position().top; } else if (anchor.position()) { pos = anchor.position().top; } if (pos) { var dist = Math.abs(Math.min( pos-docContent.offset().top, docContent[0].scrollHeight- docContent.height()-docContent.scrollTop())); animationInProgress=true; docContent.animate({ scrollTop: pos + docContent.scrollTop() - docContent.offset().top },Math.max(50,Math.min(500,dist)),function(){ if (updateLocation) window.location.href=aname; animationInProgress=false; }); } } function newNode(o, po, text, link, childrenData, lastNode) { var node = new Object(); node.children = Array(); node.childrenData = childrenData; node.depth = po.depth + 1; node.relpath = po.relpath; node.isLast = lastNode; node.li = document.createElement("li"); po.getChildrenUL().appendChild(node.li); node.parentNode = po; node.itemDiv = document.createElement("div"); node.itemDiv.className = "item"; node.labelSpan = document.createElement("span"); node.labelSpan.className = "label"; createIndent(o,node.itemDiv,node,0); node.itemDiv.appendChild(node.labelSpan); node.li.appendChild(node.itemDiv); var a = document.createElement("a"); node.labelSpan.appendChild(a); node.label = document.createTextNode(text); node.expanded = false; a.appendChild(node.label); if (link) { var url; if (link.substring(0,1)=='^') { url = link.substring(1); link = url; } else { url = node.relpath+link; } a.className = stripPath(link.replace('#',':')); if (link.indexOf('#')!=-1) { var aname = '#'+link.split('#')[1]; var srcPage = stripPath($(location).attr('pathname')); var targetPage = stripPath(link.split('#')[0]); a.href = srcPage!=targetPage ? url : "javascript:void(0)"; a.onclick = function(){ storeLink(link); if (!$(a).parent().parent().hasClass('selected')) { $('.item').removeClass('selected'); $('.item').removeAttr('id'); $(a).parent().parent().addClass('selected'); $(a).parent().parent().attr('id','selected'); } var anchor = $(aname); gotoAnchor(anchor,aname,true); }; } else { a.href = url; a.onclick = function() { storeLink(link); } } } else { if (childrenData != null) { a.className = "nolink"; a.href = "javascript:void(0)"; a.onclick = node.expandToggle.onclick; } } node.childrenUL = null; node.getChildrenUL = function() { if (!node.childrenUL) { node.childrenUL = document.createElement("ul"); node.childrenUL.className = "children_ul"; node.childrenUL.style.display = "none"; node.li.appendChild(node.childrenUL); } return node.childrenUL; }; return node; } function showRoot() { var headerHeight = $("#top").height(); var footerHeight = $("#nav-path").height(); var windowHeight = $(window).height() - headerHeight - footerHeight; (function (){ // retry until we can scroll to the selected item try { var navtree=$('#nav-tree'); navtree.scrollTo('#selected',0,{offset:-windowHeight/2}); } catch (err) { setTimeout(arguments.callee, 0); } })(); } function expandNode(o, node, imm, showRoot) { if (node.childrenData && !node.expanded) { if (typeof(node.childrenData)==='string') { var varName = node.childrenData; getScript(node.relpath+varName,function(){ node.childrenData = getData(varName); expandNode(o, node, imm, showRoot); }, showRoot); } else { if (!node.childrenVisited) { getNode(o, node); } if (imm || ($.browser.msie && $.browser.version>8)) { // somehow slideDown jumps to the start of tree for IE9 :-( $(node.getChildrenUL()).show(); } else { $(node.getChildrenUL()).slideDown("fast"); } if (node.isLast) { node.plus_img.src = node.relpath+"ftv2mlastnode.png"; } else { node.plus_img.src = node.relpath+"ftv2mnode.png"; } node.expanded = true; } } } function glowEffect(n,duration) { n.addClass('glow').delay(duration).queue(function(next){ $(this).removeClass('glow');next(); }); } function highlightAnchor() { var aname = $(location).attr('hash'); var anchor = $(aname); if (anchor.parent().attr('class')=='memItemLeft'){ var rows = $('.memberdecls tr[class$="'+ window.location.hash.substring(1)+'"]'); glowEffect(rows.children(),300); // member without details } else if (anchor.parents().slice(2).prop('tagName')=='TR') { glowEffect(anchor.parents('div.memitem'),1000); // enum value } else if (anchor.parent().attr('class')=='fieldtype'){ glowEffect(anchor.parent().parent(),1000); // struct field } else if (anchor.parent().is(":header")) { glowEffect(anchor.parent(),1000); // section header } else { glowEffect(anchor.next(),1000); // normal member } gotoAnchor(anchor,aname,false); } function selectAndHighlight(hash,n) { var a; if (hash) { var link=stripPath($(location).attr('pathname'))+':'+hash.substring(1); a=$('.item a[class$="'+link+'"]'); } if (a && a.length) { a.parent().parent().addClass('selected'); a.parent().parent().attr('id','selected'); highlightAnchor(); } else if (n) { $(n.itemDiv).addClass('selected'); $(n.itemDiv).attr('id','selected'); } if ($('#nav-tree-contents .item:first').hasClass('selected')) { $('#nav-sync').css('top','30px'); } else { $('#nav-sync').css('top','5px'); } showRoot(); } function showNode(o, node, index, hash) { if (node && node.childrenData) { if (typeof(node.childrenData)==='string') { var varName = node.childrenData; getScript(node.relpath+varName,function(){ node.childrenData = getData(varName); showNode(o,node,index,hash); },true); } else { if (!node.childrenVisited) { getNode(o, node); } $(node.getChildrenUL()).css({'display':'block'}); if (node.isLast) { node.plus_img.src = node.relpath+"ftv2mlastnode.png"; } else { node.plus_img.src = node.relpath+"ftv2mnode.png"; } node.expanded = true; var n = node.children[o.breadcrumbs[index]]; if (index+1<o.breadcrumbs.length) { showNode(o,n,index+1,hash); } else { if (typeof(n.childrenData)==='string') { var varName = n.childrenData; getScript(n.relpath+varName,function(){ n.childrenData = getData(varName); node.expanded=false; showNode(o,node,index,hash); // retry with child node expanded },true); } else { var rootBase = stripPath(o.toroot.replace(/\..+$/, '')); if (rootBase=="index" || rootBase=="pages" || rootBase=="search") { expandNode(o, n, true, true); } selectAndHighlight(hash,n); } } } } else { selectAndHighlight(hash); } } function removeToInsertLater(element) { var parentNode = element.parentNode; var nextSibling = element.nextSibling; parentNode.removeChild(element); return function() { if (nextSibling) { parentNode.insertBefore(element, nextSibling); } else { parentNode.appendChild(element); } }; } function getNode(o, po) { var insertFunction = removeToInsertLater(po.li); po.childrenVisited = true; var l = po.childrenData.length-1; for (var i in po.childrenData) { var nodeData = po.childrenData[i]; po.children[i] = newNode(o, po, nodeData[0], nodeData[1], nodeData[2], i==l); } insertFunction(); } function gotoNode(o,subIndex,root,hash,relpath) { var nti = navTreeSubIndices[subIndex][root+hash]; o.breadcrumbs = $.extend(true, [], nti ? nti : navTreeSubIndices[subIndex][root]); if (!o.breadcrumbs && root!=NAVTREE[0][1]) { // fallback: show index navTo(o,NAVTREE[0][1],"",relpath); $('.item').removeClass('selected'); $('.item').removeAttr('id'); } if (o.breadcrumbs) { o.breadcrumbs.unshift(0); // add 0 for root node showNode(o, o.node, 0, hash); } } function navTo(o,root,hash,relpath) { var link = cachedLink(); if (link) { var parts = link.split('#'); root = parts[0]; if (parts.length>1) hash = '#'+parts[1]; else hash=''; } if (hash.match(/^#l\d+$/)) { var anchor=$('a[name='+hash.substring(1)+']'); glowEffect(anchor.parent(),1000); // line number hash=''; // strip line number anchors //root=root.replace(/_source\./,'.'); // source link to doc link } var url=root+hash; var i=-1; while (NAVTREEINDEX[i+1]<=url) i++; if (i==-1) { i=0; root=NAVTREE[0][1]; } // fallback: show index if (navTreeSubIndices[i]) { gotoNode(o,i,root,hash,relpath) } else { getScript(relpath+'navtreeindex'+i,function(){ navTreeSubIndices[i] = eval('NAVTREEINDEX'+i); if (navTreeSubIndices[i]) { gotoNode(o,i,root,hash,relpath); } },true); } } function showSyncOff(n,relpath) { n.html('<img src="'+relpath+'sync_off.png" title="'+SYNCOFFMSG+'"/>'); } function showSyncOn(n,relpath) { n.html('<img src="'+relpath+'sync_on.png" title="'+SYNCONMSG+'"/>'); } function toggleSyncButton(relpath) { var navSync = $('#nav-sync'); if (navSync.hasClass('sync')) { navSync.removeClass('sync'); showSyncOff(navSync,relpath); storeLink(stripPath2($(location).attr('pathname'))+$(location).attr('hash')); } else { navSync.addClass('sync'); showSyncOn(navSync,relpath); deleteLink(); } } function initNavTree(toroot,relpath) { var o = new Object(); o.toroot = toroot; o.node = new Object(); o.node.li = document.getElementById("nav-tree-contents"); o.node.childrenData = NAVTREE; o.node.children = new Array(); o.node.childrenUL = document.createElement("ul"); o.node.getChildrenUL = function() { return o.node.childrenUL; }; o.node.li.appendChild(o.node.childrenUL); o.node.depth = 0; o.node.relpath = relpath; o.node.expanded = false; o.node.isLast = true; o.node.plus_img = document.createElement("img"); o.node.plus_img.src = relpath+"ftv2pnode.png"; o.node.plus_img.width = 16; o.node.plus_img.height = 22; if (localStorageSupported()) { var navSync = $('#nav-sync'); if (cachedLink()) { showSyncOff(navSync,relpath); navSync.removeClass('sync'); } else { showSyncOn(navSync,relpath); } navSync.click(function(){ toggleSyncButton(relpath); }); } $(window).load(function(){ navTo(o,toroot,window.location.hash,relpath); showRoot(); }); $(window).bind('hashchange', function(){ if (window.location.hash && window.location.hash.length>1){ var a; if ($(location).attr('hash')){ var clslink=stripPath($(location).attr('pathname'))+':'+ $(location).attr('hash').substring(1); a=$('.item a[class$="'+clslink+'"]'); } if (a==null || !$(a).parent().parent().hasClass('selected')){ $('.item').removeClass('selected'); $('.item').removeAttr('id'); } var link=stripPath2($(location).attr('pathname')); navTo(o,link,$(location).attr('hash'),relpath); } else if (!animationInProgress) { $('#doc-content').scrollTop(0); $('.item').removeClass('selected'); $('.item').removeAttr('id'); navTo(o,toroot,window.location.hash,relpath); } }) }

Copyright ©2k19 - Hexid | Tex7ure