Section Class Reference

A class for containing the elements of one documentation section. More...

#include <sections.h>

Collaboration diagram for Section:

Public Types
enum	Style { Summary , Details , AllMembers , Accessors }

Public Member Functions
	Section (QString title, QString singular, QString plural, QString divclass, Style style)
void	insert (Node *node)
	Inserts the node into this section if it is appropriate for this section.
bool	insertReimplementedMember (Node *node)
	Returns true if the node is a reimplemented member function of the current class.
void	appendMember (Node *node)
void	reduce ()
	If this section is not empty, convert its maps to sequential structures for better traversal during doc generation.
bool	isEmpty () const
Style	style () const
const QString &	title () const
const QString &	divClass () const
const QString &	singular () const
const QString &	plural () const
const NodeVector &	members () const
const NodeVector &	reimplementedMembers () const
const QList< std::pair< Aggregate *, int > > &	inheritedMembers () const
ClassNodesList &	classNodesList ()
const ClassNodesList &	classNodesList () const
const NodeVector &	obsoleteMembers () const
void	appendMembers (const NodeVector &nv)
const Aggregate *	aggregate () const
void	setAggregate (Aggregate *t)

Detailed Description

A class for containing the elements of one documentation section.

Definition at line 16 of file sections.h.

Member Enumeration Documentation

Style

enum Section::Style

Enumerator
Summary
Details
AllMembers
Accessors

Definition at line 19 of file sections.h.

Constructor & Destructor Documentation

Section()

Section::Section ( QString title, QString singular, QString plural, QString divclass, Style style )

inline

Definition at line 22 of file sections.h.

Member Function Documentation

aggregate()

const Aggregate * Section::aggregate ( ) const

inlinenodiscard

Definition at line 56 of file sections.h.

appendMember()

void Section::appendMember ( Node * node )

inline

Definition at line 32 of file sections.h.

appendMembers()

void Section::appendMembers ( const NodeVector & nv )

inline

Definition at line 55 of file sections.h.

classNodesList() [1/2]

ClassNodesList & Section::classNodesList ( )

inline

Definition at line 52 of file sections.h.

classNodesList() [2/2]

const ClassNodesList & Section::classNodesList ( ) const

inlinenodiscard

Definition at line 53 of file sections.h.

divClass()

const QString & Section::divClass ( ) const

inlinenodiscard

Definition at line 43 of file sections.h.

inheritedMembers()

const QList< std::pair< Aggregate *, int > > & Section::inheritedMembers ( ) const

inlinenodiscard

Definition at line 48 of file sections.h.

insert()

void Section::insert

(

Node *

node

)

Inserts the node into this section if it is appropriate for this section.

Definition at line 212 of file sections.cpp.

References AllMembers, Node< _Tp >::createContext(), Details, Node< _Tp >::isAbstract(), Node< _Tp >::isClassNode(), Node< _Tp >::isDeprecated(), Node< _Tp >::isEnumType(), Node< _Tp >::isFunction(), InclusionFilter::isIncluded(), Node< _Tp >::isNamespace(), Node< _Tp >::isQmlType(), Node< _Tp >::isRelatedNonmember(), Node< _Tp >::isTypedef(), Node< _Tp >::isVariable(), and Node< _Tp >::parent().

Here is the call graph for this function:

insertReimplementedMember()

bool Section::insertReimplementedMember

(

Node *

node

)

Returns true if the node is a reimplemented member function of the current class.

If true, the node is inserted into the reimplemented member map. True is returned only if node is inserted into the map. That is, false is returned if the node is already in the map.

Definition at line 270 of file sections.cpp.

References Node< _Tp >::createContext(), Node< _Tp >::isInAPI(), InclusionFilter::isReimplementedMemberVisible(), and Node< _Tp >::isRelatedNonmember().

Here is the call graph for this function:

isEmpty()

bool Section::isEmpty ( ) const

inlinenodiscard

Definition at line 35 of file sections.h.

members()

const NodeVector & Section::members ( ) const

inlinenodiscard

Definition at line 46 of file sections.h.

obsoleteMembers()

const NodeVector & Section::obsoleteMembers ( ) const

inlinenodiscard

Definition at line 54 of file sections.h.

plural()

const QString & Section::plural ( ) const

inlinenodiscard

Definition at line 45 of file sections.h.

reduce()

void Section::reduce

(

)

If this section is not empty, convert its maps to sequential structures for better traversal during doc generation.

Definition at line 295 of file sections.cpp.

reimplementedMembers()

const NodeVector & Section::reimplementedMembers ( ) const

inlinenodiscard

Definition at line 47 of file sections.h.

setAggregate()

void Section::setAggregate ( Aggregate * t )

inline

Definition at line 57 of file sections.h.

singular()

const QString & Section::singular ( ) const

inlinenodiscard

Definition at line 44 of file sections.h.

style()

Style Section::style ( ) const

inlinenodiscard

Definition at line 41 of file sections.h.

title()

const QString & Section::title ( ) const

inlinenodiscard

Definition at line 42 of file sections.h.

---

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

• qttools/src/qdoc/qdoc/src/qdoc/sections.h (a528ebe9783078e028b0584b40944eb2197f360c)
• qttools/src/qdoc/qdoc/src/qdoc/sections.cpp (a528ebe9783078e028b0584b40944eb2197f360c)