DocMscFile类 参考

Node representing a msc file 更多...

#include <docparser.h>

类 DocMscFile 继承关系图:

DocMscFile 的协作图:

Public 成员函数
	DocMscFile (DocParser &parser, DocNode *parent, const QCString &name, const QCString &context, const QCString &srcFile, int srcLine)
Kind	kind () const override
bool	parse ()
Public 成员函数 继承自 DocDiagramFileBase< DocMscFile >
	DocDiagramFileBase (DocParser &parser, const QCString &name, const QCString &context, const QCString &srcFile, int srcLine)
QCString	name () const
QCString	file () const
QCString	relPath () const
bool	hasCaption () const
QCString	width () const
QCString	height () const
QCString	context () const
QCString	srcFile () const
int	srcLine () const
Public 成员函数 继承自 CompAccept< DocMscFile >
	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 属性 继承自 DocDiagramFileBase< DocMscFile >
QCString	m_name
QCString	m_file
QCString	m_relPath
QCString	m_width
QCString	m_height
QCString	m_context
QCString	m_srcFile
int	m_srcLine
Protected 属性 继承自 CompAccept< DocMscFile >
DocNodeList	m_children
Protected 属性 继承自 DocNode
DocNode *	m_parent = 0
DocParser &	m_parser

详细描述

Node representing a msc file

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

构造及析构函数说明

DocMscFile()

DocMscFile::DocMscFile	(	DocParser &	parser,
		DocNode *	parent,
		const QCString &	name,
		const QCString &	context,
		const QCString &	srcFile,
		int	srcLine
	)

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

                                                             :
  DocDiagramFileBase(parser,name,context,srcFile,srcLine)
{
  m_relPath = parser.context.relPath;
  m_parent = parent;
}

引用了 DocParser::context, DocNode::m_parent, DocDiagramFileBase< DocMscFile >::m_relPath, DocNode::parent() , 以及 DocParserContext::relPath.

成员函数说明

kind()

Kind DocMscFile::kind ( ) const

inlineoverridevirtual

Returns the kind of node. Provides runtime type information

实现了 DocNode.

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

{ return Kind_MscFile; }

引用了 DocNode::Kind_MscFile.

parse()

bool DocMscFile::parse

(

)

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

{
  bool ok = false;
  m_parser.defaultHandleTitleAndSize(CMD_MSCFILE,this,m_children,m_width,m_height);
 
  bool ambig;
  FileDef *fd = findFileDef(Doxygen::mscFileNameLinkedMap,m_name,ambig);
  if (fd==0 && m_name.right(4)!=".msc") // try with .msc extension as well
  {
    fd = findFileDef(Doxygen::mscFileNameLinkedMap,m_name+".msc",ambig);
  }
  if (fd)
  {
    m_file = fd->absFilePath();
    ok = true;
    if (ambig)
    {
      warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"included msc file name %s is ambiguous.\n"
           "Possible candidates:\n%s",qPrint(m_name),
           qPrint(showFileDefMatches(Doxygen::mscFileNameLinkedMap,m_name))
          );
    }
  }
  else
  {
    warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"included msc file %s is not found "
           "in any of the paths specified via MSCFILE_DIRS!",qPrint(m_name));
  }
  return ok;
}

引用了 FileDef::absFilePath(), CMD_MSCFILE, DocParser::context, DocParser::defaultHandleTitleAndSize(), DocParserContext::fileName, findFileDef(), DocTokenizer::getLineNr(), CompAccept< DocMscFile >::m_children, DocDiagramFileBase< DocMscFile >::m_file, DocDiagramFileBase< DocMscFile >::m_height, DocDiagramFileBase< DocMscFile >::m_name, DocNode::m_parser, DocDiagramFileBase< DocMscFile >::m_width, Doxygen::mscFileNameLinkedMap, qPrint(), QCString::right(), showFileDefMatches(), DocParser::tokenizer , 以及 warn_doc_error().

---

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

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