Argument Struct Reference

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

#include <entry.h>

List of all members.

Public Member Functions

 Argument ()
 Argument (const Argument &a)
Argumentoperator= (const Argument &a)
bool hasDocumentation () const

Public Attributes

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


Detailed Description

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

Definition at line 59 of file entry.h.


Constructor & Destructor Documentation

Argument::Argument (  )  [inline]

Construct a new argument.

Definition at line 62 of file entry.h.

Argument::Argument ( const Argument a  )  [inline]

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

Definition at line 64 of file entry.h.

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


Member Function Documentation

Argument& Argument::operator= ( const Argument a  )  [inline]

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

Definition at line 74 of file entry.h.

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

bool Argument::hasDocumentation (  )  const [inline]

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

Definition at line 90 of file entry.h.

References docs, and name.

Referenced by MemberDef::writeDocumentation().


Member Data Documentation

QCString Argument::attrib

Argument's attribute (IDL only)

Definition at line 95 of file entry.h.

Referenced by argListToString(), Argument(), VhdlDocGen::convertArgumentListToString(), VhdlDocGen::findFunction(), generateDEFForMember(), PerlModGenerator::generatePerlModForMember(), marshalArgumentList(), operator=(), VHDLLanguageScanner::parsePrototype(), VhdlDocGen::writeFuncProcDocu(), and VhdlDocGen::writeProcedureProto().

QCString Argument::type

Argument's type

Definition at line 96 of file entry.h.

Referenced by argListToString(), Argument(), VhdlDocGen::convertArgumentListToString(), VhdlDocGen::findFunction(), fixArgumentListForJavaScript(), generateDEFForMember(), PerlModGenerator::generatePerlModForMember(), marshalArgumentList(), mergeArguments(), operator=(), VHDLLanguageScanner::parsePrototype(), substituteTemplateArgumentsInString(), tempArgListToString(), VhdlDocGen::writeFuncProcDocu(), VhdlDocGen::writeFunctionProto(), VhdlDocGen::writeProcedureProto(), and writeTypeConstraints().

QCString Argument::canType

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

Definition at line 97 of file entry.h.

Referenced by argListToString(), and marshalArgumentList().

QCString Argument::name

Argument's name (may be empty)

Definition at line 98 of file entry.h.

Referenced by argListToString(), Argument(), VhdlDocGen::convertArgumentListToString(), MemberDef::copyArgumentNames(), fixArgumentListForJavaScript(), generateDEFForMember(), PerlModGenerator::generatePerlModForMember(), hasDocumentation(), marshalArgumentList(), mergeArguments(), operator=(), VHDLLanguageScanner::parsePrototype(), substituteTemplateArgumentsInString(), tempArgListToString(), MemberDef::writeDocumentation(), ClassDef::writeDocumentation(), VhdlDocGen::writeFuncProcDocu(), VhdlDocGen::writeFunctionProto(), VhdlDocGen::writeProcedureProto(), VhdlDocGen::writeProcessProto(), and writeTypeConstraints().

QCString Argument::array

Argument's array specifier (may be empty)

Definition at line 99 of file entry.h.

Referenced by argListToString(), Argument(), generateDEFForMember(), PerlModGenerator::generatePerlModForMember(), marshalArgumentList(), and operator=().

QCString Argument::defval

Argument's default value (may be empty)

Definition at line 100 of file entry.h.

Referenced by argListToString(), Argument(), VhdlDocGen::convertArgumentListToString(), generateDEFForMember(), PerlModGenerator::generatePerlModForMember(), marshalArgumentList(), mergeArguments(), operator=(), substituteTemplateArgumentsInString(), VhdlDocGen::writeFuncProcDocu(), VhdlDocGen::writeFunctionProto(), and VhdlDocGen::writeProcedureProto().

QCString Argument::docs

Argument's documentation (may be empty)

Definition at line 101 of file entry.h.

Referenced by Argument(), hasDocumentation(), marshalArgumentList(), mergeArguments(), operator=(), MemberDef::writeDocumentation(), and writeTypeConstraints().


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



Generated on Mon Mar 31 10:58:56 2008 by  doxygen 1.5.1