DocTitle类 参考

Node representing a simple section title 更多...

#include <docparser.h>

类 DocTitle 继承关系图:

DocTitle 的协作图:

Public 成员函数
	DocTitle (DocParser &parser, DocNode *parent)
void	parse ()
void	parseFromString (const QCString &title)
Kind	kind () const override
bool	hasTitle () const
Public 成员函数 继承自 CompAccept< DocTitle >
	CompAccept (DocParser &parser)
void	accept (DocVisitor *v) override
const DocNodeList &	children () const
DocNodeList &	children ()
Public 成员函数 继承自 DocNode
	DocNode (DocParser &parser)
virtual	~DocNode ()
DocNode *	parent () const
void	setParent (DocNode *parent)
bool	isPreformatted () const

额外继承的成员函数
Public 类型 继承自 DocNode
enum	Kind {   Kind_Root = 0, Kind_Word = 1, Kind_WhiteSpace = 2, Kind_Para = 3,   Kind_AutoList = 4, Kind_AutoListItem = 5, Kind_Symbol = 6, Kind_URL = 7,   Kind_StyleChange = 8, Kind_SimpleSect = 9, Kind_Title = 10, Kind_SimpleList = 11,   Kind_SimpleListItem = 12, Kind_Section = 13, Kind_Verbatim = 14, Kind_XRefItem = 15,   Kind_HtmlList = 16, Kind_HtmlListItem = 17, Kind_HtmlDescList = 18, Kind_HtmlDescData = 19,   Kind_HtmlDescTitle = 20, Kind_HtmlTable = 21, Kind_HtmlRow = 22, Kind_HtmlCell = 23,   Kind_HtmlCaption = 24, Kind_LineBreak = 25, Kind_HorRuler = 26, Kind_Anchor = 27,   Kind_IndexEntry = 28, Kind_Internal = 29, Kind_HRef = 30, Kind_Include = 31,   Kind_IncOperator = 32, Kind_HtmlHeader = 33, Kind_Image = 34, Kind_DotFile = 35,   Kind_Link = 36, Kind_Ref = 37, Kind_Formula = 38, Kind_SecRefItem = 39,   Kind_SecRefList = 40, Kind_SimpleSectSep = 41, Kind_LinkedWord = 42, Kind_ParamSect = 43,   Kind_ParamList = 44, Kind_InternalRef = 45, Kind_Copy = 46, Kind_Text = 47,   Kind_MscFile = 48, Kind_HtmlBlockQuote = 49, Kind_VhdlFlow = 50, Kind_ParBlock = 51,   Kind_DiaFile = 52, Kind_Emoji = 53, Kind_Sep = 54 }
Protected 类型 继承自 DocNode
enum	RefType { Unknown, Anchor, Section, Table }
Protected 成员函数 继承自 DocNode
void	setInsidePreformatted (bool p)
Protected 属性 继承自 CompAccept< DocTitle >
DocNodeList	m_children
Protected 属性 继承自 DocNode
DocNode *	m_parent = 0
DocParser &	m_parser

详细描述

Node representing a simple section title

在文件 docparser.h 第 736 行定义.

构造及析构函数说明

DocTitle()

DocTitle::DocTitle ( DocParser &  parser, DocNode *  parent  )

inline

在文件 docparser.h 第 739 行定义.

: CompAccept<DocTitle>(parser) { m_parent = parent; }

引用了 DocNode::m_parent , 以及 DocNode::parent().

成员函数说明

hasTitle()

bool DocTitle::hasTitle ( ) const

inline

在文件 docparser.h 第 743 行定义.

{ return !m_children.empty(); }

引用了 CompAccept< DocTitle >::m_children.

被这些函数引用 DocSimpleSect::hasTitle(), DocbookDocVisitor::visitPost() , 以及 DocbookDocVisitor::visitPre().

kind()

Kind DocTitle::kind ( ) const

inlineoverridevirtual

Returns the kind of node. Provides runtime type information

实现了 DocNode.

在文件 docparser.h 第 742 行定义.

{ return Kind_Title; }

引用了 DocNode::Kind_Title.

parse()

void DocTitle::parse

(

)

在文件 docparser.cpp 第 4346 行定义.

{
  DBG(("DocTitle::parse() start\n"));
  auto ns = AutoNodeStack(m_parser,this);
  m_parser.tokenizer.setStateTitle();
  int tok;
  while ((tok=m_parser.tokenizer.lex()))
  {
    if (!m_parser.defaultHandleToken(this,tok,m_children))
    {
      m_parser.errorHandleDefaultToken(this,tok,m_children,"title section");
    }
  }
  m_parser.tokenizer.setStatePara();
  m_parser.handlePendingStyleCommands(this,m_children);
  DBG(("DocTitle::parse() end\n"));
}

引用了 DBG, DocParser::defaultHandleToken(), DocParser::errorHandleDefaultToken(), DocParser::handlePendingStyleCommands(), DocTokenizer::lex(), CompAccept< DocTitle >::m_children, DocNode::m_parser, DocTokenizer::setStatePara(), DocTokenizer::setStateTitle() , 以及 DocParser::tokenizer.

被这些函数引用 DocSimpleSect::parse().

parseFromString()

void DocTitle::parseFromString

(

const QCString &

title

)

在文件 docparser.cpp 第 4364 行定义.

{
  m_children.push_back(std::make_unique<DocWord>(m_parser,this,text));
}

引用了 CompAccept< DocTitle >::m_children , 以及 DocNode::m_parser.

被这些函数引用 DocSimpleSect::parseRcs().

---

该类的文档由以下文件生成:

• src/docparser.h
• src/docparser.cpp