ark::doxygen::ClassDefinition

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


This structure contains data about a parsed Doxygen class.

Methods

  • bool empty()
    Returns true if this class has no content.

Variables

  • std::string name
    Name of the class.

  • std::string declaration_file
    File where this was declared.

  • std::string brief_description
    Brief description. Each paragraph is a new line.

  • std::string detailed_description
    Detailed description. Each paragraph is a new line.

  • std::vector< FunctionDefinition > functions
    All of the methods that belong to this class.

  • std::vector< VariableDefinition > variables
    All of the variables that belong to this class.

  • std::vector< EnumDefinition > enums
    All of the enum definitions that belong to this class.

  • std::vector< TypedefDefinition > typedefs
    Any typedefs defined in this class.