The DocNodeAST Class Reference

Class representing the abstract syntax tree of a documentation block. More...

Declaration

class DocNodeAST { ... }

Included Headers

#include <src/docnode.h>

Base class

class	IDocNodeAST
	opaque representation of the abstract syntax tree (AST) More...

Public Constructors Index

template <class DocNode>
DocNodeAST (DocNode &&r)

Public Member Functions Index

bool	isEmpty () const override

Public Member Attributes Index

DocNodeVariant	root

Description

Class representing the abstract syntax tree of a documentation block.

Definition at line 1465 of file docnode.h.

Public Constructors

DocNodeAST()

template <class DocNode>

DocNodeAST::DocNodeAST (DocNode && r)

inline

Definition at line 1471 of file docnode.h.

1471 DocNodeAST(DocNode &&r) : root(std::move(r))

1472 {

1473 std::get_if<DocNode>(&root)->setThisVariant(&root);

1474 }

Reference root.

Public Member Functions

isEmpty()

bool DocNodeAST::isEmpty ()

inline virtual

Definition at line 1475 of file docnode.h.

1475 bool isEmpty() const override

1476 {

1477 if (std::holds_alternative<DocRoot>(root))

1478 {

1479 return std::get<DocRoot>(root).isEmpty();

1480 }

1481 else if (std::holds_alternative<DocText>(root))

1482 {

1483 return std::get<DocText>(root).isEmpty();

1484 }

1485 else if (std::holds_alternative<DocTitle>(root))

1486 {

1487 return std::get<DocTitle>(root).isEmpty();

1488 }

1489 return false;

1490 }

Reference root.

Public Member Attributes

root

DocNodeVariant DocNodeAST::root

Definition at line 1491 of file docnode.h.

1491 DocNodeVariant root;

Referenced by DocNodeAST, generateBriefDoc, generateHtmlOutput, isEmpty, HtmlGenerator::writeDoc, LatexGenerator::writeDoc and ManGenerator::writeDoc.

---

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

• docnode.h

---

Generated via doxygen2docusaurus by Doxygen 1.14.0.