DocInternalRef类 参考

Node representing an internal reference to some item 更多...

#include <docparser.h>

类 DocInternalRef 继承关系图:

DocInternalRef 的协作图:

Public 成员函数
	DocInternalRef (DocParser &parser, DocNode *parent, const QCString &target)
void	parse ()
Kind	kind () const override
QCString	file () const
QCString	relPath () const
QCString	anchor () const
Public 成员函数 继承自 CompAccept< DocInternalRef >
	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

Private 属性
QCString	m_file
QCString	m_relPath
QCString	m_anchor

额外继承的成员函数
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< DocInternalRef >
DocNodeList	m_children
Protected 属性 继承自 DocNode
DocNode *	m_parent = 0
DocParser &	m_parser

详细描述

Node representing an internal reference to some item

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

构造及析构函数说明

DocInternalRef()

DocInternalRef::DocInternalRef	(	DocParser &	parser,
		DocNode *	parent,
		const QCString &	target
	)

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

  : CompAccept<DocInternalRef>(parser), m_relPath(parser.context.relPath)
{
  m_parent = parent;
  int i=ref.find('#');
  if (i!=-1)
  {
    m_anchor = ref.right((int)ref.length()-i-1);
    m_file   = ref.left(i);
  }
  else
  {
    m_file = ref;
  }
}

引用了 QCString::find(), QCString::left(), QCString::length(), m_anchor, m_file, DocNode::m_parent, DocNode::parent() , 以及 QCString::right().

成员函数说明

anchor()

QCString DocInternalRef::anchor ( ) const

inline

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

{ return m_anchor; }

引用了 m_anchor.

被这些函数引用 LatexDocVisitor::visitPost(), PrintDocVisitor::visitPost(), HtmlDocVisitor::visitPre(), DocbookDocVisitor::visitPre(), LatexDocVisitor::visitPre(), RTFDocVisitor::visitPre(), XmlDocVisitor::visitPre() , 以及 PerlModDocVisitor::visitPre().

file()

QCString DocInternalRef::file ( ) const

inline

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

{ return m_file; }

引用了 m_file.

被这些函数引用 LatexDocVisitor::visitPost(), PrintDocVisitor::visitPost(), HtmlDocVisitor::visitPre(), DocbookDocVisitor::visitPre(), LatexDocVisitor::visitPre(), RTFDocVisitor::visitPre(), XmlDocVisitor::visitPre() , 以及 PerlModDocVisitor::visitPre().

kind()

Kind DocInternalRef::kind ( ) const

inlineoverridevirtual

Returns the kind of node. Provides runtime type information

实现了 DocNode.

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

{ return Kind_Ref; }

引用了 DocNode::Kind_Ref.

parse()

void DocInternalRef::parse

(

)

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

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

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

被这些函数引用 DocParser::defaultHandleToken() , 以及 DocPara::handleCommand().

relPath()

QCString DocInternalRef::relPath ( ) const

inline

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

{ return m_relPath; }

引用了 m_relPath.

被这些函数引用 HtmlDocVisitor::visitPre().

类成员变量说明

m_anchor

QCString DocInternalRef::m_anchor

private

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

被这些函数引用 anchor() , 以及 DocInternalRef().

m_file

QCString DocInternalRef::m_file

private

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

被这些函数引用 DocInternalRef() , 以及 file().

m_relPath

QCString DocInternalRef::m_relPath

private

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

被这些函数引用 relPath().

---

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

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