The DocNode Class Reference

Abstract node interface with type information. More...

Declaration

class DocNode { ... }

Included Headers

#include <src/docnode.h>

Derived Classes

class	DocAnchor
	Node representing an anchor. More...
class	DocCite
	Node representing a citation of some bibliographic reference. More...
class	DocCompoundNode
	Base class for nodes with children. More...
class	DocEmoji
	Node representing an emoji. More...
class	DocFormula
	Node representing an item of a cross-referenced list. More...
class	DocHorRuler
	Node representing a horizontal ruler. More...
class	DocIncOperator
	Node representing a include/dontinclude operator block. More...
class	DocInclude
	Node representing an included text block from file. More...
class	DocIndexEntry
	Node representing an entry in the index. More...
class	DocLineBreak
	Node representing a line break. More...
class	DocLinkedWord
	Node representing a word that can be linked to something. More...
class	DocParamList
	Node representing a parameter list. More...
class	DocSeparator
	Node representing a separator. More...
class	DocSimpleListItem
	Node representing a simple list item. More...
class	DocSimpleSectSep
	Node representing a separator between two simple sections of the same type. More...
class	DocStyleChange
	Node representing a style change. More...
class	DocSymbol
	Node representing a special symbol. More...
class	DocURL
	Node representing a URL (or email address) More...
class	DocVerbatim
	Node representing a verbatim, unparsed text fragment. More...
class	DocWhiteSpace
	Node representing some amount of white space. More...
class	DocWord
	Node representing a word. More...

Enumerations Index

enum	RefType { ... }

Public Constructors Index

	DocNode (DocParser *parser, DocNodeVariant *parent)

Public Destructor Index

	~DocNode ()=default

Public Member Functions Index

DocNodeVariant *	parent ()
const DocNodeVariant *	parent () const
DocNodeVariant *	thisVariant ()
const DocNodeVariant *	thisVariant () const
void	setThisVariant (DocNodeVariant *thisVariant)
DocParser *	parser ()
const DocParser *	parser () const
void	setParent (DocNodeVariant *parent)
bool	isPreformatted () const

Protected Member Functions Index

void	setInsidePreformatted (bool p)

Private Member Attributes Index

bool	m_insidePre = false
DocParser *	m_parser
DocNodeVariant *	m_parent
DocNodeVariant *	m_thisVariant = nullptr

Description

Abstract node interface with type information.

Definition at line 81 of file docnode.h.

Enumerations

RefType

enum DocNode::RefType

protected

Enumeration values

Unknown
Anchor
Section
Table

Definition at line 110 of file docnode.h.

110 enum RefType { Unknown, Anchor, Section, Table };

Public Constructors

DocNode()

DocNode::DocNode (DocParser * parser, DocNodeVariant * parent)

inline

Creates a new node

Definition at line 85 of file docnode.h.

85 DocNode(DocParser *parser,DocNodeVariant *parent) : m_parser(parser), m_parent(parent) {}

References m_parent, m_parser, parent and parser.

Referenced by DocAnchor::DocAnchor, DocCite::DocCite, DocCompoundNode::DocCompoundNode, DocEmoji::DocEmoji, DocFormula::DocFormula, DocHorRuler::DocHorRuler, DocInclude::DocInclude, DocIncOperator::DocIncOperator, DocIndexEntry::DocIndexEntry, DocLineBreak::DocLineBreak, DocLineBreak::DocLineBreak, DocLinkedWord::DocLinkedWord, DocParamList::DocParamList, DocSeparator::DocSeparator, DocSimpleListItem::DocSimpleListItem, DocSimpleSectSep::DocSimpleSectSep, DocStyleChange::DocStyleChange, DocStyleChange::DocStyleChange, DocSymbol::DocSymbol, DocURL::DocURL, DocVerbatim::DocVerbatim, DocWhiteSpace::DocWhiteSpace, DocWord::DocWord and ~DocNode.

Public Destructor

~DocNode()

DocNode::~DocNode ()

default

Definition at line 86 of file docnode.h.

Reference DocNode.

Public Member Functions

isPreformatted()

bool DocNode::isPreformatted ()

inline

Returns TRUE iff this node is inside a preformatted section

Definition at line 105 of file docnode.h.

105 bool isPreformatted() const { return m_insidePre; }

Reference m_insidePre.

Referenced by HtmlDocVisitor::operator(), HtmlDocVisitor::operator(), HtmlDocVisitor::operator(), HtmlDocVisitor::operator(), HtmlDocVisitor::operator() and HtmlDocVisitor::operator().

