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.

  {
    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.

  {
    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.

  {
    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.

QCString Argument::attrib

Argument's attribute (IDL only)

Definition at line 66 of file arguments.h.

QCString Argument::canType

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

Definition at line 68 of file arguments.h.

QCString Argument::defval

Argument's default value (may be empty)

Definition at line 71 of file arguments.h.

QCString Argument::docs

Argument's documentation (may be empty)

Definition at line 72 of file arguments.h.

QCString Argument::name

Argument's name (may be empty)

Definition at line 69 of file arguments.h.

QCString Argument::type

Argument's type

Definition at line 67 of file arguments.h.

QCString Argument::typeConstraint

Used for Java generics: <T extends C>

Definition at line 73 of file arguments.h.

---

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

• doxygen-1.8.11/src/arguments.h