The docnode.h File Reference
Included Headers
Namespaces Index
| namespace | details |
Classes Index
| class | DocNode |
|
Abstract node interface with type information. More... | |
| struct | DocNodeList |
| class | DocCompoundNode |
|
Base class for nodes with children. More... | |
| class | DocWord |
|
Node representing a word. More... | |
| class | DocLinkedWord |
|
Node representing a word that can be linked to something. More... | |
| class | DocURL |
|
Node representing a URL (or email address) More... | |
| class | DocLineBreak |
|
Node representing a line break. More... | |
| class | DocHorRuler |
|
Node representing a horizontal ruler. More... | |
| class | DocAnchor |
|
Node representing an anchor. More... | |
| class | DocCite |
|
Node representing a citation of some bibliographic reference. More... | |
| class | DocStyleChange |
|
Node representing a style change. More... | |
| class | DocSymbol |
|
Node representing a special symbol. More... | |
| class | DocEmoji |
|
Node representing an emoji. More... | |
| class | DocWhiteSpace |
|
Node representing some amount of white space. More... | |
| class | DocSeparator |
|
Node representing a separator. More... | |
| class | DocVerbatim |
|
Node representing a verbatim, unparsed text fragment. More... | |
| struct | Private |
| class | DocInclude |
|
Node representing an included text block from file. More... | |
| class | DocIncOperator |
|
Node representing a include/dontinclude operator block. More... | |
| class | DocFormula |
|
Node representing an item of a cross-referenced list. More... | |
| class | DocIndexEntry |
|
Node representing an entry in the index. More... | |
| class | DocAutoList |
|
Node representing an auto List. More... | |
| class | DocAutoListItem |
|
Node representing an item of a auto list. More... | |
| class | DocTitle |
|
Node representing a simple section title. More... | |
| class | DocXRefItem |
|
Node representing an item of a cross-referenced list. More... | |
| class | DocImage |
|
Node representing an image. More... | |
| struct | Private |
| class | DocDiagramFileBase |
| struct | Private |
| class | DocDotFile |
|
Node representing a dot file. More... | |
| class | DocMscFile |
|
Node representing a msc file. More... | |
| class | DocDiaFile |
|
Node representing a dia file. More... | |
| class | DocPlantUmlFile |
|
Node representing a uml file. More... | |
| class | DocVhdlFlow |
|
Node representing a VHDL flow chart. More... | |
| class | DocLink |
|
Node representing a link to some item. More... | |
| class | DocRef |
|
Node representing a reference to some item. More... | |
| class | DocInternalRef |
|
Node representing an internal reference to some item. More... | |
| class | DocHRef |
|
Node representing a Hypertext reference. More... | |
| class | DocHtmlSummary |
|
Node Html summary. More... | |
| class | DocHtmlDetails |
|
Node Html details. More... | |
| class | DocHtmlHeader |
|
Node Html heading. More... | |
| class | DocHtmlDescTitle |
|
Node representing a Html description item. More... | |
| class | DocHtmlDescList |
|
Node representing a Html description list. More... | |
| class | DocSection |
|
Node representing a normal section. More... | |
| class | DocSecRefItem |
|
Node representing a reference to a section. More... | |
| class | DocSecRefList |
|
Node representing a list of section references. More... | |
| class | DocInternal |
|
Node representing an internal section of documentation. More... | |
| class | DocParBlock |
|
Node representing an block of paragraphs. More... | |
| class | DocSimpleList |
|
Node representing a simple list. More... | |
| class | DocHtmlList |
|
Node representing a Html list. More... | |
| class | DocSimpleSect |
|
Node representing a simple section. More... | |
| class | DocSimpleSectSep |
|
Node representing a separator between two simple sections of the same type. More... | |
| class | DocParamSect |
|
Node representing a parameter section. More... | |
| class | DocPara |
|
Node representing a paragraph in the documentation tree. More... | |
| class | DocParamList |
|
Node representing a parameter list. More... | |
| class | DocSimpleListItem |
|
Node representing a simple list item. More... | |
| class | DocHtmlListItem |
|
Node representing a HTML list item. More... | |
| class | DocHtmlDescData |
|
Node representing a HTML description data. More... | |
| class | DocHtmlCell |
|
Node representing a HTML table cell. More... | |
| class | DocHtmlCaption |
|
Node representing a HTML table caption. More... | |
| class | DocHtmlRow |
|
Node representing a HTML table row. More... | |
| class | DocHtmlTable |
|
Node representing a HTML table. More... | |
| class | DocHtmlBlockQuote |
|
Node representing an HTML blockquote. More... | |
| class | DocText |
|
Root node of a text fragment. More... | |
| class | DocRoot |
|
Root node of documentation tree. More... | |
| struct | Impl<T, Ts> |
| struct | Impl<T> |
| struct | has_method_children<T, typename> |
| struct | has_method_children<T, std::void_t< decltype(std::declval< T >().children())>> |
| class | DocNodeAST |
|
Class representing the abstract syntax tree of a documentation block. More... | |
Typedefs Index
Functions Index
| constexpr const char * | docNodeName (const DocWord &) |
| constexpr const char * | docNodeName (const DocLinkedWord &) |
| constexpr const char * | docNodeName (const DocURL &) |
| constexpr const char * | docNodeName (const DocLineBreak &) |
| constexpr const char * | docNodeName (const DocHorRuler &) |
| constexpr const char * | docNodeName (const DocAnchor &) |
| constexpr const char * | docNodeName (const DocCite &) |
| constexpr const char * | docNodeName (const DocStyleChange &) |
| constexpr const char * | docNodeName (const DocSymbol &) |
| constexpr const char * | docNodeName (const DocEmoji &) |
| constexpr const char * | docNodeName (const DocWhiteSpace &) |
| constexpr const char * | docNodeName (const DocSeparator &) |
| constexpr const char * | docNodeName (const DocVerbatim &) |
| constexpr const char * | docNodeName (const DocInclude &) |
| constexpr const char * | docNodeName (const DocIncOperator &) |
| constexpr const char * | docNodeName (const DocFormula &) |
| constexpr const char * | docNodeName (const DocIndexEntry &) |
| constexpr const char * | docNodeName (const DocAutoList &) |
| constexpr const char * | docNodeName (const DocAutoListItem &) |
| constexpr const char * | docNodeName (const DocTitle &) |
| constexpr const char * | docNodeName (const DocXRefItem &) |
| constexpr const char * | docNodeName (const DocImage &) |
| constexpr const char * | docNodeName (const DocDotFile &) |
| constexpr const char * | docNodeName (const DocMscFile &) |
| constexpr const char * | docNodeName (const DocDiaFile &) |
| constexpr const char * | docNodeName (const DocVhdlFlow &) |
| constexpr const char * | docNodeName (const DocLink &) |
| constexpr const char * | docNodeName (const DocRef &) |
| constexpr const char * | docNodeName (const DocInternalRef &) |
| constexpr const char * | docNodeName (const DocHRef &) |
| constexpr const char * | docNodeName (const DocHtmlHeader &) |
| constexpr const char * | docNodeName (const DocHtmlDescTitle &) |
| constexpr const char * | docNodeName (const DocHtmlDescList &) |
| constexpr const char * | docNodeName (const DocSection &) |
| constexpr const char * | docNodeName (const DocSecRefItem &) |
| constexpr const char * | docNodeName (const DocSecRefList &) |
| constexpr const char * | docNodeName (const DocInternal &) |
| constexpr const char * | docNodeName (const DocParBlock &) |
| constexpr const char * | docNodeName (const DocSimpleList &) |
| constexpr const char * | docNodeName (const DocHtmlList &) |
| constexpr const char * | docNodeName (const DocSimpleSect &) |
| constexpr const char * | docNodeName (const DocSimpleSectSep &) |
| constexpr const char * | docNodeName (const DocParamSect &) |
| constexpr const char * | docNodeName (const DocPara &) |
| constexpr const char * | docNodeName (const DocParamList &) |
| constexpr const char * | docNodeName (const DocSimpleListItem &) |
| constexpr const char * | docNodeName (const DocHtmlListItem &) |
| constexpr const char * | docNodeName (const DocHtmlDescData &) |
| constexpr const char * | docNodeName (const DocHtmlCell &) |
| constexpr const char * | docNodeName (const DocHtmlCaption &) |
| constexpr const char * | docNodeName (const DocHtmlRow &) |
| constexpr const char * | docNodeName (const DocHtmlTable &) |
| constexpr const char * | docNodeName (const DocHtmlBlockQuote &) |
| constexpr const char * | docNodeName (const DocText &) |
| constexpr const char * | docNodeName (const DocRoot &) |
| constexpr const char * | docNodeName (const DocHtmlDetails &) |
| constexpr const char * | docNodeName (const DocHtmlSummary &) |
| constexpr const char * | docNodeName (const DocPlantUmlFile &) |
| constexpr DocNodeVariant * | parent (DocNodeVariant *n) |
|
returns the parent node of a given node n or nullptr if the node has no parent. More... | |
| constexpr const DocNodeVariant * | parent (const DocNodeVariant *n) |
|
returns the parent node of a given node n or nullptr if the node has no parent. More... | |
template <class... Ts> | |
| constexpr bool | holds_one_of_alternatives (const DocNodeVariant &v) |
|
returns true iff v holds one of types passed as template parameters More... | |
| DocNodeList * | call_method_children (DocNodeVariant *v) |
| const char * | docNodeName (const DocNodeVariant &v) |
| void | dumpDocNodeSizes () |
| void | dumpDocNodeList (const DocNodeList &children) |
template <class T, class... Args> | |
| auto | createDocNode (Args &&...args) -> std::unique_ptr< DocNodeVariant > |
Macro Definitions Index
| #define | DOC_NODES ... |
| #define | DN(x) class x; |
| #define | DN_SEP |
| #define | DN(x) x |
| #define | DN_SEP , |
| #define | DN(x) constexpr const char *docNodeName(const x &/* n */) { return #x; } |
| #define | DN_SEP |
| #define | DN(x) #x |
| #define | DN_SEP , |
| #define | DN(x) #x |
| #define | DN_SEP , |
| #define | DN(x) sizeof(x) |
| #define | DN_SEP , |
Typedefs
DocNodeVariant
|
Definition at line 67 of file docnode.h.
Functions
call_method_children()
| inline |
Definition at line 1385 of file docnode.h.
Referenced by flattenParagraphs.
createDocNode()
|
Definition at line 1495 of file docnode.h.
Referenced by DocHtmlDetails::parse, DocHtmlTable::parse, DocSection::parse, DocSimpleListItem::parse, DocSimpleSect::parse, DocSimpleSect::parseRcs and DocHtmlDetails::parseSummary.
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| constexpr |
docNodeName()
| inline |
Definition at line 1419 of file docnode.h.
Reference DOC_NODES.
dumpDocNodeList()
| inline |
Definition at line 1451 of file docnode.h.
References docNodeName, qPrint and DocWord::word.
dumpDocNodeSizes()
| inline |
Definition at line 1427 of file docnode.h.
Reference DOC_NODES.
holds_one_of_alternatives()
| constexpr |
returns true iff v holds one of types passed as template parameters
Definition at line 1366 of file docnode.h.
Reference details::Impl< T, Ts >::holds_one_of_alternatives.
Referenced by determineIfNeedsTag, getParagraphContext, LatexDocVisitor::isTableNested, mustBeOutsideParagraph and DocPara::parse.
parent()
| constexpr |
returns the parent node of a given node n or nullptr if the node has no parent.
Definition at line 1330 of file docnode.h.
Referenced by buildDirectories, checkIfHtmlEndTagEndsAutoList, LayoutDocManager::createChildNavEntry, FTVHelp::decContentsDepth, DocParser::defaultHandleTitleAndSize, DocParser::defaultHandleToken, DefineManager::DefinesPerFile::DefinesPerFile, DocDiaFile::DocDiaFile, DocDotFile::DocDotFile, DocMscFile::DocMscFile, DocPlantUmlFile::DocPlantUmlFile, TreeDiagram::drawConnectors, dupOfParent, DocParser::errorHandleDefaultToken, externalLinkTarget, generateClassOrGlobalLink, generateIndent, generateIndentLabel, getParagraphContext, DocParser::handleAHref, DocParser::handleAnchor, DocParser::handleImage, DocParser::handleImg, DocParser::handleInitialStyleCommands, DocParser::handleInternalRef, DocParser::handleLinkedWord, DocParser::handleParameterType, DocParser::handlePendingStyleCommands, DocParser::handlePrefix, DocParser::handleStyleArgument, DocParser::handleStyleEnter, DocParser::handleStyleLeave, DiagramRow::insertClass, insideBlockQuote, insideDetails, insideDL, insideLI, insideOL, insidePRE, insideTable, insideUL, DocParser::internalValidatingParseDoc, isFirstChildNode, isLastChildNode, isSeparatedParagraph, isSymbolHidden, LatexDocVisitor::isTableNested, listIsNested, LatexDocVisitor::operator(), parseMain, pathToNode, recodeString and writeDotDirDepGraph.
parent()
| constexpr |
returns the parent node of a given node n or nullptr if the node has no parent.
Definition at line 1336 of file docnode.h.
Macro Definitions
DN
DN
DN
|
DN
DN
DN
DN_SEP
DN_SEP
DN_SEP
DN_SEP
DN_SEP
DN_SEP
DOC_NODES
|
- Value
-
/* 0 */ DN(DocWord) DN_SEP DN(DocLinkedWord) DN_SEP DN(DocURL) DN_SEP DN(DocLineBreak) DN_SEP DN(DocHorRuler) DN_SEP \ /* 5 */ DN(DocAnchor) DN_SEP DN(DocCite) DN_SEP DN(DocStyleChange) DN_SEP DN(DocSymbol) DN_SEP DN(DocEmoji) DN_SEP \ /* 10 */ DN(DocWhiteSpace) DN_SEP DN(DocSeparator) DN_SEP DN(DocVerbatim) DN_SEP DN(DocInclude) DN_SEP DN(DocIncOperator) DN_SEP \ /* 15 */ DN(DocFormula) DN_SEP DN(DocIndexEntry) DN_SEP DN(DocAutoList) DN_SEP DN(DocAutoListItem) DN_SEP DN(DocTitle) DN_SEP \ /* 20 */ DN(DocXRefItem) DN_SEP DN(DocImage) DN_SEP DN(DocDotFile) DN_SEP DN(DocMscFile) DN_SEP DN(DocDiaFile) DN_SEP \ /* 25 */ DN(DocVhdlFlow) DN_SEP DN(DocLink) DN_SEP DN(DocRef) DN_SEP DN(DocInternalRef) DN_SEP DN(DocHRef) DN_SEP \ /* 30 */ DN(DocHtmlHeader) DN_SEP DN(DocHtmlDescTitle) DN_SEP DN(DocHtmlDescList) DN_SEP DN(DocSection) DN_SEP DN(DocSecRefItem) DN_SEP \ /* 35 */ DN(DocSecRefList) DN_SEP DN(DocInternal) DN_SEP DN(DocParBlock) DN_SEP DN(DocSimpleList) DN_SEP DN(DocHtmlList) DN_SEP \ /* 40 */ DN(DocSimpleSect) DN_SEP DN(DocSimpleSectSep) DN_SEP DN(DocParamSect) DN_SEP DN(DocPara) DN_SEP DN(DocParamList) DN_SEP \ /* 45 */ DN(DocSimpleListItem) DN_SEP DN(DocHtmlListItem) DN_SEP DN(DocHtmlDescData) DN_SEP DN(DocHtmlCell) DN_SEP DN(DocHtmlCaption) DN_SEP \ /* 50 */ DN(DocHtmlRow) DN_SEP DN(DocHtmlTable) DN_SEP DN(DocHtmlBlockQuote) DN_SEP DN(DocText) DN_SEP DN(DocRoot) DN_SEP \ /* 55 */ DN(DocHtmlDetails) DN_SEP DN(DocHtmlSummary) DN_SEP DN(DocPlantUmlFile) \
Definition at line 43 of file docnode.h.
Referenced by docNodeName, docNodeName and dumpDocNodeSizes.
Generated via doxygen2docusaurus by Doxygen 1.14.0.