parent()

DocNodeVariant * DocNode::parent ()

inline

Returns the parent of this node or nullptr for the root node.

Definition at line 90 of file docnode.h.

90 DocNodeVariant *parent() { return m_parent; }

References m_parent and parent.

Referenced by determineIfNeedsTag, DocAnchor::DocAnchor, DocAutoList::DocAutoList, DocAutoListItem::DocAutoListItem, DocCite::DocCite, DocCompoundNode::DocCompoundNode, DocDiagramFileBase::DocDiagramFileBase, DocEmoji::DocEmoji, DocFormula::DocFormula, DocHorRuler::DocHorRuler, DocHRef::DocHRef, DocHtmlBlockQuote::DocHtmlBlockQuote, DocHtmlCaption::DocHtmlCaption, DocHtmlCell::DocHtmlCell, DocHtmlDescData::DocHtmlDescData, DocHtmlDescList::DocHtmlDescList, DocHtmlDescTitle::DocHtmlDescTitle, DocHtmlDetails::DocHtmlDetails, DocHtmlHeader::DocHtmlHeader, DocHtmlList::DocHtmlList, DocHtmlListItem::DocHtmlListItem, DocHtmlRow::DocHtmlRow, DocHtmlSummary::DocHtmlSummary, DocHtmlTable::DocHtmlTable, DocImage::DocImage, DocInclude::DocInclude, DocIncOperator::DocIncOperator, DocIndexEntry::DocIndexEntry, DocInternal::DocInternal, DocInternalRef::DocInternalRef, DocLineBreak::DocLineBreak, DocLineBreak::DocLineBreak, DocLink::DocLink, DocLinkedWord::DocLinkedWord, DocNode, DocPara::DocPara, DocParamList::DocParamList, DocParamSect::DocParamSect, DocParBlock::DocParBlock, DocRef::DocRef, DocSecRefItem::DocSecRefItem, DocSecRefList::DocSecRefList, DocSection::DocSection, DocSeparator::DocSeparator, DocSimpleList::DocSimpleList, DocSimpleListItem::DocSimpleListItem, DocSimpleSect::DocSimpleSect, DocSimpleSectSep::DocSimpleSectSep, DocStyleChange::DocStyleChange, DocStyleChange::DocStyleChange, DocSymbol::DocSymbol, DocTitle::DocTitle, DocURL::DocURL, DocVerbatim::DocVerbatim, DocVhdlFlow::DocVhdlFlow, DocWhiteSpace::DocWhiteSpace, DocWord::DocWord, DocXRefItem::DocXRefItem, getParagraphContext, DocPara::handleHtmlStartTag, listIsNested, DocbookDocVisitor::operator(), DocbookDocVisitor::operator(), HtmlDocVisitor::operator(), LatexDocVisitor::operator(), LatexDocVisitor::operator(), LatexDocVisitor::operator(), LatexDocVisitor::operator(), LatexDocVisitor::operator(), ManDocVisitor::operator(), ManDocVisitor::operator(), ManDocVisitor::operator(), PerlModDocVisitor::operator(), RTFDocVisitor::operator(), RTFDocVisitor::operator(), XmlDocVisitor::operator(), parent, DocPara::parse, DocParamList::parse, DocTitle::parseFromString, DocHtmlDetails::parseSummary and setParent.

parent()

const DocNodeVariant * DocNode::parent ()

inline

Definition at line 91 of file docnode.h.

91 const DocNodeVariant *parent() const { return m_parent; }

Reference m_parent.

parser()

DocParser * DocNode::parser ()

inline

Definition at line 98 of file docnode.h.

98 DocParser *parser() { return m_parser; }

Reference m_parser.

