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 HtmlAttribList &	attribs () const
void	parse ()
Public Member Functions inherited from DocCompoundNode
	DocCompoundNode (DocParser *parser, DocNodeVariant *parent)
DocNodeList &	children ()
const DocNodeList &	children () const
Public Member Functions inherited from DocNode
	DocNode (DocParser *parser, DocNodeVariant *parent)
	~DocNode ()=default
DocNodeVariant *	parent ()
const DocNodeVariant *	parent () const
DocNodeVariant *	thisVariant ()
const DocNodeVariant *	thisVariant () const
void	setThisVariant (DocNodeVariant *thisVariant)
DocParser *	parser ()
const DocParser *	parser () 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 ,   Requirement }
Protected Member Functions inherited from DocNode
void	setInsidePreformatted (bool p)

Detailed Description

Node Html summary.

Definition at line 852 of file docnode.h.

Constructor & Destructor Documentation

DocHtmlSummary()

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

inline

Definition at line 855 of file docnode.h.

                                                                                           :
       DocCompoundNode(parser,parent), m_attribs(attribs) {}

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

Member Function Documentation

attribs()

const HtmlAttribList & DocHtmlSummary::attribs ( ) const

inline

Definition at line 857 of file docnode.h.

{ return m_attribs; }

References m_attribs.

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

parse()

void DocHtmlSummary::parse

(

)

Definition at line 1501 of file docnode.cpp.

{
  AUTO_TRACE();
  auto ns = AutoNodeStack(parser(),thisVariant());
  parser()->tokenizer.setStateTitle();
  Token tok = parser()->tokenizer.lex();
  while (!tok.is_any_of(TokenRetval::TK_NONE, TokenRetval::TK_EOF))
  {
    // check of </summary>
    if (tok.value()==TokenRetval::TK_HTMLTAG &&
        (Mappers::htmlTagMapper->map(parser()->context.token->name))==HtmlTagType::XML_SUMMARY &&
        parser()->context.token->endTag
       )
    {
      break;
    }
    else if (tok.is_any_of(TokenRetval::TK_COMMAND_AT, TokenRetval::TK_COMMAND_BS) &&
             (Mappers::cmdMapper->map(parser()->context.token->name)== CommandType::CMD_REF))
    {
      parser()->handleRef(thisVariant(),children(),
                          tok.command_to_char(),parser()->context.token->name);
    }
    else if (!parser()->defaultHandleToken(thisVariant(),tok,children()))
    {
      parser()->errorHandleDefaultToken(thisVariant(),tok,children(),"summary section");
    }
    tok = parser()->tokenizer.lex();
  }
  parser()->tokenizer.setStatePara();
  if (tok.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
  {
    warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Unexpected end of comment while inside"
           " <summary> tag");
  }
}

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

Referenced by DocHtmlDetails::parseSummary().

Member Data Documentation

m_attribs

HtmlAttribList DocHtmlSummary::m_attribs

private

Definition at line 861 of file docnode.h.

Referenced by attribs(), and DocHtmlSummary().

---

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

• src/docnode.h
• src/docnode.cpp