process_generate_xmltree

sphinx_doxysummary.xmltree.process_generate_xmltree(app: Sphinx) → None

Create a tree of name -> DoxygenItem.

This process parses through all xml files in all Doxygen projects which are declared in the config variable doxygen_xml, and creates a look-up table (i.e. a map of item full scope name to its corresponding DexygenItem objects) stored in the extern variable xml_tree.

Parameters:

app (Sphinx) – Sphinx.Builder.

Raises:

ValueError – When the behavior of Doxygen-created XML elements are not as expected.

Notes

• This process should be executed at the initialization of the building process of Sphinx.

• The name saved in xml_tree is the full scope name of item.