Doxygen
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)
 
Argumentback ()
 
const Argumentback () const
 
Argumentfront ()
 
const Argumentfront () const
 
Argumentat (size_t i)
 
const Argumentat (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< Argumentm_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.h59 行定义.

成员类型定义说明

◆ const_iterator

using ArgumentList::const_iterator = typename Vec::const_iterator

在文件 arguments.h64 行定义.

◆ iterator

using ArgumentList::iterator = typename Vec::iterator

在文件 arguments.h63 行定义.

◆ Vec

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

在文件 arguments.h62 行定义.

成员函数说明

◆ at() [1/2]

Argument& ArgumentList::at ( size_t  i)
inline

在文件 arguments.h100 行定义.

100 { return m_args.at(i); }

引用了 m_args.

被这些函数引用 makeQualifiedNameWithTemplateParameters().

◆ at() [2/2]

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

在文件 arguments.h101 行定义.

101 { return m_args.at(i); }

引用了 m_args.

◆ back() [1/2]

Argument& ArgumentList::back ( )
inline

在文件 arguments.h96 行定义.

96 { return m_args.back(); }

引用了 m_args.

◆ back() [2/2]

const Argument& ArgumentList::back ( ) const
inline

在文件 arguments.h97 行定义.

97 { return m_args.back(); }

引用了 m_args.

◆ begin() [1/2]

◆ begin() [2/2]

const_iterator ArgumentList::begin ( ) const
inline

在文件 arguments.h88 行定义.

88 { return m_args.cbegin(); }

引用了 m_args.

◆ cbegin()

const_iterator ArgumentList::cbegin ( ) const
inline

在文件 arguments.h90 行定义.

90 { return m_args.cbegin(); }

引用了 m_args.

◆ cend()

const_iterator ArgumentList::cend ( ) const
inline

在文件 arguments.h91 行定义.

91 { return m_args.cend(); }

引用了 m_args.

◆ clear()

void ArgumentList::clear ( )
inline

在文件 arguments.h94 行定义.

94 { m_args.clear(); }

引用了 m_args.

被这些函数引用 reset().

◆ constSpecifier()

bool ArgumentList::constSpecifier ( ) const
inline

◆ empty()

◆ end() [1/2]

◆ end() [2/2]

const_iterator ArgumentList::end ( ) const
inline

在文件 arguments.h89 行定义.

89 { return m_args.cend(); }

引用了 m_args.

◆ front() [1/2]

Argument& ArgumentList::front ( )
inline

在文件 arguments.h98 行定义.

98 { return m_args.front(); }

引用了 m_args.

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

◆ front() [2/2]

const Argument& ArgumentList::front ( ) const
inline

在文件 arguments.h99 行定义.

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.cpp21 行定义.

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

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

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

◆ hasParameters()

◆ isDeleted()

bool ArgumentList::isDeleted ( ) const
inline

在文件 arguments.h108 行定义.

108 { return m_isDeleted; }

引用了 m_isDeleted.

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

◆ noParameters()

bool ArgumentList::noParameters ( ) const
inline

在文件 arguments.h110 行定义.

110 { return m_noParameters; }

引用了 m_noParameters.

◆ pureSpecifier()

bool ArgumentList::pureSpecifier ( ) const
inline

在文件 arguments.h106 行定义.

106 { return m_pureSpecifier; }

引用了 m_pureSpecifier.

被这些函数引用 argListToString().

◆ push_back()

void ArgumentList::push_back ( const Argument a)
inline

◆ refQualifier()

◆ reset()

◆ setConstSpecifier()

void ArgumentList::setConstSpecifier ( bool  b)
inline

在文件 arguments.h112 行定义.

112 { m_constSpecifier = b; }

引用了 m_constSpecifier.

被这些函数引用 substituteTemplatesInArgList().

◆ setIsDeleted()

void ArgumentList::setIsDeleted ( bool  b)
inline

在文件 arguments.h116 行定义.

116 { m_isDeleted = b; }

引用了 m_isDeleted.

◆ setNoParameters()

void ArgumentList::setNoParameters ( bool  b)
inline

在文件 arguments.h118 行定义.

118 { m_noParameters = b; }

引用了 m_noParameters.

◆ setPureSpecifier()

void ArgumentList::setPureSpecifier ( bool  b)
inline

在文件 arguments.h114 行定义.

114 { m_pureSpecifier = b; }

引用了 m_pureSpecifier.

被这些函数引用 substituteTemplatesInArgList().

◆ setRefQualifier()

void ArgumentList::setRefQualifier ( RefQualifierType  t)
inline

在文件 arguments.h117 行定义.

117 { m_refQualifier = t; }

引用了 m_refQualifier.

◆ setTrailingReturnType()

void ArgumentList::setTrailingReturnType ( const QCString s)
inline

在文件 arguments.h115 行定义.

115 { m_trailingReturnType = s; }

引用了 m_trailingReturnType.

被这些函数引用 substituteTemplatesInArgList().

◆ setVolatileSpecifier()

void ArgumentList::setVolatileSpecifier ( bool  b)
inline

在文件 arguments.h113 行定义.

113 { m_volatileSpecifier = b; }

引用了 m_volatileSpecifier.

被这些函数引用 substituteTemplatesInArgList().

◆ size()

◆ trailingReturnType()

QCString ArgumentList::trailingReturnType ( ) const
inline

◆ volatileSpecifier()

bool ArgumentList::volatileSpecifier ( ) const
inline

类成员变量说明

◆ m_args

std::vector<Argument> ArgumentList::m_args
private

在文件 arguments.h121 行定义.

被这些函数引用 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.h123 行定义.

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

◆ m_isDeleted

bool ArgumentList::m_isDeleted = FALSE
private

method with =delete

在文件 arguments.h131 行定义.

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

◆ m_noParameters

bool ArgumentList::m_noParameters = FALSE
private

is it an explicit empty list

在文件 arguments.h135 行定义.

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

◆ m_pureSpecifier

bool ArgumentList::m_pureSpecifier = FALSE
private

Is this a pure virtual member?

在文件 arguments.h127 行定义.

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

◆ m_refQualifier

RefQualifierType ArgumentList::m_refQualifier = RefQualifierNone
private

C++11 ref qualifier

在文件 arguments.h133 行定义.

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

◆ m_trailingReturnType

QCString ArgumentList::m_trailingReturnType
private

C++11 style Trailing return type?

在文件 arguments.h129 行定义.

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

◆ m_volatileSpecifier

bool ArgumentList::m_volatileSpecifier = FALSE
private

Is the member volatile?

在文件 arguments.h125 行定义.

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


该类的文档由以下文件生成:
RefQualifierNone
@ RefQualifierNone
Definition: arguments.h:48
ArgumentList::m_pureSpecifier
bool m_pureSpecifier
Definition: arguments.h:127
ArgumentList::m_constSpecifier
bool m_constSpecifier
Definition: arguments.h:123
ArgumentList::m_volatileSpecifier
bool m_volatileSpecifier
Definition: arguments.h:125
ArgumentList::m_refQualifier
RefQualifierType m_refQualifier
Definition: arguments.h:133
ArgumentList::clear
void clear()
Definition: arguments.h:94
ArgumentList::m_noParameters
bool m_noParameters
Definition: arguments.h:135
ArgumentList::end
iterator end()
Definition: arguments.h:87
ArgumentList::m_trailingReturnType
QCString m_trailingReturnType
Definition: arguments.h:129
ArgumentList::begin
iterator begin()
Definition: arguments.h:86
ArgumentList::m_isDeleted
bool m_isDeleted
Definition: arguments.h:131
ArgumentList::empty
bool empty() const
Definition: arguments.h:92
Argument
This class contains the information about the argument of a function or template
Definition: arguments.h:26
ArgumentList::m_args
std::vector< Argument > m_args
Definition: arguments.h:121
Argument::hasDocumentation
bool hasDocumentation() const
Definition: arguments.h:44
QCString::resize
bool resize(size_t newlen)
Resizes the string to hold newlen characters (this value should also count the 0-terminator).
Definition: qcstring.h:164
FALSE
#define FALSE
Definition: qcstring.h:33