Referenced by DocSimpleSect::appendLinkWord, DocAnchor::DocAnchor, DocAutoList::DocAutoList, DocAutoListItem::DocAutoListItem, DocCite::DocCite, DocCompoundNode::DocCompoundNode, DocDiaFile::DocDiaFile, DocDiagramFileBase::DocDiagramFileBase, DocDotFile::DocDotFile, DocEmoji::DocEmoji, DocFormula::DocFormula, DocHorRuler::DocHorRuler, DocHRef::DocHRef, DocHtmlBlockQuote::DocHtmlBlockQuote, DocHtmlCaption::DocHtmlCaption, DocHtmlCell::DocHtmlCell, DocHtmlDescData::DocHtmlDescData, DocHtmlDescList::DocHtmlDescList, DocHtmlDescTitle::DocHtmlDescTitle, DocHtmlDetails::DocHtmlDetails, DocHtmlHeader::DocHtmlHeader, DocHtmlList::DocHtmlList, DocHtmlListItem::DocHtmlListItem, DocHtmlRow::DocHtmlRow, DocHtmlSummary::DocHtmlSummary, DocHtmlTable::DocHtmlTable, DocImage::DocImage, DocInclude::DocInclude, DocIncOperator::DocIncOperator, DocIndexEntry::DocIndexEntry, DocInternal::DocInternal, DocInternalRef::DocInternalRef, DocLineBreak::DocLineBreak, DocLineBreak::DocLineBreak, DocLink::DocLink, DocLinkedWord::DocLinkedWord, DocMscFile::DocMscFile, DocNode, DocPara::DocPara, DocParamList::DocParamList, DocParamSect::DocParamSect, DocParBlock::DocParBlock, DocPlantUmlFile::DocPlantUmlFile, DocRef::DocRef, DocRoot::DocRoot, DocSecRefItem::DocSecRefItem, DocSecRefList::DocSecRefList, DocSection::DocSection, DocSeparator::DocSeparator, DocSimpleList::DocSimpleList, DocSimpleListItem::DocSimpleListItem, DocSimpleSect::DocSimpleSect, DocSimpleSectSep::DocSimpleSectSep, DocStyleChange::DocStyleChange, DocStyleChange::DocStyleChange, DocSymbol::DocSymbol, DocText::DocText, DocTitle::DocTitle, DocURL::DocURL, DocVerbatim::DocVerbatim, DocVhdlFlow::DocVhdlFlow, DocWhiteSpace::DocWhiteSpace, DocWord::DocWord, DocXRefItem::DocXRefItem, DocPara::handleCite, DocPara::handleCommand, DocPara::handleDoxyConfig, DocPara::handleEmoji, DocPara::handleFile, DocPara::handleHtmlEndTag, DocPara::handleHtmlHeader, DocPara::handleHtmlStartTag, DocPara::handleIFile, DocPara::handleILine, DocPara::handleInclude, DocPara::handleIncludeOperator, DocPara::handleInheritDoc, DocPara::handleLink, DocPara::handleParamSection, DocPara::handleRef, DocPara::handleSection, DocPara::handleShowDate, DocPara::handleSimpleSection, DocPara::handleStartCode, DocPara::handleVhdlFlow, DocPara::handleXRefItem, DocPara::injectToken, DocAutoList::parse, DocAutoListItem::parse, DocDiaFile::parse, DocDotFile::parse, DocHRef::parse, DocHtmlBlockQuote::parse, DocHtmlCaption::parse, DocHtmlCell::parse, DocHtmlDescData::parse, DocHtmlDescList::parse, DocHtmlDescTitle::parse, DocHtmlDetails::parse, DocHtmlHeader::parse, DocHtmlList::parse, DocHtmlListItem::parse, DocHtmlRow::parse, DocHtmlSummary::parse, DocHtmlTable::parse, DocImage::parse, DocInclude::parse, DocIncOperator::parse, DocIndexEntry::parse, DocInternal::parse, DocInternalRef::parse, DocLink::parse, DocMscFile::parse, DocPara::parse, DocParamList::parse, DocParamSect::parse, DocParBlock::parse, DocPlantUmlFile::parse, DocRef::parse, DocRoot::parse, DocSecRefItem::parse, DocSecRefList::parse, DocSection::parse, DocSimpleList::parse, DocSimpleListItem::parse, DocSimpleSect::parse, DocText::parse, DocTitle::parse, DocVhdlFlow::parse, DocXRefItem::parse, DocTitle::parseFromString, DocSimpleSect::parseRcs, DocHtmlDetails::parseSummary, DocHtmlCell::parseXml, DocHtmlList::parseXml, DocHtmlListItem::parseXml, DocHtmlRow::parseXml, DocHtmlTable::parseXml, DocParamList::parseXml and DocSimpleSect::parseXml.

parser()

const DocParser * DocNode::parser ()

inline

Definition at line 99 of file docnode.h.

99 const DocParser *parser() const { return m_parser; }

Reference m_parser.

setParent()

void DocNode::setParent (DocNodeVariant * parent)

inline

Sets a new parent for this node.

