Argument结构体 参考

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

#include <arguments.h>

Argument 的协作图:

Public 成员函数
bool	hasDocumentation () const

Public 属性
QCString	attrib
QCString	type
QCString	canType
QCString	name
QCString	array
QCString	defval
QCString	docs
QCString	typeConstraint

详细描述

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

在文件 arguments.h 第 26 行定义.

成员函数说明

hasDocumentation()

bool Argument::hasDocumentation ( ) const

inline

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

在文件 arguments.h 第 44 行定义.

{

被这些函数引用 generateXMLForMember() , 以及 ArgumentList::hasDocumentation().

类成员变量说明

array

QCString Argument::array

Argument's array specifier (may be empty)

在文件 arguments.h 第 53 行定义.

被这些函数引用 argListToString(), ArgumentContext::Private::array(), extractCanonicalArgType(), substituteTemplatesInArgList() , 以及 writeDefArgumentList().

attrib

QCString Argument::attrib

Argument's attribute (IDL only)

在文件 arguments.h 第 49 行定义.

被这些函数引用 VHDLOutlineParser::addProto(), argListToString(), ArgumentContext::Private::attrib(), ArgumentContext::Private::namePart() , 以及 writeDefArgumentList().

canType

QCString Argument::canType

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

在文件 arguments.h 第 51 行定义.

被这些函数引用 argListToString() , 以及 matchArgument2().

defval

QCString Argument::defval

Argument's default value (may be empty)

在文件 arguments.h 第 54 行定义.

被这些函数引用 MemberDefImpl::_writeTemplatePrefix(), VHDLOutlineParser::addProto(), argListToString(), ArgumentContext::Private::createDefval(), isVarWithConstructor(), mergeArguments(), substituteTemplateArgumentsInString(), writeDefArgumentList() , 以及 ClassDefImpl::writeTemplateSpec().

docs

QCString Argument::docs

Argument's documentation (may be empty)

在文件 arguments.h 第 55 行定义.

被这些函数引用 MemberDefImpl::copyArgumentNames(), ArgumentContext::Private::createDocs(), MemberDefImpl::detectUndocumentedParams(), generateXMLForMember(), mergeArguments() , 以及 transferArgumentDocumentation().

name

QCString Argument::name

Argument's name (may be empty)

在文件 arguments.h 第 52 行定义.

被这些函数引用 MemberDefImpl::_writeTemplatePrefix(), VHDLOutlineParser::addProto(), addSTLClass(), argListToString(), TagFileParser::buildLists(), MemberDefImpl::copyArgumentNames(), VHDLOutlineParser::createFunction(), MemberDefImpl::detectUndocumentedParams(), extractCanonicalArgType(), generateDEFForMember(), PerlModGenerator::generatePerlModForMember(), generateXMLForMember(), isVarWithConstructor(), matchArgument2(), mergeArguments(), ArgumentContext::Private::name(), MemberDefImpl::resolveUnnamedParameters(), substituteTemplateArgumentsInString(), substituteTemplatesInString(), transferArgumentDocumentation(), writeDefArgumentList(), ClassDefImpl::writeTagFile() , 以及 ClassDefImpl::writeTemplateSpec().

type

QCString Argument::type

Argument's type

在文件 arguments.h 第 50 行定义.

被这些函数引用 MemberDefImpl::_writeTemplatePrefix(), VHDLOutlineParser::addProto(), addSTLClass(), ClassDefImpl::addTypeConstraints(), argListToString(), TagFileParser::buildLists(), computeTemplateClassRelations(), ArgumentContext::Private::createType(), MemberDefImpl::detectUndocumentedParams(), extractCanonicalArgType(), MemberDefImpl::isBriefSectionVisible(), isVarWithConstructor(), matchArgument2(), matchArguments2(), mergeArguments(), substituteTemplateArgumentsInString(), substituteTemplatesInArgList(), substituteTemplatesInString(), writeDefArgumentList(), ClassDefImpl::writeTagFile() , 以及 ClassDefImpl::writeTemplateSpec().

typeConstraint

QCString Argument::typeConstraint

Used for Java generics: <T extends C>

在文件 arguments.h 第 56 行定义.

被这些函数引用 ClassDefImpl::addTypeConstraints().

---

该结构体的文档由以下文件生成:

• src/arguments.h