Doxygen
Loading...
Searching...
No Matches
DocVhdlFlow Class Reference

Node representing a VHDL flow chart. More...

#include <src/docnode.h>

+ Inheritance diagram for DocVhdlFlow:
+ Collaboration diagram for DocVhdlFlow:

Public Member Functions

 DocVhdlFlow (DocParser *parser, DocNodeVariant *parent)
 
void parse ()
 
bool hasCaption () const
 
- Public Member Functions inherited from DocCompoundNode
 DocCompoundNode (DocParser *parser, DocNodeVariant *parent)
 
DocNodeListchildren ()
 
const DocNodeListchildren () const
 
- Public Member Functions inherited from DocNode
 DocNode (DocParser *parser, DocNodeVariant *parent)
 
 ~DocNode ()=default
 
DocNodeVariantparent ()
 
const DocNodeVariantparent () const
 
DocNodeVariantthisVariant ()
 
const DocNodeVariantthisVariant () const
 
void setThisVariant (DocNodeVariant *thisVariant)
 
DocParserparser ()
 
const DocParserparser () const
 
void setParent (DocNodeVariant *parent)
 
bool isPreformatted () const
 

Additional Inherited Members

- Protected Types inherited from DocNode
enum  RefType { Unknown , Anchor , Section , Table }
 
- Protected Member Functions inherited from DocNode
void setInsidePreformatted (bool p)
 

Detailed Description

Node representing a VHDL flow chart.

Definition at line 728 of file docnode.h.

Constructor & Destructor Documentation

◆ DocVhdlFlow()

DocVhdlFlow::DocVhdlFlow ( DocParser * parser,
DocNodeVariant * parent )

Definition at line 1212 of file docnode.cpp.

1213{
1214}
DocCompoundNode(DocParser *parser, DocNodeVariant *parent)
Definition docnode.h:140
DocParser * parser()
Definition docnode.h:97
DocNodeVariant * parent()
Definition docnode.h:89

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

Member Function Documentation

◆ hasCaption()

bool DocVhdlFlow::hasCaption ( ) const
inline

Definition at line 733 of file docnode.h.

733{ return !children().empty(); }
DocNodeList & children()
Definition docnode.h:142
bool empty() const
checks whether the container is empty
Definition growvector.h:140

References DocCompoundNode::children(), and GrowVector< T >::empty().

Referenced by HtmlDocVisitor::operator()().

◆ parse()

void DocVhdlFlow::parse ( )

Definition at line 1216 of file docnode.cpp.

1217{
1218 AUTO_TRACE();
1219 auto ns = AutoNodeStack(parser(),thisVariant());
1220
1222 Token tok = parser()->tokenizer.lex();
1223 while (!tok.is_any_of(TokenRetval::TK_NONE, TokenRetval::TK_EOF))
1224 {
1225 if (!parser()->defaultHandleToken(thisVariant(),tok,children()))
1226 {
1227 parser()->errorHandleDefaultToken(thisVariant(),tok,children(),"\\vhdlflow");
1228 }
1229 tok = parser()->tokenizer.lex();
1230 }
1231 parser()->tokenizer.lex();
1232
1235
1236 VhdlDocGen::createFlowChart(parser()->context.memberDef);
1237}
DocNodeVariant * thisVariant()
Definition docnode.h:92
DocTokenizer tokenizer
void handlePendingStyleCommands(DocNodeVariant *parent, DocNodeList &children)
void errorHandleDefaultToken(DocNodeVariant *parent, Token tok, DocNodeList &children, const QCString &txt)
void setStateTitle()
void setStatePara()
bool is_any_of(ARGS... args) const
static void createFlowChart(const MemberDef *)
#define AUTO_TRACE(...)
Definition docnode.cpp:46

References AUTO_TRACE, DocCompoundNode::children(), VhdlDocGen::createFlowChart(), DocParser::errorHandleDefaultToken(), DocParser::handlePendingStyleCommands(), Token::is_any_of(), DocTokenizer::lex(), DocNode::parser(), DocTokenizer::setStatePara(), DocTokenizer::setStateTitle(), DocNode::thisVariant(), and DocParser::tokenizer.


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