ArgumentList类 参考

This class represents an function or template argument list. 更多...

#include <arguments.h>

ArgumentList 的协作图:

Public 类型
using	Vec = std::vector< Argument >
using	iterator = typename Vec::iterator
using	const_iterator = typename Vec::const_iterator

Public 成员函数
bool	hasDocumentation () const
bool	hasParameters () const
void	reset ()
iterator	begin ()
iterator	end ()
const_iterator	begin () const
const_iterator	end () const
const_iterator	cbegin () const
const_iterator	cend () const
bool	empty () const
size_t	size () const
void	clear ()
void	push_back (const Argument &a)
Argument &	back ()
const Argument &	back () const
Argument &	front ()
const Argument &	front () const
Argument &	at (size_t i)
const Argument &	at (size_t i) const
bool	constSpecifier () const
bool	volatileSpecifier () const
bool	pureSpecifier () const
QCString	trailingReturnType () const
bool	isDeleted () const
RefQualifierType	refQualifier () const
bool	noParameters () const
void	setConstSpecifier (bool b)
void	setVolatileSpecifier (bool b)
void	setPureSpecifier (bool b)
void	setTrailingReturnType (const QCString &s)
void	setIsDeleted (bool b)
void	setRefQualifier (RefQualifierType t)
void	setNoParameters (bool b)

Private 属性
std::vector< Argument >	m_args
bool	m_constSpecifier = FALSE
bool	m_volatileSpecifier = FALSE
bool	m_pureSpecifier = FALSE
QCString	m_trailingReturnType
bool	m_isDeleted = FALSE
RefQualifierType	m_refQualifier = RefQualifierNone
bool	m_noParameters = FALSE

详细描述

This class represents an function or template argument list.

This class also stores some information about member that is typically put after the argument list, such as whether the member is const, volatile or pure virtual.

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

成员类型定义说明

const_iterator

using ArgumentList::const_iterator = typename Vec::const_iterator

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

iterator

using ArgumentList::iterator = typename Vec::iterator

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

Vec

using ArgumentList::Vec = std::vector<Argument>

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

成员函数说明

at() [1/2]

Argument& ArgumentList::at ( size_t  i )

inline

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

{ return m_args.at(i); }

引用了 m_args.

被这些函数引用 makeQualifiedNameWithTemplateParameters().

at() [2/2]

const Argument& ArgumentList::at ( size_t  i ) const

inline

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

{ return m_args.at(i); }

引用了 m_args.

back() [1/2]

Argument& ArgumentList::back ( )

inline

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

{ return m_args.back(); }

引用了 m_args.

back() [2/2]

const Argument& ArgumentList::back ( ) const

inline

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

{ return m_args.back(); }

引用了 m_args.

begin() [1/2]

iterator ArgumentList::begin ( )

inline

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

{ return m_args.begin(); }

引用了 m_args.

被这些函数引用 MemberDefImpl::_writeTemplatePrefix(), argListToString(), MemberDefImpl::copyArgumentNames(), MemberDefImpl::detectUndocumentedParams(), generateDEFForMember(), PerlModGenerator::generatePerlModForMember(), generateXMLForMember(), hasDocumentation(), matchArguments2(), mergeArguments(), MemberDefImpl::resolveUnnamedParameters(), substituteTemplateArgumentsInString(), substituteTemplatesInArgList(), substituteTemplatesInString(), transferArgumentDocumentation() , 以及 writeDefArgumentList().

begin() [2/2]

const_iterator ArgumentList::begin ( ) const

inline

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

{ return m_args.cbegin(); }

引用了 m_args.

cbegin()

const_iterator ArgumentList::cbegin ( ) const

inline

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

{ return m_args.cbegin(); }

引用了 m_args.

cend()

const_iterator ArgumentList::cend ( ) const

inline

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

{ return m_args.cend();   }

引用了 m_args.

clear()

void ArgumentList::clear ( )

inline

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

{ m_args.clear(); }

引用了 m_args.

被这些函数引用 reset().

constSpecifier()

bool ArgumentList::constSpecifier ( ) const

inline

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

{ return m_constSpecifier; }

引用了 m_constSpecifier.

被这些函数引用 argListToString(), PerlModGenerator::generatePerlModForMember(), generateXMLForMember(), MemberContext::Private::hasConstQualifier(), matchArguments2() , 以及 writeDefArgumentList().

empty()

bool ArgumentList::empty ( ) const

inline

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

{ return m_args.empty(); }

引用了 m_args.

