Doxygen
Loading...
Searching...
No Matches
DocSymbol Class Reference

Node representing a special symbol. More...

#include <src/docnode.h>

+ Inheritance diagram for DocSymbol:
+ Collaboration diagram for DocSymbol:

Public Member Functions

 DocSymbol (DocParser *parser, DocNodeVariant *parent, HtmlEntityMapper::SymType s)
 
HtmlEntityMapper::SymType symbol () const
 
- Public Member Functions inherited from DocNode
 DocNode (DocParser *parser, DocNodeVariant *parent)
 
 ~DocNode ()=default
 
DocNodeVariantparent ()
 
const DocNodeVariantparent () const
 
DocNodeVariantthisVariant ()
 
const DocNodeVariantthisVariant () const
 
void setThisVariant (DocNodeVariant *thisVariant)
 
DocParserparser ()
 
const DocParserparser () const
 
void setParent (DocNodeVariant *parent)
 
bool isPreformatted () const
 

Static Public Member Functions

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

Private Attributes

HtmlEntityMapper::SymType m_symbol = HtmlEntityMapper::Sym_Unknown
 

Additional Inherited Members

- Protected Types inherited from DocNode
enum  RefType { Unknown , Anchor , Section , Table }
 
- Protected Member Functions inherited from DocNode
void setInsidePreformatted (bool p)
 

Detailed Description

Node representing a special symbol.

Definition at line 308 of file docnode.h.

Constructor & Destructor Documentation

◆ DocSymbol()

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

Definition at line 311 of file docnode.h.

312 : DocNode(parser,parent), m_symbol(s) {}
DocNode(DocParser *parser, DocNodeVariant *parent)
Definition docnode.h:84
DocParser * parser()
Definition docnode.h:97
DocNodeVariant * parent()
Definition docnode.h:89
HtmlEntityMapper::SymType m_symbol
Definition docnode.h:317

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

Member Function Documentation

◆ decodeSymbol()

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

Definition at line 152 of file docnode.cpp.

153{
154 return HtmlEntityMapper::instance().name2sym(symName);
155}
static HtmlEntityMapper & instance()
Returns the one and only instance of the HTML entity mapper.
SymType name2sym(const QCString &symName) const
Give code of the requested HTML entity name.

References HtmlEntityMapper::instance(), and HtmlEntityMapper::name2sym().

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

◆ symbol()

Member Data Documentation

◆ m_symbol

Definition at line 317 of file docnode.h.

Referenced by DocSymbol(), and symbol().


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