doxybook::node

^{Defined in header <doxybook/node.hpp>}

class node;

A doxygen node.

Public Classes

	Name
struct	class_reference A reference to a class.
struct	data The data in a doxygen node.
struct	param A parameter.
struct	parameter_list_item An item in a list of parameters.
struct	source_location Source code location.

Public Types

Member Types	Definition
load_data_result	The result of loading the node internal data. ^(using)

Public Functions

Member Functions	Description
parse	Parse root xml objects (classes, structs, etc) ^(function)
(constructor)	Constructor. ^(function)
(destructor)	Destructor. ^(function)
find const	Find a node by refid. ^(function)
find_child const	Find an immediate child node. ^(function)
is_structured const	Check if node represents a structured type. ^(function)
is_language const	Check if node represents a language feature. ^(function)
is_file_or_dir const	Check if node represents a file or directory. ^(function)
get_kind const	Return the kind of node. ^(function)
get_language const	Return the node language. ^(function)
get_type const	Return the node type. ^(function)
get_refid const	Return the node refid. ^(function)
get_qualified_name const	Return the qualified name. ^(function)
get_name const	Return the node name. ^(function)
get_parent const	Return the node parent. ^(function)
get_group const	Return the node group. ^(function)
is_empty const	Check if the node is empty. ^(function)
get_children const	Return all child nodes. ^(function)
get_xml_path const	Return the node xml_path. ^(function)
get_brief const	Return the node brief. ^(function)
get_summary const	Return the node summary. ^(function)
get_title const	Return the node title. ^(function)
get_visibility const	Return the node visibility. ^(function)
get_virtual const	Return the node virtual category. ^(function)
get_base_classes const	Return the node base classes. ^(function)
get_derived_classes const	Return the node derived classes. ^(function)
get_url const	Return the node url. ^(function)
get_anchor const	Return the node anchor. ^(function)
get_section const	Return the node section. ^(function)
finalize	Print the node contents to text and markdown. ^(function)
load_data const	Load the node data and its child nodes. ^(function)

Friends

Friends	Description
doxygen	Constructor. ^{(public friend class)}

Public Types

using load_data_result

^{Defined in header <doxybook/node.hpp>}

using load_data_result = 
    std::tuple< data, std::unordered_map< std::string, data > >;

The result of loading the node internal data.

Public Functions

function parse

^{Defined in header <doxybook/node.hpp>}

(1)

static std::shared_ptr< node >
parse(
    node_cache_map & cache, 
    std::string const & input_dir, 
    std::string const & refid, 
    bool is_group_or_file, 
    bool const allow_undocumented_macros);

(2)

static std::shared_ptr< node >
parse(
    node_cache_map & cache, 
    std::string const & input_dir, 
    std::shared_ptr< node > const & ptr, 
    bool is_group_or_file, 
    bool const allow_undocumented_macros);

(3)

static std::shared_ptr< node >
parse(xml::element & member_def, std::string const & ref_id);

Parse root xml objects (classes, structs, etc)
Parse objects under the specified node.
Parse member xml objects (functions, enums, etc)

Exception Safety

Basic exception guarantee.

function node

^{Defined in header <doxybook/node.hpp>}

explicit node(std::string const & refid);

Constructor.

Parameters

refid - Node id

Description

The constructor will only store the refid and an empty temporary node.

Exception Safety

Basic exception guarantee.

function ~node

^{Defined in header <doxybook/node.hpp>}

~node();

Destructor.

Exception Safety

Basic exception guarantee.

function find

^{Defined in header <doxybook/node.hpp>}

std::shared_ptr< node >
find(std::string const & refid) const;

Find a node by refid.

Exception Safety

Basic exception guarantee.

function find_child

^{Defined in header <doxybook/node.hpp>}

std::shared_ptr< node >
find_child(std::string const & refid) const;

Find an immediate child node.

Exception Safety

Basic exception guarantee.

function is_structured

^{Defined in header <doxybook/node.hpp>}

bool
is_structured() const;

Check if node represents a structured type.

Exception Safety

Basic exception guarantee.

function is_language

^{Defined in header <doxybook/node.hpp>}

bool
is_language() const;

Check if node represents a language feature.

Exception Safety

Basic exception guarantee.

function is_file_or_dir

^{Defined in header <doxybook/node.hpp>}

bool
is_file_or_dir() const;

Check if node represents a file or directory.

Exception Safety

Basic exception guarantee.

function get_kind

