DocNodeAST Class Reference

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

#include <src/docnode.h>

Inheritance diagram for DocNodeAST:

Collaboration diagram for DocNodeAST:

Public Member Functions
template<class DocNode >
	DocNodeAST (DocNode &&r)
bool	isEmpty () const override
Public Member Functions inherited from IDocNodeAST

Public Attributes
DocNodeVariant	root

Detailed Description

Class representing the abstract syntax tree of a documentation block.

Definition at line 1445 of file docnode.h.

Constructor & Destructor Documentation

DocNodeAST()

template<class DocNode >

DocNodeAST::DocNodeAST ( DocNode && r )

inline

Definition at line 1451 of file docnode.h.

                            : root(std::move(r))
    {
      std::get_if<DocNode>(&root)->setThisVariant(&root);
    }

References root.

Member Function Documentation

isEmpty()

bool DocNodeAST::isEmpty ( ) const

inlineoverridevirtual

Implements IDocNodeAST.

Definition at line 1455 of file docnode.h.

    {
      if (std::holds_alternative<DocRoot>(root))
      {
        return std::get<DocRoot>(root).isEmpty();
      }
      else if (std::holds_alternative<DocText>(root))
      {
        return std::get<DocText>(root).isEmpty();
      }
      return false;
    }

References root.

Member Data Documentation

root

DocNodeVariant DocNodeAST::root

Definition at line 1467 of file docnode.h.

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

---

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

• src/docnode.h