ark::doxygen

Typedefs

Defined in “ark/doxygen/doxygen_xml_parser.hh”:

• using NamespaceSectionPtr = std::shared_ptr< NamespaceSection >

• using ClassDefinitionPtr = std::shared_ptr< ClassDefinition >

Classes

• ark::doxygen::ClassDefinition
  This structure contains data about a parsed Doxygen class.

• ark::doxygen::DefineDefinition
  Contains information about a define.

• ark::doxygen::EnumDefinition
  Contains information about a full enumeration.

• ark::doxygen::EnumValueDefinition
  Contains information about an enumeration value.

• ark::doxygen::FunctionDefinition
  This structure contains information about a ‘function’ or ‘method’.

• ark::doxygen::FunctionParameter
  This structure represents a parameter to a function.

• ark::doxygen::NamespaceSection
  This structure contains data about a parsed Doxygen namespace.

• ark::doxygen::ParsedSectionSet
  This structure represents a parsed Doxygen XML output. This is a partial read of the output, mostly intended for documentation generation.

• ark::doxygen::TypeString
  This structure represents a type string something that contains various pieces of type information (and potentially references).

• ark::doxygen::TypeStringElement
  This is an element within a type string. It always contains some content (such as a string), but it might also reference other existing types.

• ark::doxygen::TypedefDefinition
  Contains information about a typedef.

• ark::doxygen::VariableDefinition
  This structure contains information about a ‘variable’.

Functions

Declared in “ark/doxygen/doxygen_xml_parser.hh”:

• ParsedSectionSet parse_doxygen_xml(const std::filesystem::path & path)
  Parses (recursively) the given Doxygen XML output.