The Argument Struct Reference

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

Declaration

struct Argument { ... }

Included Headers

#include <src/arguments.h>

Public Member Functions Index

bool	hasDocumentation () const
bool	hasTemplateDocumentation () const

Public Member Attributes Index

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

Description

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

Definition at line 26 of file arguments.h.

Public Member Functions

hasDocumentation()

bool Argument::hasDocumentation ()

inline

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

Definition at line 31 of file arguments.h.

31 bool hasDocumentation() const

32 {

33 return !name.isEmpty() && !docs.isEmpty();

34 }

References docs and name.

Referenced by generateXMLForMember and ArgumentList::hasDocumentation.

hasTemplateDocumentation()

bool Argument::hasTemplateDocumentation ()

inline

Definition at line 36 of file arguments.h.

36 bool hasTemplateDocumentation() const

37 {

38 return (!name.isEmpty() || !type.isEmpty()) && !docs.isEmpty();

39 }

References docs, name and type.

Referenced by ArgumentList::hasTemplateDocumentation.

Public Member Attributes

array

QCString Argument::array

Argument's array specifier (may be empty)

Definition at line 45 of file arguments.h.

45 QCString array; /*!< Argument's array specifier (may be empty) */

Referenced by argListToString, extractCanonicalArgType, substituteTemplatesInArgList and writeDefArgumentList.

attrib

QCString Argument::attrib

Argument's attribute (IDL only)

Definition at line 41 of file arguments.h.

41 QCString attrib; /*!< Argument's attribute (IDL only) */

Referenced by VHDLOutlineParser::addProto, argListToString and writeDefArgumentList.

canType

QCString Argument::canType

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

Definition at line 43 of file arguments.h.

43 QCString canType; /*!< Cached value of canonical type (after type resolution). Empty initially. */

Referenced by argListToString and matchArgument2.

defval

QCString Argument::defval

Argument's default value (may be empty)

Definition at line 46 of file arguments.h.

46 QCString defval; /*!< Argument's default value (may be empty) */

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

docs

QCString Argument::docs

Argument's documentation (may be empty)

Definition at line 47 of file arguments.h.

47 QCString docs; /*!< Argument's documentation (may be empty) */

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

name

QCString Argument::name

Argument's name (may be empty)

Definition at line 44 of file arguments.h.

44 QCString name; /*!< Argument's name (may be empty) */

Referenced by MemberDefImpl::_writeTemplatePrefix, addKnRArgInfo, VHDLOutlineParser::addProto, addSTLClass, argListToString, anonymous{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

QCString Argument::type

Argument's type

Definition at line 42 of file arguments.h.

42 QCString type; /*!< Argument's type */

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

typeConstraint

QCString Argument::typeConstraint

Used for Java generics: <T extends C>

Definition at line 48 of file arguments.h.

48 QCString typeConstraint; /*!< Used for Java generics: \<T extends C\> */

---

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

• arguments.h

---

Generated via doxygen2docusaurus by Doxygen 1.14.0.