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

Node Html summary. More...

#include <src/docnode.h>

Inheritance diagram for DocHtmlSummary:
Collaboration diagram for DocHtmlSummary:

Public Member Functions

 DocHtmlSummary (DocParser *parser, DocNodeVariant *parent, const HtmlAttribList &attribs)
const HtmlAttribListattribs () const
void parse ()
Public Member Functions inherited from DocCompoundNode
 DocCompoundNode (DocParser *parser, DocNodeVariant *parent)
DocNodeListchildren ()
const DocNodeListchildren () 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

Private Attributes

HtmlAttribList m_attribs

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 Html summary.

Definition at line 843 of file docnode.h.

Constructor & Destructor Documentation

◆ DocHtmlSummary()

DocHtmlSummary::DocHtmlSummary ( DocParser * parser,
DocNodeVariant * parent,
const HtmlAttribList & attribs )
inline

Definition at line 846 of file docnode.h.

846 :
DocCompoundNode(DocParser *parser, DocNodeVariant *parent)
Definition docnode.h:141
const HtmlAttribList & attribs() const
Definition docnode.h:848
HtmlAttribList m_attribs
Definition docnode.h:852
DocParser * parser()
Definition docnode.h:98
DocNodeVariant * parent()
Definition docnode.h:90

References attribs(), DocCompoundNode::DocCompoundNode(), m_attribs, DocNode::parent(), and DocNode::parser().

Member Function Documentation

◆ attribs()

const HtmlAttribList & DocHtmlSummary::attribs ( ) const
inline

Definition at line 848 of file docnode.h.

848{ return m_attribs; }

References m_attribs.

Referenced by DocHtmlSummary(), and PrintDocVisitor::operator()().

◆ parse()

void DocHtmlSummary::parse ( )

Definition at line 1424 of file docnode.cpp.

1425{
1426 AUTO_TRACE();
1427 auto ns = AutoNodeStack(parser(),thisVariant());
1429 Token tok = parser()->tokenizer.lex();
1430 while (!tok.is_any_of(TokenRetval::TK_NONE, TokenRetval::TK_EOF))
1431 {
1433 // check of </summary>
1434 if (tok.value()==TokenRetval::TK_HTMLTAG &&
1435 (tagId=Mappers::htmlTagMapper->map(parser()->context.token->name))==HtmlTagType::XML_SUMMARY &&
1436 parser()->context.token->endTag
1437 )
1438 {
1439 break;
1440 }
1441 else if (!parser()->defaultHandleToken(thisVariant(),tok,children()))
1442 {
1443 parser()->errorHandleDefaultToken(thisVariant(),tok,children(),"summary section");
1444 }
1445 tok = parser()->tokenizer.lex();
1446 }
1448 if (tok.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
1449 {
1450 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Unexpected end of comment while inside"
1451 " <summary> tag");
1452 }
1453}
DocNodeList & children()
Definition docnode.h:143
DocNodeVariant * thisVariant()
Definition docnode.h:93
DocTokenizer tokenizer
void errorHandleDefaultToken(DocNodeVariant *parent, Token tok, DocNodeList &children, const QCString &txt)
void setStateTitle()
void setStatePara()
TokenRetval value() const
bool is_any_of(ARGS... args) const
HtmlTagType
Definition cmdmapper.h:169
#define AUTO_TRACE(...)
Definition docnode.cpp:46
#define warn_doc_error(file, line, fmt,...)
Definition message.h:112
const Mapper< HtmlTagType > * htmlTagMapper

References AUTO_TRACE, DocCompoundNode::children(), DocParser::errorHandleDefaultToken(), Mappers::htmlTagMapper, Token::is_any_of(), DocTokenizer::lex(), DocNode::parser(), DocTokenizer::setStatePara(), DocTokenizer::setStateTitle(), DocNode::thisVariant(), DocParser::tokenizer, UNKNOWN, Token::value(), warn_doc_error, and XML_SUMMARY.

Member Data Documentation

◆ m_attribs

HtmlAttribList DocHtmlSummary::m_attribs
private

Definition at line 852 of file docnode.h.

Referenced by attribs(), and DocHtmlSummary().


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