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 () const

Public Attributes
QCString	attrib

QCString	type

QCString	canType

QCString	name

QCString	array

QCString	defval

QCString	docs

QCString	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 ( ) const

inline

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

Definition at line 31 of file arguments.h.

  {
    return !name.isEmpty() && !docs.isEmpty();
  }

References docs, and name.

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

Member Data Documentation

◆ array

QCString Argument::array

Argument's array specifier (may be empty)

Definition at line 40 of file arguments.h.

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

◆ attrib

QCString Argument::attrib

Argument's attribute (IDL only)

Definition at line 36 of file arguments.h.

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

◆ canType

QCString Argument::canType

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

Definition at line 38 of file arguments.h.

Referenced by argListToString(), and matchArgument2().

◆ defval

QCString Argument::defval

Argument's default value (may be empty)

Definition at line 41 of file arguments.h.

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 42 of file arguments.h.

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

◆ name

QCString Argument::name

Argument's name (may be empty)

Definition at line 39 of file arguments.h.

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

◆ type

QCString Argument::type

Argument's type

Definition at line 37 of file arguments.h.

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

◆ typeConstraint

QCString Argument::typeConstraint

Used for Java generics: <T extends C>

Definition at line 43 of file arguments.h.

Referenced by ClassDefImpl::addTypeConstraints().

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

src/arguments.h

Public Member Functions

Public Attributes