被这些函数引用 addClassToContext(), addMemberFunction(), ClassContext::Private::addTemplateDecls(), DocParser::checkArgumentName(), DocParser::checkUnOrMultipleDocumentedParams(), computeTemplateClassRelations(), MemberContext::Private::createTemplateArgs(), MemberContext::Private::createTemplateDecls(), ConceptContext::Private::createTemplateDecls(), MemberDefImpl::createTemplateInstanceMember(), ClassContext::Private::createTypeConstraints(), MemberContext::Private::createTypeConstraints(), MemberDefImpl::detectUndocumentedParams(), findGlobalMember(), PerlModGenerator::generatePerlModForMember(), generateXMLForMember(), getTemplateArgumentsFromName(), hasParameters(), MemberContext::Private::hasParameters(), insertTemplateSpecifierInScope(), MemberDefImpl::isBriefSectionVisible(), ClassDefImpl::isTemplate(), isVarWithConstructor(), makeQualifiedNameWithTemplateParameters(), matchArguments2(), searchTemplateSpecs(), substituteTemplateArgumentsInString(), tempArgListToString(), ClassDefImpl::title(), MemberDefImpl::writeDeclaration(), MemberDefImpl::writeDocumentation() , 以及 writeTypeConstraints().

end() [1/2]

iterator ArgumentList::end ( )

inline

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

{ return m_args.end();   }

引用了 m_args.

被这些函数引用 MemberDefImpl::_writeTemplatePrefix(), argListToString(), MemberDefImpl::copyArgumentNames(), MemberDefImpl::detectUndocumentedParams(), generateDEFForMember(), PerlModGenerator::generatePerlModForMember(), generateXMLForMember(), hasDocumentation(), matchArguments2(), mergeArguments(), MemberDefImpl::resolveUnnamedParameters(), substituteTemplateArgumentsInString(), substituteTemplatesInArgList(), substituteTemplatesInString(), transferArgumentDocumentation() , 以及 writeDefArgumentList().

end() [2/2]

const_iterator ArgumentList::end ( ) const

inline

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

{ return m_args.cend();   }

引用了 m_args.

front() [1/2]

Argument& ArgumentList::front ( )

inline

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

{ return m_args.front(); }

引用了 m_args.

被这些函数引用 MemberDefImpl::isBriefSectionVisible() , 以及 matchArguments2().

front() [2/2]

const Argument& ArgumentList::front ( ) const

inline

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

{ return m_args.front(); }

引用了 m_args.

hasDocumentation()

bool ArgumentList::hasDocumentation

(

)

const

Does any argument of this list have documentation?

the argument list is documented if one of its arguments is documented

在文件 arguments.cpp 第 21 行定义.

{
  return std::any_of(begin(),end(),[](const Argument &a){ return a.hasDocumentation(); });
}

引用了 begin(), end() , 以及 Argument::hasDocumentation().

被这些函数引用 MemberContext::Private::createParamDocs(), MemberDefImpl::hasDetailedDescription(), MemberDefImpl::hasDocumentation() , 以及 MemberDefImpl::writeDocumentation().

hasParameters()

bool ArgumentList::hasParameters ( ) const

inline

Does this list have zero or more parameters

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

    {
      return !empty() || m_noParameters;
    }

引用了 empty() , 以及 m_noParameters.

被这些函数引用 MemberDefImpl::_writeTypeConstraints(), addMemberFunction(), addTemplateArgumentList(), argListToString(), combineDeclarationAndDefinition(), MemberDefImpl::detectUndocumentedParams(), generateXMLForMember(), MemberDefImpl::hasDetailedDescription(), MemberDefImpl::setAnchor(), MemberDefImpl::writeDeclaration(), writeDefArgumentList(), MemberDefImpl::writeDocumentation(), VhdlDocGen::writeFunctionProto(), VhdlDocGen::writeProcessProto(), writeTemplateArgumentList() , 以及 VhdlDocGen::writeVHDLDeclaration().

isDeleted()

bool ArgumentList::isDeleted ( ) const

inline

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

{ return m_isDeleted; }

引用了 m_isDeleted.

被这些函数引用 MemberDefImpl::isDeleted().

noParameters()

bool ArgumentList::noParameters ( ) const

inline

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

{ return m_noParameters; }

引用了 m_noParameters.

pureSpecifier()

bool ArgumentList::pureSpecifier ( ) const

inline

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

{ return m_pureSpecifier; }

引用了 m_pureSpecifier.

被这些函数引用 argListToString().

push_back()

void ArgumentList::push_back ( const Argument &  a )

inline

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

{ m_args.push_back(a); }

引用了 m_args.

被这些函数引用 addMemberFunction(), addSTLClass(), TagFileParser::buildLists(), DocParser::checkUnOrMultipleDocumentedParams() , 以及 substituteTemplatesInArgList().

refQualifier()

RefQualifierType ArgumentList::refQualifier ( ) const

inline

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

{ return m_refQualifier; }

引用了 m_refQualifier.

被这些函数引用 argListToString(), generateXMLForMember(), MemberContext::Private::hasRefQualifierLValue(), MemberContext::Private::hasRefQualifierRValue(), matchArguments2() , 以及 writeDefArgumentList().

reset()

void ArgumentList::reset ( )

inline

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

    {
      clear();
      m_constSpecifier = FALSE;
      m_volatileSpecifier = FALSE;
      m_pureSpecifier = FALSE;
      m_trailingReturnType.resize(0);
      m_isDeleted = FALSE;
      m_refQualifier = RefQualifierNone;
      m_noParameters = FALSE;
    }

