This class represents an function or template argument list. More...

#include <src/arguments.h>

Collaboration diagram for ArgumentList:

Public Types
using	Vec = std::vector<Argument>

using	iterator = typename Vec::iterator

using	const_iterator = typename Vec::const_iterator

Public Member Functions
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 Attributes
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 = RefQualifierType::None

bool	m_noParameters = FALSE

Detailed Description

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.

Definition at line 59 of file arguments.h.

Member Typedef Documentation

◆ const_iterator

using ArgumentList::const_iterator = typename Vec::const_iterator

Definition at line 64 of file arguments.h.

◆ iterator

using ArgumentList::iterator = typename Vec::iterator

Definition at line 63 of file arguments.h.

◆ Vec

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

Definition at line 62 of file arguments.h.

Member Function Documentation

◆ at() [1/2]

Argument & ArgumentList::at ( size_t i )

inline

Definition at line 100 of file arguments.h.

100{ return m_args.at(i); }

ArgumentList::m_args

std::vector< Argument > m_args

Definition arguments.h:121

References m_args.

Referenced by makeQualifiedNameWithTemplateParameters().

◆ at() [2/2]

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

inline

Definition at line 101 of file arguments.h.

101{ return m_args.at(i); }

References m_args.

◆ back() [1/2]

Argument & ArgumentList::back ( )

inline

Definition at line 96 of file arguments.h.

96{ return m_args.back(); }

References m_args.

◆ back() [2/2]

const Argument & ArgumentList::back ( ) const

inline

Definition at line 97 of file arguments.h.

97{ return m_args.back(); }

References m_args.

◆ begin() [1/2]

iterator ArgumentList::begin ( )

inline

◆ begin() [2/2]

const_iterator ArgumentList::begin ( ) const

inline

Definition at line 88 of file arguments.h.

88{ return m_args.cbegin(); }

References m_args.

◆ cbegin()

const_iterator ArgumentList::cbegin ( ) const

inline

Definition at line 90 of file arguments.h.

90{ return m_args.cbegin(); }

References m_args.

◆ cend()

const_iterator ArgumentList::cend ( ) const

inline

Definition at line 91 of file arguments.h.

91{ return m_args.cend(); }

References m_args.

◆ clear()

void ArgumentList::clear ( )

inline

Definition at line 94 of file arguments.h.

94{ m_args.clear(); }

References m_args.

Referenced by reset().

◆ constSpecifier()

bool ArgumentList::constSpecifier ( ) const

inline

Definition at line 104 of file arguments.h.

104{ return m_constSpecifier; }

ArgumentList::m_constSpecifier

bool m_constSpecifier

Definition arguments.h:123

References m_constSpecifier.

Referenced by argListToString(), PerlModGenerator::generatePerlModForMember(), generateSqlite3ForMember(), generateXMLForMember(), matchArguments2(), substituteTemplatesInArgList(), and writeDefArgumentList().

◆ empty()

bool ArgumentList::empty ( ) const

inline

◆ end() [1/2]

iterator ArgumentList::end ( )

inline

◆ end() [2/2]

const_iterator ArgumentList::end ( ) const

inline

Definition at line 89 of file arguments.h.

89{ return m_args.cend(); }

References m_args.

◆ front() [1/2]

Argument & ArgumentList::front ( )

inline

Definition at line 98 of file arguments.h.

98{ return m_args.front(); }

References m_args.

Referenced by matchArguments2().

◆ front() [2/2]

const Argument & ArgumentList::front ( ) const

inline

Definition at line 99 of file arguments.h.

99{ return m_args.front(); }

References 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

Definition at line 21 of file arguments.cpp.

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

References begin(), end(), and Argument::hasDocumentation().

Referenced by inlineArgListToDoc().

◆ hasParameters()

bool ArgumentList::hasParameters ( ) const

inline

Does this list have zero or more parameters

Definition at line 69 of file arguments.h.

    {
      return !empty() || m_noParameters;
    }

References empty(), and m_noParameters.

Referenced by addMemberFunction(), addTemplateArgumentList(), argListToString(), combineDeclarationAndDefinition(), MemberDefImpl::detectUndocumentedParams(), generateXMLForMember(), writeDefArgumentList(), VhdlDocGen::writeFunctionProto(), VhdlDocGen::writeProcessProto(), writeTemplateArgumentList(), and VhdlDocGen::writeVHDLDeclaration().

◆ isDeleted()

bool ArgumentList::isDeleted ( ) const

inline

Definition at line 108 of file arguments.h.

108{ return m_isDeleted; }

ArgumentList::m_isDeleted

bool m_isDeleted

Definition arguments.h:131

References m_isDeleted.

Referenced by substituteTemplatesInArgList().

◆ noParameters()

bool ArgumentList::noParameters ( ) const

inline

Definition at line 110 of file arguments.h.

110{ return m_noParameters; }

References m_noParameters.

Referenced by substituteTemplatesInArgList().

◆ pureSpecifier()

bool ArgumentList::pureSpecifier ( ) const

inline

Definition at line 106 of file arguments.h.

106{ return m_pureSpecifier; }

ArgumentList::m_pureSpecifier

bool m_pureSpecifier

Definition arguments.h:127

References m_pureSpecifier.

Referenced by argListToString(), and substituteTemplatesInArgList().

◆ push_back()

void ArgumentList::push_back ( const Argument & a )

inline

Definition at line 95 of file arguments.h.

95{ m_args.push_back(a); }

References m_args.

Referenced by addSTLClass(), anonymous_namespace{tagreader.cpp}::TagFileParser::buildLists(), DocParser::checkUnOrMultipleDocumentedParams(), and substituteTemplatesInArgList().

◆ refQualifier()

RefQualifierType ArgumentList::refQualifier ( ) const

inline

Definition at line 109 of file arguments.h.

109{ return m_refQualifier; }

ArgumentList::m_refQualifier

RefQualifierType m_refQualifier

Definition arguments.h:133

References m_refQualifier.

Referenced by argListToString(), generateXMLForMember(), matchArguments2(), substituteTemplatesInArgList(), and writeDefArgumentList().

◆ reset()

void ArgumentList::reset ( )

inline

Definition at line 73 of file arguments.h.

    {
      clear();
      m_constSpecifier = FALSE;
      m_volatileSpecifier = FALSE;
      m_pureSpecifier = FALSE;
      m_trailingReturnType.clear();
      m_isDeleted = FALSE;
      m_refQualifier = RefQualifierType::None;
      m_noParameters = FALSE;
    }