Definition at line 102 of file docnode.h.

102 void setParent(DocNodeVariant *parent) { m_parent = parent; }

References m_parent and parent.

setThisVariant()

void DocNode::setThisVariant (DocNodeVariant * thisVariant)

inline

Definition at line 96 of file docnode.h.

96 void setThisVariant(DocNodeVariant *thisVariant) { m_thisVariant=thisVariant; }

References m_thisVariant and thisVariant.

thisVariant()

DocNodeVariant * DocNode::thisVariant ()

inline

Definition at line 93 of file docnode.h.

93 DocNodeVariant *thisVariant() { return m_thisVariant; }

Reference m_thisVariant.

Referenced by DocSimpleSect::appendLinkWord, DocPara::handleCite, DocPara::handleCommand, DocPara::handleDoxyConfig, DocPara::handleEmoji, DocPara::handleFile, DocPara::handleHtmlEndTag, DocPara::handleHtmlHeader, DocPara::handleHtmlStartTag, DocPara::handleInclude, DocPara::handleIncludeOperator, DocPara::handleInheritDoc, DocPara::handleLink, DocPara::handleParamSection, DocPara::handleRef, DocPara::handleShowDate, DocPara::handleSimpleSection, DocPara::handleStartCode, DocPara::handleVhdlFlow, DocPara::handleXRefItem, DocPara::injectToken, DocAutoList::parse, DocAutoListItem::parse, DocDiaFile::parse, DocDotFile::parse, DocHRef::parse, DocHtmlBlockQuote::parse, DocHtmlCaption::parse, DocHtmlCell::parse, DocHtmlDescData::parse, DocHtmlDescList::parse, DocHtmlDescTitle::parse, DocHtmlDetails::parse, DocHtmlHeader::parse, DocHtmlList::parse, DocHtmlListItem::parse, DocHtmlRow::parse, DocHtmlSummary::parse, DocHtmlTable::parse, DocImage::parse, DocIndexEntry::parse, DocInternal::parse, DocInternalRef::parse, DocLink::parse, DocMscFile::parse, DocPara::parse, DocParamList::parse, DocParamSect::parse, DocParBlock::parse, DocPlantUmlFile::parse, DocRef::parse, DocRoot::parse, DocSecRefItem::parse, DocSecRefList::parse, DocSection::parse, DocSimpleList::parse, DocSimpleListItem::parse, DocSimpleSect::parse, DocText::parse, DocTitle::parse, DocVhdlFlow::parse, DocXRefItem::parse, DocTitle::parseFromString, DocSimpleSect::parseRcs, DocHtmlCell::parseXml, DocHtmlList::parseXml, DocHtmlListItem::parseXml, DocHtmlRow::parseXml, DocHtmlTable::parseXml, DocParamList::parseXml, DocSimpleSect::parseXml and setThisVariant.

thisVariant()

const DocNodeVariant * DocNode::thisVariant ()

inline

Definition at line 94 of file docnode.h.

94 const DocNodeVariant *thisVariant() const { return m_thisVariant; }

Reference m_thisVariant.

Protected Member Functions

setInsidePreformatted()

void DocNode::setInsidePreformatted (bool p)

inline protected

Sets whether or not this item is inside a preformatted section

Definition at line 109 of file docnode.h.

109 void setInsidePreformatted(bool p) { m_insidePre = p; }

Reference m_insidePre.

Referenced by DocPara::handleHtmlEndTag and DocPara::handleHtmlStartTag.

Private Member Attributes

m_insidePre

bool DocNode::m_insidePre = false

Definition at line 112 of file docnode.h.

112 bool m_insidePre = false;

Referenced by isPreformatted and setInsidePreformatted.

m_parent

DocNodeVariant* DocNode::m_parent

Definition at line 114 of file docnode.h.

114 DocNodeVariant *m_parent;

Referenced by DocNode, parent, parent and setParent.

m_parser

DocParser* DocNode::m_parser

Definition at line 113 of file docnode.h.

113 DocParser *m_parser;

Referenced by DocNode, parser and parser.

m_thisVariant

DocNodeVariant* DocNode::m_thisVariant = nullptr

Definition at line 115 of file docnode.h.

115 DocNodeVariant *m_thisVariant = nullptr;

Referenced by setThisVariant, thisVariant and thisVariant.

---

The documentation for this class was generated from the following file:

• docnode.h

---

Generated via doxygen2docusaurus by Doxygen 1.14.0.