引用了 clear(), FALSE, m_constSpecifier, m_isDeleted, m_noParameters, m_pureSpecifier, m_refQualifier, m_trailingReturnType, m_volatileSpecifier, RefQualifierNone , 以及 QCString::resize().

被这些函数引用 Entry::reset().

setConstSpecifier()

void ArgumentList::setConstSpecifier ( bool  b )

inline

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

{ m_constSpecifier = b; }

引用了 m_constSpecifier.

被这些函数引用 substituteTemplatesInArgList().

setIsDeleted()

void ArgumentList::setIsDeleted ( bool  b )

inline

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

{ m_isDeleted = b; }

引用了 m_isDeleted.

setNoParameters()

void ArgumentList::setNoParameters ( bool  b )

inline

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

{ m_noParameters = b; }

引用了 m_noParameters.

setPureSpecifier()

void ArgumentList::setPureSpecifier ( bool  b )

inline

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

{ m_pureSpecifier = b; }

引用了 m_pureSpecifier.

被这些函数引用 substituteTemplatesInArgList().

setRefQualifier()

void ArgumentList::setRefQualifier ( RefQualifierType  t )

inline

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

{ m_refQualifier = t; }

引用了 m_refQualifier.

setTrailingReturnType()

void ArgumentList::setTrailingReturnType ( const QCString &  s )

inline

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

{ m_trailingReturnType = s; }

引用了 m_trailingReturnType.

被这些函数引用 substituteTemplatesInArgList().

setVolatileSpecifier()

void ArgumentList::setVolatileSpecifier ( bool  b )

inline

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

{ m_volatileSpecifier = b; }

引用了 m_volatileSpecifier.

被这些函数引用 substituteTemplatesInArgList().

size()

size_t ArgumentList::size ( ) const

inline

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

{ return m_args.size();  }

引用了 m_args.

被这些函数引用 addMemberFunction(), FlowChart::alignFuncProc(), DocParser::checkUnOrMultipleDocumentedParams(), findGlobalMember(), GroupDefImpl::insertMember(), matchArguments2(), mergeArguments(), MemberDefImpl::setAnchor(), writeDefArgumentList(), VhdlDocGen::writeFuncProcDocu(), VhdlDocGen::writeFunctionProto() , 以及 VhdlDocGen::writeProcedureProto().

trailingReturnType()

QCString ArgumentList::trailingReturnType ( ) const

inline

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

{ return m_trailingReturnType; }

引用了 m_trailingReturnType.

被这些函数引用 argListToString(), MemberContext::Private::createTrailingReturnType(), MemberDefImpl::detectUndocumentedParams() , 以及 writeDefArgumentList().

volatileSpecifier()

bool ArgumentList::volatileSpecifier ( ) const

inline

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

{ return m_volatileSpecifier; }

引用了 m_volatileSpecifier.

被这些函数引用 argListToString(), PerlModGenerator::generatePerlModForMember(), generateXMLForMember(), MemberContext::Private::hasVolatileQualifier(), matchArguments2() , 以及 writeDefArgumentList().

类成员变量说明

m_args

std::vector<Argument> ArgumentList::m_args

private

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

被这些函数引用 at(), back(), begin(), cbegin(), cend(), clear(), empty(), end(), front(), push_back() , 以及 size().

m_constSpecifier

bool ArgumentList::m_constSpecifier = FALSE

private

Does the member modify the state of the class?

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

被这些函数引用 constSpecifier(), reset() , 以及 setConstSpecifier().

m_isDeleted

bool ArgumentList::m_isDeleted = FALSE

private

method with =delete

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

被这些函数引用 isDeleted(), reset() , 以及 setIsDeleted().

m_noParameters

bool ArgumentList::m_noParameters = FALSE

private

is it an explicit empty list

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

被这些函数引用 hasParameters(), noParameters(), reset() , 以及 setNoParameters().

m_pureSpecifier

bool ArgumentList::m_pureSpecifier = FALSE

private

Is this a pure virtual member?

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

被这些函数引用 pureSpecifier(), reset() , 以及 setPureSpecifier().

m_refQualifier

RefQualifierType ArgumentList::m_refQualifier = RefQualifierNone

private

C++11 ref qualifier

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

被这些函数引用 refQualifier(), reset() , 以及 setRefQualifier().

m_trailingReturnType

QCString ArgumentList::m_trailingReturnType

private

C++11 style Trailing return type?

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

被这些函数引用 reset(), setTrailingReturnType() , 以及 trailingReturnType().

m_volatileSpecifier

bool ArgumentList::m_volatileSpecifier = FALSE

private

Is the member volatile?

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

被这些函数引用 reset(), setVolatileSpecifier() , 以及 volatileSpecifier().

---

该类的文档由以下文件生成:

• src/arguments.h
• src/arguments.cpp