A list of MemberDef objects as shown in documentation sections. More...

#include <memberlist.h>

Inheritance diagram for MemberList:

Collaboration diagram for MemberList:

Public Member Functions
	MemberList (MemberListType lt, MemberListContainer container)

MemberListType	listType () const

MemberListContainer	container () const

int	numDecMembers () const

int	numDecEnumValues () const

int	numDocMembers () const

int	numDocEnumValues () const

bool	needsSorting () const

void	countDecMembers ()

void	countDocMembers ()

int	countInheritableMembers (const ClassDef *inheritedFrom) const

void	writePlainDeclarations (OutputList &ol, bool inGroup, const ClassDef cd, const NamespaceDef nd, const FileDef fd, const GroupDef gd, int indentLevel, const ClassDef *inheritedFrom, const QCString &inheritId) const

void	writeDeclarations (OutputList &ol, const ClassDef cd, const NamespaceDef nd, const FileDef fd, const GroupDef gd, const QCString &title, const QCString &subtitle, bool showEnumValues=FALSE, bool showInline=FALSE, const ClassDef *inheritedFrom=0, MemberListType lt=MemberListType_pubMethods) const
	Writes the list of members to the output. More...

void	writeDocumentation (OutputList &ol, const QCString &scopeName, const Definition *container, const QCString &title, bool showEnumValues=FALSE, bool showInline=FALSE) const

void	writeSimpleDocumentation (OutputList &ol, const Definition *container) const

void	writeDocumentationPage (OutputList &ol, const QCString &scopeName, const DefinitionMutable *container) const

void	writeTagFile (TextStream &)

bool	declVisible () const

void	addMemberGroup (MemberGroup *mg)

void	addListReferences (Definition *def)

void	findSectionsInDocumentation (const Definition *d)

void	setNeedsSorting (bool b)

const MemberGroupRefList &	getMemberGroupList () const

void	setAnonymousEnumType ()

void	setAnchors ()

Public Member Functions inherited from MemberVector
void	push_back (const MemberDef *md)

iterator	begin ()

iterator	end ()

const_iterator	begin () const

const_iterator	end () const

bool	empty () const

size_t	size () const

const_reference	front () const

const_reference	back () const

const_reference	operator[] (int index) const

const_reference	operator[] (size_t index) const

void	sort ()

void	inSort (const MemberDef *md)

void	remove (const MemberDef *md)

bool	contains (const MemberDef *md)

Static Public Member Functions
static QCString	listTypeAsString (MemberListType type)

Static Public Member Functions inherited from MemberVector
static bool	lessThan (const MemberDef md1, const MemberDef md2)

Additional Inherited Members
Public Types inherited from MemberVector
using	Ptr = const MemberDef *

using	Vec = std::vector< Ptr >

using	iterator = typename Vec::iterator

using	const_iterator = typename Vec::const_iterator

using	value_type = const MemberDef *

using	const_reference = const value_type &

Protected Attributes inherited from MemberVector
Vec	m_members

Detailed Description

A list of MemberDef objects as shown in documentation sections.

Member Function Documentation

◆ countDecMembers()

void MemberList::countDecMembers ( )

Count the number of members in this list that are visible in the declaration part of a compound's documentation page.

◆ writeDeclarations()

void MemberList::writeDeclarations	(	OutputList &	ol,
		const ClassDef *	cd,
		const NamespaceDef *	nd,
		const FileDef *	fd,
		const GroupDef *	gd,
		const QCString &	title,
		const QCString &	subtitle,
		bool	showEnumValues = `FALSE`,
		bool	showInline = `FALSE`,
		const ClassDef *	inheritedFrom = `0`,
		MemberListType	lt = `MemberListType_pubMethods`
	)		const

Writes the list of members to the output.

Parameters

ol	Output list to write to
cd	non-null if this list is part of class documentation.
nd	non-null if this list is part of namespace documentation.
fd	non-null if this list is part of file documentation.
gd	non-null if this list is part of group documentation.
title	Title to use for the member list.
subtitle	Sub title to use for the member list.
showEnumValues	Obsolete, always set to FALSE.
showInline	if set to TRUE if title is rendered differently
inheritedFrom	if not 0, the list is shown inside the given class as inherited members, parameter cd points to the class containing the members.
lt	Type of list that is inherited from.

The documentation for this class was generated from the following files:

src/memberlist.h
src/memberlist.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ countDecMembers()

◆ writeDeclarations()