Doxybook2::Node

#include <Node.hpp>

Public Classes

	Name
struct	ClassReference
struct	Data
struct	Location
struct	Param
struct	ParameterListItem

Public Types

	Name
typedef std::list<NodePtr>	Children
typedef std::vector<ParameterListItem>	ParameterList
typedef std::vector<ClassReference>	ClassReferences
typedef std::vector<Param>	Params
typedef std::unordered_map<std::string, Data>	ChildrenData
typedef std::tuple<Data, ChildrenData>	LoadDataResult

Public Functions

	Name
NodePtr	parse(NodeCacheMap & cache, const std::string & inputDir, const std::string & refid, bool isGroupOrFile)
NodePtr	parse(NodeCacheMap & cache, const std::string & inputDir, const NodePtr & ptr, bool isGroupOrFile)
NodePtr	parse(Xml::Element & memberdef, const std::string & refid)
	Node(const std::string & refid)
	~Node()
NodePtr	find(const std::string & refid) const
NodePtr	findChild(const std::string & refid) const
bool	isStructured() const
bool	isLanguage() const
bool	isFileOrDir() const
Kind	getKind() const
std::string	getLanguage() const
Type	getType() const
const std::string &	getRefid() const
const std::string &	getQualifiedName() const
const std::string &	getName() const
const Node *	getParent() const
const Node *	getGroup() const
bool	isEmpty() const
const Children &	getChildren() const
const std::string &	getXmlPath() const
const std::string &	getBrief() const
const std::string &	getSummary() const
const std::string &	getTitle() const
Visibility	getVisibility() const
Virtual	getVirtual() const
const ClassReferences &	getBaseClasses() const
const ClassReferences &	getDerivedClasses() const
const std::string &	getUrl() const
const std::string &	getAnchor() const
void	finalize(const Config & config, const TextPrinter & plainPrinter, const TextPrinter & markdownPrinter, const NodeCacheMap & cache)
LoadDataResult	loadData(const Config & config, const TextPrinter & plainPrinter, const TextPrinter & markdownPrinter, const NodeCacheMap & cache) const

Friends

	Name
class	Doxygen

Public Types Documentation

typedef Children

cpp

typedef std::list<NodePtr> Doxybook2::Node::Children;

typedef ParameterList

cpp

typedef std::vector<ParameterListItem> Doxybook2::Node::ParameterList;

typedef ClassReferences

cpp

typedef std::vector<ClassReference> Doxybook2::Node::ClassReferences;

typedef Params

cpp

typedef std::vector<Param> Doxybook2::Node::Params;

typedef ChildrenData

cpp

typedef std::unordered_map<std::string, Data> Doxybook2::Node::ChildrenData;

typedef LoadDataResult

cpp

typedef std::tuple<Data, ChildrenData> Doxybook2::Node::LoadDataResult;

Public Functions Documentation

function parse

cpp

static NodePtr parse(
    NodeCacheMap & cache,
    const std::string & inputDir,
    const std::string & refid,
    bool isGroupOrFile
)

function parse

cpp

static NodePtr parse(
    NodeCacheMap & cache,
    const std::string & inputDir,
    const NodePtr & ptr,
    bool isGroupOrFile
)

function parse

cpp

static NodePtr parse(
    Xml::Element & memberdef,
    const std::string & refid
)

function Node

cpp

explicit Node(
    const std::string & refid
)

function ~Node

cpp

~Node()

function find

cpp

NodePtr find(
    const std::string & refid
) const

function findChild

cpp

NodePtr findChild(
    const std::string & refid
) const

function isStructured

cpp

inline bool isStructured() const

function isLanguage

cpp

inline bool isLanguage() const

function isFileOrDir

cpp

inline bool isFileOrDir() const

function getKind

cpp

inline Kind getKind() const

function getLanguage

cpp

inline std::string getLanguage() const

function getType

cpp

inline Type getType() const

function getRefid

cpp

inline const std::string & getRefid() const

function getQualifiedName

cpp

inline const std::string & getQualifiedName() const

function getName

cpp

inline const std::string & getName() const

function getParent

cpp

inline const Node * getParent() const

function getGroup

cpp

inline const Node * getGroup() const

function isEmpty

cpp

inline bool isEmpty() const

function getChildren

cpp

inline const Children & getChildren() const

function getXmlPath

cpp

inline const std::string & getXmlPath() const

function getBrief

cpp

inline const std::string & getBrief() const

function getSummary

cpp

inline const std::string & getSummary() const

function getTitle

cpp

inline const std::string & getTitle() const

function getVisibility

cpp

inline Visibility getVisibility() const

function getVirtual

cpp

inline Virtual getVirtual() const

function getBaseClasses

cpp

inline const ClassReferences & getBaseClasses() const

function getDerivedClasses

cpp

inline const ClassReferences & getDerivedClasses() const

function getUrl

cpp

inline const std::string & getUrl() const

function getAnchor

cpp

inline const std::string & getAnchor() const

function finalize

cpp

void finalize(
    const Config & config,
    const TextPrinter & plainPrinter,
    const TextPrinter & markdownPrinter,
    const NodeCacheMap & cache
)

function loadData

cpp

LoadDataResult loadData(
    const Config & config,
    const TextPrinter & plainPrinter,
    const TextPrinter & markdownPrinter,
    const NodeCacheMap & cache
) const

Friends

friend Doxygen

cpp

friend class Doxygen(
    Doxygen 
);

Updated on 2026-05-17 at 13:22:38 +0000

Doxybook2::Node ​

Public Classes ​

Public Types ​

Public Functions ​

Friends ​

Public Types Documentation ​

typedef Children ​

typedef ParameterList ​

typedef ClassReferences ​

typedef Params ​

typedef ChildrenData ​

typedef LoadDataResult ​

Public Functions Documentation ​

function parse ​

function parse ​

function parse ​

function Node ​

function ~Node ​

function find ​

function findChild ​

function isStructured ​

function isLanguage ​

function isFileOrDir ​

function getKind ​

function getLanguage ​

function getType ​

function getRefid ​

function getQualifiedName ​

function getName ​

function getParent ​

function getGroup ​

function isEmpty ​

function getChildren ​

function getXmlPath ​

function getBrief ​

function getSummary ​

function getTitle ​

function getVisibility ​

function getVirtual ​

function getBaseClasses ​

function getDerivedClasses ​

function getUrl ​

function getAnchor ​

function finalize ​

function loadData ​

Friends ​

friend Doxygen ​

Doxybook2::Node

Public Classes

Public Types

Public Functions

Friends

Public Types Documentation

typedef Children

typedef ParameterList

typedef ClassReferences

typedef Params

typedef ChildrenData

typedef LoadDataResult

Public Functions Documentation

function parse

function parse

function parse

function Node

function ~Node

function find

function findChild

function isStructured

function isLanguage

function isFileOrDir

function getKind

function getLanguage

function getType

function getRefid

function getQualifiedName

function getName

function getParent

function getGroup

function isEmpty

function getChildren

function getXmlPath

function getBrief

function getSummary

function getTitle

function getVisibility

function getVirtual

function getBaseClasses

function getDerivedClasses

function getUrl

function getAnchor

function finalize

function loadData

Friends

friend Doxygen