The DocSymbol Class Reference

Node representing a special symbol. More...

Declaration

class DocSymbol { ... }

Included Headers

#include <src/docnode.h>

Base class

class	DocNode
	Abstract node interface with type information. More...

Public Constructors Index

	DocSymbol (DocParser *parser, DocNodeVariant *parent, HtmlEntityMapper::SymType s)

Public Member Functions Index

HtmlEntityMapper::SymType	symbol () const

Private Member Attributes Index

HtmlEntityMapper::SymType	m_symbol = HtmlEntityMapper::Sym_Unknown

Public Static Functions Index

static HtmlEntityMapper::SymType	decodeSymbol (const QCString &symName)

Description

Node representing a special symbol.

Definition at line 327 of file docnode.h.

Public Constructors

DocSymbol()

DocSymbol::DocSymbol (DocParser * parser, DocNodeVariant * parent, HtmlEntityMapper::SymType s)

inline

Definition at line 330 of file docnode.h.

330 DocSymbol(DocParser *parser,DocNodeVariant *parent,HtmlEntityMapper::SymType s)

331 : DocNode(parser,parent), m_symbol(s) {}

References DocNode::DocNode, m_symbol, DocNode::parent and DocNode::parser.

Public Member Functions

symbol()

HtmlEntityMapper::SymType DocSymbol::symbol ()

inline

Definition at line 332 of file docnode.h.

332 HtmlEntityMapper::SymType symbol() const { return m_symbol; }

Reference m_symbol.

Referenced by DocbookDocVisitor::operator(), HtmlDocVisitor::operator(), LatexDocVisitor::operator(), ManDocVisitor::operator(), PerlModDocVisitor::operator(), PrintDocVisitor::operator(), RTFDocVisitor::operator(), TextDocVisitor::operator() and XmlDocVisitor::operator().

Private Member Attributes

m_symbol

HtmlEntityMapper::SymType DocSymbol::m_symbol = HtmlEntityMapper::Sym_Unknown

Definition at line 336 of file docnode.h.

336 HtmlEntityMapper::SymType m_symbol = HtmlEntityMapper::Sym_Unknown;

Referenced by DocSymbol and symbol.

Public Static Functions

decodeSymbol()

HtmlEntityMapper::SymType DocSymbol::decodeSymbol (const QCString & symName)

static

Declaration at line 333 of file docnode.h, definition at line 153 of file docnode.cpp.

153HtmlEntityMapper::SymType DocSymbol::decodeSymbol(const QCString &symName)

154{

155 return HtmlEntityMapper::instance().name2sym(symName);

156}

References HtmlEntityMapper::instance and HtmlEntityMapper::name2sym.

Referenced by DocParser::defaultHandleToken, DocIndexEntry::parse, DocPara::parse and DocText::parse.

---

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

• docnode.cpp
• docnode.h

---

Generated via doxygen2docusaurus by Doxygen 1.14.0.