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

This class contains the information about the argument of a function or template. More...

#include <src/arguments.h>

Collaboration diagram for Argument:

Public Member Functions

bool hasDocumentation (bool allowEmptyName=false) const
bool hasTemplateDocumentation () const

Public Attributes

DString attrib
DString type
DString canType
DString name
DString array
DString defval
DString docs
DString typeConstraint

Detailed Description

This class contains the information about the argument of a function or template.

Definition at line 26 of file arguments.h.

Member Function Documentation

◆ hasDocumentation()

bool Argument::hasDocumentation ( bool allowEmptyName = false) const
inline

return true if this argument is documentation and the argument has a non empty name.

Definition at line 32 of file arguments.h.

33 {
34 return (allowEmptyName || !name.empty()) && !docs.empty();
35 }
Argument::docs
DString docs
Definition arguments.h:48
Argument::name
DString name
Definition arguments.h:45
DString::empty
bool empty() const
Returns true iff the string is empty (std::string compatible alias for isEmpty()).
Definition dstring.h:152

References docs, DString::empty(), and name.

Referenced by generateXMLForMember(), and ArgumentList::hasDocumentation().

◆ hasTemplateDocumentation()

bool Argument::hasTemplateDocumentation ( ) const
inline

Definition at line 37 of file arguments.h.

38 {
39 return (!name.empty() || !type.empty()) && !docs.empty();
40 }
Argument::type
DString type
Definition arguments.h:43

References docs, DString::empty(), name, and type.

Referenced by ArgumentList::hasTemplateDocumentation().

Member Data Documentation

◆ array

DString Argument::array

Argument's array specifier (may be empty)

Definition at line 46 of file arguments.h.

Referenced by argListToString(), extractCanonicalArgType(), substituteTemplatesInArgList(), and writeDefArgumentList().

◆ attrib

DString Argument::attrib

Argument's attribute (IDL only)

Definition at line 42 of file arguments.h.

Referenced by VHDLOutlineParser::addProto(), argListToString(), and writeDefArgumentList().

◆ canType

DString Argument::canType

Cached value of canonical type (after type resolution). Empty initially.

Definition at line 44 of file arguments.h.

Referenced by argListToString(), and matchArgument2().

◆ defval

DString Argument::defval

Argument's default value (may be empty)

Definition at line 47 of file arguments.h.

Referenced by MemberDefImpl::_writeTemplatePrefix(), VHDLOutlineParser::addProto(), argListToString(), isVarWithConstructor(), mergeArguments(), substituteTemplateArgumentsInString(), writeDefArgumentList(), and ClassDefImpl::writeTemplateSpec().

◆ docs

DString Argument::docs

Argument's documentation (may be empty)

Definition at line 48 of file arguments.h.

Referenced by addKnRArgInfo(), MemberDefImpl::copyArgumentNames(), MemberDefImpl::detectUndocumentedParams(), generateXMLForMember(), handleParametersCommentBlocks(), hasDocumentation(), hasTemplateDocumentation(), mergeArguments(), transferArgumentDocumentation(), and updateVariablePrepassComment().

◆ name

DString Argument::name

Argument's name (may be empty)

Definition at line 45 of file arguments.h.

Referenced by MemberDefImpl::_writeTemplatePrefix(), addKnRArgInfo(), VHDLOutlineParser::addProto(), addSTLClass(), argListToString(), anonymous_namespace{tagreader.cpp}::TagFileParser::buildClassEntry(), checkForKnRstyleC(), MemberDefImpl::copyArgumentNames(), VHDLOutlineParser::createFunction(), MemberDefImpl::detectUndocumentedParams(), endScope(), extractCanonicalArgType(), findArgument(), fixArgumentListForJavaScript(), generateDEFForMember(), PerlModGenerator::generatePerlModForMember(), generateXMLForMember(), getParameter(), handleParametersCommentBlocks(), hasDocumentation(), hasTemplateDocumentation(), insertMemberFunctionParams(), isVarWithConstructor(), matchArgument2(), mergeArguments(), MemberDefImpl::resolveUnnamedParameters(), substituteTemplateArgumentsInString(), substituteTemplatesInString(), transferArgumentDocumentation(), writeDefArgumentList(), and ClassDefImpl::writeTemplateSpec().

◆ type

DString Argument::type

Argument's type

Definition at line 43 of file arguments.h.

Referenced by MemberDefImpl::_writeTemplatePrefix(), addKnRArgInfo(), VHDLOutlineParser::addProto(), addSTLClass(), applyModifiers(), argListToString(), anonymous_namespace{tagreader.cpp}::TagFileParser::buildClassEntry(), checkForKnRstyleC(), computeTemplateClassRelations(), MemberDefImpl::detectUndocumentedParams(), endScope(), extractCanonicalArgType(), findArgument(), fixArgumentListForJavaScript(), PerlModGenerator::generatePerlModForMember(), generateXMLForMember(), handleParametersCommentBlocks(), hasTemplateDocumentation(), MemberDefImpl::isBriefSectionVisible(), isVarWithConstructor(), matchArgument2(), matchArguments2(), matchTemplateArguments(), mergeArguments(), substituteTemplateArgumentsInString(), substituteTemplatesInArgList(), substituteTemplatesInString(), writeDefArgumentList(), and ClassDefImpl::writeTemplateSpec().

◆ typeConstraint

DString Argument::typeConstraint

Used for Java generics: <T extends C>

Definition at line 49 of file arguments.h.

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