Doxygen
DocVhdlFlow类 参考

Node representing a VHDL flow chart 更多...

#include <docparser.h>

+ 类 DocVhdlFlow 继承关系图:
+ DocVhdlFlow 的协作图:

Public 成员函数

 DocVhdlFlow (DocParser &parser, DocNode *parent)
 
void parse ()
 
Kind kind () const override
 
bool hasCaption ()
 
- Public 成员函数 继承自 CompAccept< DocVhdlFlow >
 CompAccept (DocParser &parser)
 
void accept (DocVisitor *v) override
 
const DocNodeListchildren () const
 
DocNodeListchildren ()
 
- Public 成员函数 继承自 DocNode
 DocNode (DocParser &parser)
 
virtual ~DocNode ()
 
DocNodeparent () 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< DocVhdlFlow >
DocNodeList m_children
 
- Protected 属性 继承自 DocNode
DocNodem_parent = 0
 
DocParserm_parser
 

详细描述

Node representing a VHDL flow chart

在文件 docparser.h860 行定义.

构造及析构函数说明

◆ DocVhdlFlow()

DocVhdlFlow::DocVhdlFlow ( DocParser parser,
DocNode parent 
)

在文件 docparser.cpp2828 行定义.

2828  : CompAccept<DocVhdlFlow>(parser)
2829 {
2830  m_parent = parent;
2831 }

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

成员函数说明

◆ hasCaption()

bool DocVhdlFlow::hasCaption ( )
inline

在文件 docparser.h866 行定义.

866 { return !m_children.empty(); }

引用了 CompAccept< DocVhdlFlow >::m_children.

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

◆ kind()

Kind DocVhdlFlow::kind ( ) const
inlineoverridevirtual

Returns the kind of node. Provides runtime type information

实现了 DocNode.

在文件 docparser.h865 行定义.

865 { return Kind_VhdlFlow; }

引用了 DocNode::Kind_VhdlFlow.

◆ parse()

void DocVhdlFlow::parse ( )

在文件 docparser.cpp2833 行定义.

2834 {
2835  auto ns = AutoNodeStack(m_parser,this);
2836  DBG(("DocVhdlFlow::parse() start\n"));
2837 
2839  int tok;
2840  while ((tok=m_parser.tokenizer.lex()))
2841  {
2842  if (!m_parser.defaultHandleToken(this,tok,m_children))
2843  {
2844  m_parser.errorHandleDefaultToken(this,tok,m_children,"\\vhdlflow");
2845  }
2846  }
2847  tok=m_parser.tokenizer.lex();
2848 
2851 
2852  DBG(("DocVhdlFlow::parse() end\n"));
2854 }

引用了 DocParser::context, VhdlDocGen::createFlowChart(), DBG, DocParser::defaultHandleToken(), DocParser::errorHandleDefaultToken(), DocParser::handlePendingStyleCommands(), DocTokenizer::lex(), CompAccept< DocVhdlFlow >::m_children, DocNode::m_parser, DocParserContext::memberDef, DocTokenizer::setStatePara(), DocTokenizer::setStateTitle() , 以及 DocParser::tokenizer.

被这些函数引用 DocPara::handleVhdlFlow().


该类的文档由以下文件生成:
DocParser::context
DocParserContext context
Definition: docparser.cpp:175
VhdlDocGen::createFlowChart
static void createFlowChart(const MemberDef *)
Definition: vhdldocgen.cpp:2742
CompAccept< DocVhdlFlow >
DocParser::handlePendingStyleCommands
void handlePendingStyleCommands(DocNode *parent, DocNodeList &children)
Definition: docparser.cpp:912
DocParser::tokenizer
DocTokenizer tokenizer
Definition: docparser.cpp:176
DocParserContext::memberDef
const MemberDef * memberDef
Definition: docparser.cpp:117
DocParser::defaultHandleToken
bool defaultHandleToken(DocNode *parent, int tok, DocNodeList &children, bool handleWord=TRUE)
Definition: docparser.cpp:1277
DocParser::errorHandleDefaultToken
void errorHandleDefaultToken(DocNode *parent, int tok, DocNodeList &children, const QCString &txt)
Definition: docparser.cpp:775
DocNode::m_parser
DocParser & m_parser
Definition: docparser.h:184
DocNode::Kind_VhdlFlow
@ Kind_VhdlFlow
Definition: docparser.h:150
DocTokenizer::setStateTitle
void setStateTitle()
AutoNodeStack
Definition: docparser.cpp:186
DocTokenizer::lex
int lex()
DocNode::parent
DocNode * parent() const
Definition: docparser.h:166
DocTokenizer::setStatePara
void setStatePara()
DBG
#define DBG(x)
Definition: docparser.cpp:58
CompAccept< DocVhdlFlow >::m_children
DocNodeList m_children
Definition: docparser.h:211
DocNode::m_parent
DocNode * m_parent
Definition: docparser.h:182