Skip to main content

The DocParamSect Class Reference

Node representing a parameter section. More...

Declaration​

class DocParamSect { ... }

Included Headers​

#include <src/docnode.h>

Base class​

classDocCompoundNode

Base class for nodes with children. More...

Enumerations Index​

enumType { ... }
enumDirection { ... }

Friends Index​

classDocParamList

Public Constructors Index​

DocParamSect (DocParser *parser, DocNodeVariant *parent, Type t)

Public Member Functions Index​

Tokenparse (const QCString &cmdName, bool xmlContext, Direction d)
Typetype () const
boolhasInOutSpecifier () const
boolhasTypeSpecifier () const

Private Member Attributes Index​

Typem_type = Unknown
boolm_hasInOutSpecifier = false
boolm_hasTypeSpecifier = false

Description​

Node representing a parameter section.

Definition at line 1052 of file docnode.h.

Enumerations​

Direction​

enum DocParamSect::Direction
Enumeration values
In (=1)
Out (=2)
InOut (=3)
Unspecified (=0)

Definition at line 1060 of file docnode.h.

1061 {
1062 In=1, Out=2, InOut=3, Unspecified=0
1063 };

Type​

enum DocParamSect::Type
Enumeration values
Unknown
Param
RetVal
Exception
TemplateParam

Definition at line 1056 of file docnode.h.

1057 {
1058 Unknown, Param, RetVal, Exception, TemplateParam
1059 };

Friends​

DocParamList​

friend class DocParamList

Definition at line 1054 of file docnode.h.

1054 friend class DocParamList;

Reference DocParamList.

Referenced by DocParamList and parse.

Public Constructors​

DocParamSect()​

DocParamSect::DocParamSect (DocParser * parser, DocNodeVariant * parent, Type t)
 inline

Definition at line 1064 of file docnode.h.

1064 DocParamSect(DocParser *parser,DocNodeVariant *parent,Type t)
1065 : DocCompoundNode(parser,parent), m_type(t), m_hasInOutSpecifier(FALSE), m_hasTypeSpecifier(FALSE)
1066 {}

References DocCompoundNode::DocCompoundNode, FALSE, m_hasInOutSpecifier, m_hasTypeSpecifier, m_type, DocNode::parent and DocNode::parser.

Public Member Functions​

hasInOutSpecifier()​

bool DocParamSect::hasInOutSpecifier ()
 inline

Definition at line 1069 of file docnode.h.

1069 bool hasInOutSpecifier() const { return m_hasInOutSpecifier; }

Reference m_hasInOutSpecifier.

Referenced by DocbookDocVisitor::operator(), DocbookDocVisitor::operator(), HtmlDocVisitor::operator(), LatexDocVisitor::operator(), LatexDocVisitor::operator(), PerlModDocVisitor::operator() and RTFDocVisitor::operator().

hasTypeSpecifier()​

bool DocParamSect::hasTypeSpecifier ()
 inline

Definition at line 1070 of file docnode.h.

1070 bool hasTypeSpecifier() const { return m_hasTypeSpecifier; }

Reference m_hasTypeSpecifier.

Referenced by DocbookDocVisitor::operator(), DocbookDocVisitor::operator(), HtmlDocVisitor::operator(), LatexDocVisitor::operator(), LatexDocVisitor::operator() and RTFDocVisitor::operator().

parse()​

Token DocParamSect::parse (const QCString & cmdName, bool xmlContext, Direction d)

Declaration at line 1067 of file docnode.h, definition at line 3295 of file docnode.cpp.

3295Token DocParamSect::parse(const QCString &cmdName,bool xmlContext, Direction d)
3296{
3297 AUTO_TRACE();
3298 Token retval = Token::make_RetVal_OK();
3299 auto ns = AutoNodeStack(parser(),thisVariant());
3300
3301 if (d!=Unspecified)
3302 {
3303 m_hasInOutSpecifier=TRUE;
3304 }
3305
3306 if (!children().empty() && std::holds_alternative<DocParamList>(children().back()))
3307 {
3308 DocParamList &lastPl = std::get<DocParamList>(children().back());
3309 lastPl.markLast(false);
3310 }
3311 bool markFirst = children().empty();
3312 children().append<DocParamList>(parser(),thisVariant(),m_type,d);
3313 DocParamList *pl = children().get_last<DocParamList>();
3314 if (markFirst)
3315 {
3316 pl->markFirst();
3317 }
3318 pl->markLast();
3319 if (xmlContext)
3320 {
3321 retval = pl->parseXml(cmdName);
3322 }
3323 else
3324 {
3325 retval = pl->parse(cmdName);
3326 }
3327 if (retval.is(TokenRetval::RetVal_EndParBlock))
3328 {
3329 retval = Token::make_RetVal_OK();
3330 }
3331
3332 AUTO_TRACE_EXIT("retval={}",retval.to_string());
3333 return retval;
3334}

References DocNodeList::append, AUTO_TRACE, AUTO_TRACE_EXIT, DocCompoundNode::children, DocParamList, GrowVector< T >::empty, DocNodeList::get_last, Token::is, m_hasInOutSpecifier, m_type, DocParamList::markLast, DocNode::parser, DocNode::thisVariant, Token::to_string, TRUE and Unspecified.

Referenced by DocPara::handleParamSection.

type()​

Type DocParamSect::type ()
 inline

Definition at line 1068 of file docnode.h.

1068 Type type() const { return m_type; }

Reference m_type.

Referenced by DocPara::handleParamSection, DocbookDocVisitor::operator(), HtmlDocVisitor::operator(), LatexDocVisitor::operator(), LatexDocVisitor::operator(), ManDocVisitor::operator(), PerlModDocVisitor::operator(), PrintDocVisitor::operator(), RTFDocVisitor::operator(), RTFDocVisitor::operator() and XmlDocVisitor::operator().

Private Member Attributes​

m_hasInOutSpecifier​

bool DocParamSect::m_hasInOutSpecifier = false

Definition at line 1074 of file docnode.h.

1074 bool m_hasInOutSpecifier = false;

Referenced by DocParamSect, hasInOutSpecifier and parse.

m_hasTypeSpecifier​

bool DocParamSect::m_hasTypeSpecifier = false

Definition at line 1075 of file docnode.h.

1075 bool m_hasTypeSpecifier = false;

Referenced by DocParamSect and hasTypeSpecifier.

m_type​

Type DocParamSect::m_type = Unknown

Definition at line 1073 of file docnode.h.

1073 Type m_type = Unknown;

Referenced by DocParamSect, parse and type.

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

Generated via doxygen2docusaurus by Doxygen 1.14.0.