Skip to main content

The DocHtmlSummary Class Reference

Node Html summary. More...

Declaration​

class DocHtmlSummary { ... }

Included Headers​

#include <src/docnode.h>

Base class​

classDocCompoundNode

Base class for nodes with children. More...

Public Constructors Index​

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

Public Member Functions Index​

const HtmlAttribList &attribs () const
voidparse ()

Private Member Attributes Index​

HtmlAttribListm_attribs

Description​

Node Html summary.

Definition at line 843 of file docnode.h.

Public Constructors​

DocHtmlSummary()​

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

Definition at line 846 of file docnode.h.

846 DocHtmlSummary(DocParser *parser,DocNodeVariant *parent,const HtmlAttribList &attribs) :
847 DocCompoundNode(parser,parent), m_attribs(attribs) {}

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

Public Member Functions​

attribs()​

const HtmlAttribList & DocHtmlSummary::attribs ()
 inline

Definition at line 848 of file docnode.h.

848 const HtmlAttribList &attribs() const { return m_attribs; }

Reference m_attribs.

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

parse()​

void DocHtmlSummary::parse ()

Declaration at line 849 of file docnode.h, definition at line 1411 of file docnode.cpp.

1411void DocHtmlSummary::parse()
1412{
1413 AUTO_TRACE();
1414 auto ns = AutoNodeStack(parser(),thisVariant());
1415 parser()->tokenizer.setStateTitle();
1416 Token tok = parser()->tokenizer.lex();
1417 while (!tok.is_any_of(TokenRetval::TK_NONE, TokenRetval::TK_EOF))
1418 {
1419 HtmlTagType tagId = HtmlTagType::UNKNOWN;
1420 // check of </summary>
1421 if (tok.value()==TokenRetval::TK_HTMLTAG &&
1422 (tagId=Mappers::htmlTagMapper->map(parser()->context.token->name))==HtmlTagType::XML_SUMMARY &&
1423 parser()->context.token->endTag
1424 )
1425 {
1426 break;
1427 }
1428 else if (!parser()->defaultHandleToken(thisVariant(),tok,children()))
1429 {
1430 parser()->errorHandleDefaultToken(thisVariant(),tok,children(),"summary section");
1431 }
1432 tok = parser()->tokenizer.lex();
1433 }
1434 parser()->tokenizer.setStatePara();
1435 if (tok.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
1436 {
1437 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Unexpected end of comment while inside"
1438 " <summary> tag");
1439 }
1440}

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.

Private Member Attributes​

m_attribs​

HtmlAttribList DocHtmlSummary::m_attribs

Definition at line 852 of file docnode.h.

852 HtmlAttribList m_attribs;

Referenced by attribs and DocHtmlSummary.

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

Generated via doxygen2docusaurus by Doxygen 1.14.0.