^{Defined in header <doxybook/node.hpp>}

kind
get_kind() const;

Return the kind of node.

Exception Safety

Basic exception guarantee.

function get_language

^{Defined in header <doxybook/node.hpp>}

std::string
get_language() const;

Return the node language.

Exception Safety

Basic exception guarantee.

function get_type

^{Defined in header <doxybook/node.hpp>}

type
get_type() const;

Return the node type.

Exception Safety

Basic exception guarantee.

function get_refid

^{Defined in header <doxybook/node.hpp>}

std::string const  &
get_refid() const;

Return the node refid.

Exception Safety

Basic exception guarantee.

function get_qualified_name

^{Defined in header <doxybook/node.hpp>}

std::string const  &
get_qualified_name() const;

Return the qualified name.

Exception Safety

Basic exception guarantee.

function get_name

^{Defined in header <doxybook/node.hpp>}

std::string const  &
get_name() const;

Return the node name.

Exception Safety

Basic exception guarantee.

function get_parent

^{Defined in header <doxybook/node.hpp>}

node const  *
get_parent() const;

Return the node parent.

Exception Safety

Basic exception guarantee.

function get_group

^{Defined in header <doxybook/node.hpp>}

node const  *
get_group() const;

Return the node group.

Exception Safety

Basic exception guarantee.

function is_empty

^{Defined in header <doxybook/node.hpp>}

bool
is_empty() const;

Check if the node is empty.

Exception Safety

Basic exception guarantee.

function get_children

^{Defined in header <doxybook/node.hpp>}

std::list< std::shared_ptr< node > > const  &
get_children() const;

Return all child nodes.

Exception Safety

Basic exception guarantee.

function get_xml_path

^{Defined in header <doxybook/node.hpp>}

std::string const  &
get_xml_path() const;

Return the node xml_path.

Exception Safety

Basic exception guarantee.

function get_brief

^{Defined in header <doxybook/node.hpp>}

std::string const  &
get_brief() const;

Return the node brief.

Exception Safety

Basic exception guarantee.

function get_summary

^{Defined in header <doxybook/node.hpp>}

std::string const  &
get_summary() const;

Return the node summary.

Exception Safety

Basic exception guarantee.

function get_title

^{Defined in header <doxybook/node.hpp>}

std::string const  &
get_title() const;

Return the node title.

Exception Safety

Basic exception guarantee.

function get_visibility

^{Defined in header <doxybook/node.hpp>}

visibility
get_visibility() const;

Return the node visibility.

Exception Safety

Basic exception guarantee.

function get_virtual

^{Defined in header <doxybook/node.hpp>}

virtual_category
get_virtual() const;

Return the node virtual category.

Exception Safety

Basic exception guarantee.

function get_base_classes

^{Defined in header <doxybook/node.hpp>}

std::vector< class_reference > const  &
get_base_classes() const;

Return the node base classes.

Exception Safety

Basic exception guarantee.

function get_derived_classes

^{Defined in header <doxybook/node.hpp>}

std::vector< class_reference > const  &
get_derived_classes() const;

Return the node derived classes.

Exception Safety

Basic exception guarantee.

function get_url

^{Defined in header <doxybook/node.hpp>}

std::string const  &
get_url() const;

Return the node url.

Exception Safety

Basic exception guarantee.

function get_anchor

^{Defined in header <doxybook/node.hpp>}

std::string const  &
get_anchor() const;

Return the node anchor.

Exception Safety

Basic exception guarantee.

function get_section

^{Defined in header <doxybook/node.hpp>}

std::string const  &
get_section() const;

Return the node section.

Description

This is useful for class member functions that need to go into sections

Exception Safety

Basic exception guarantee.

function finalize

^{Defined in header <doxybook/node.hpp>}

void
finalize(
    config const & config, 
    text_printer const & plain_printer, 
    text_printer const & markdown_printer, 
    node_cache_map const & cache);

Print the node contents to text and markdown.

Exception Safety

Basic exception guarantee.

function load_data

^{Defined in header <doxybook/node.hpp>}

load_data_result
load_data(
    config const & config, 
    text_printer const & plain_printer, 
    text_printer const & markdown_printer, 
    node_cache_map const & cache) const;

Load the node data and its child nodes.

Exception Safety

Basic exception guarantee.

Friends

friend doxygen

^{Defined in header <doxybook/node.hpp>}

friend
class doxygen(doxygen);

_{Updated on 2023-04-03}