My Project: Argument Struct Reference

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

#include <arguments.h>

Public Member Functions
	Argument ()

	Argument (const Argument &a)

Argument &	operator= (const Argument &a)

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

Constructor & Destructor Documentation

Argument::Argument ( )

inline

Construct a new argument.

Definition at line 31 of file arguments.h.

{}

Argument::Argument ( const Argument & a )

inline

Copy an argument (does a deep copy of all strings).

Definition at line 33 of file arguments.h.

References array, attrib, defval, docs, name, type, and typeConstraint.

  {
    attrib=a.attrib;
    type=a.type;
    name=a.name;
    array=a.array;
    defval=a.defval;
    docs=a.docs;
    typeConstraint=a.typeConstraint;
  }

Member Function Documentation

bool Argument::hasDocumentation ( ) const

inline

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

Definition at line 61 of file arguments.h.

References docs, and name.

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

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

Argument& Argument::operator= ( const Argument & a )

inline

Assignment of an argument (does a deep copy of all strings).

Definition at line 44 of file arguments.h.

References array, attrib, defval, docs, name, type, and typeConstraint.

  {
    if (this!=&a)
    {
      attrib=a.attrib;
      type=a.type;
      name=a.name;
      array=a.array;
      defval=a.defval;
      docs=a.docs;
      typeConstraint=a.typeConstraint;
    }
    return *this;
  }

Member Data Documentation

QCString Argument::array

Argument's array specifier (may be empty)

Definition at line 70 of file arguments.h.

Referenced by argListToString(), Argument(), ArgumentContext::Private::array(), extractCanonicalArgType(), generateDEFForMember(), PerlModGenerator::generatePerlModForMember(), generateXMLForMember(), ArgumentList::marshal(), matchArgument(), operator=(), substituteTemplatesInArgList(), ArgumentList::unmarshal(), and writeDefArgumentList().

QCString Argument::attrib

QCString Argument::canType

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

Definition at line 68 of file arguments.h.

Referenced by argListToString(), invalidateCachedTypesInArgumentList(), ArgumentList::marshal(), matchArgument2(), and ArgumentList::unmarshal().

QCString Argument::defval

QCString Argument::docs

Argument's documentation (may be empty)

Definition at line 72 of file arguments.h.

Referenced by Argument(), checkUndocumentedParams(), detectNoDocumentedParams(), ArgumentContext::Private::docs(), generateXMLForMember(), hasDocumentation(), ArgumentList::marshal(), mergeArguments(), operator=(), transferArgumentDocumentation(), ArgumentList::unmarshal(), MemberDef::writeDocumentation(), and writeTypeConstraints().

QCString Argument::name

Argument's name (may be empty)

Definition at line 69 of file arguments.h.

Referenced by addSTLClasses(), addTemplateArgumentList(), FlowChart::alignFuncProc(), argListToString(), Argument(), TagFileParser::buildLists(), checkArgumentName(), checkUndocumentedParams(), VhdlDocGen::convertArgumentListToString(), MemberDef::copyArgumentNames(), detectNoDocumentedParams(), extractCanonicalArgType(), generateDEFForMember(), generateDocbookForMember(), PerlModGenerator::generatePerlModForMember(), generateXMLForMember(), getTemplateArgumentsInName(), hasDocumentation(), isVarWithConstructor(), ArgumentList::marshal(), matchArgument(), matchArgument2(), mergeArguments(), ArgumentContext::Private::name(), normalizeNonTemplateArgumentsInString(), operator=(), substituteTemplateArgumentsInString(), substituteTemplatesInString(), tempArgListToString(), ArgumentList::unmarshal(), writeDefArgumentList(), MemberDef::writeDocumentation(), VhdlDocGen::writeFuncProcDocu(), VhdlDocGen::writeFunctionProto(), VhdlDocGen::writeProcedureProto(), VhdlDocGen::writeProcessProto(), ClassDef::writeTagFile(), writeTemplateArgumentList(), writeTemplatePrefix(), writeTemplateSpec(), and writeTypeConstraints().

QCString Argument::type

Argument's type

Definition at line 67 of file arguments.h.

Referenced by addSTLClasses(), addTemplateArgumentList(), ClassDef::addTypeConstraints(), FlowChart::alignFuncProc(), argListToString(), Argument(), TagFileParser::buildLists(), checkArgumentName(), checkUndocumentedParams(), computeTemplateClassRelations(), VhdlDocGen::convertArgumentListToString(), MemberDef::createTemplateInstanceMember(), detectNoDocumentedParams(), extractCanonicalArgType(), VhdlDocGen::findFunction(), generateDEFForMember(), generateDocbookForMember(), PerlModGenerator::generatePerlModForMember(), generateXMLForMember(), isVarWithConstructor(), ArgumentList::marshal(), matchArgument(), matchArgument2(), matchArguments(), matchArguments2(), mergeArguments(), operator=(), substituteTemplateArgumentsInString(), substituteTemplatesInArgList(), tempArgListToString(), ArgumentContext::Private::type(), ArgumentList::unmarshal(), writeDefArgumentList(), VhdlDocGen::writeFuncProcDocu(), VhdlDocGen::writeFunctionProto(), VhdlDocGen::writeProcedureProto(), writeTemplateArgumentList(), writeTemplatePrefix(), writeTemplateSpec(), and writeTypeConstraints().

QCString Argument::typeConstraint

Used for Java generics: <T extends C>

Definition at line 73 of file arguments.h.

Referenced by ClassDef::addTypeConstraints(), Argument(), ArgumentList::marshal(), operator=(), tempArgListToString(), ArgumentList::unmarshal(), and writeTemplateArgumentList().

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

arguments.h