Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
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)
 
 ~Section ()
 The destructor must delete the members of collections when the members are allocated on the heap.
 
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 clear ()
 A Section is now an element in a static vector, so we don't have to repeatedly construct and destroy them.
 
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 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.

◆ ~Section()

Section::~Section ( )

The destructor must delete the members of collections when the members are allocated on the heap.

Definition at line 124 of file sections.cpp.

References clear().

+ Here is the call graph for this function:

Member Function Documentation

◆ aggregate()

const Aggregate * Section::aggregate ( ) const
inlinenodiscard

Definition at line 58 of file sections.h.

◆ appendMember()

void Section::appendMember ( Node * node)
inline

Definition at line 34 of file sections.h.

◆ appendMembers()

void Section::appendMembers ( const NodeVector & nv)
inline

Definition at line 57 of file sections.h.

◆ classNodesList()

ClassNodesList & Section::classNodesList ( )
inline

Definition at line 55 of file sections.h.

Referenced by Sections::buildStdQmlTypeRefPageSections().

+ Here is the caller graph for this function:

◆ clear()

void Section::clear ( )

A Section is now an element in a static vector, so we don't have to repeatedly construct and destroy them.

But we do need to clear them before each call to build the sections for a C++ or QML entity.

Definition at line 135 of file sections.cpp.

Referenced by ~Section(), and Sections::~Sections().

+ Here is the caller graph for this function:

◆ divClass()

const QString & Section::divClass ( ) const
inlinenodiscard

Definition at line 46 of file sections.h.

◆ inheritedMembers()

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

Definition at line 51 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 205 of file sections.cpp.

References AllMembers, TypedefNode::associatedEnum(), Details, Node< _Tp >::isAbstract(), Node< _Tp >::isClassNode(), Node< _Tp >::isDeprecated(), FunctionNode::isDtor(), Node< _Tp >::isEnumType(), Node< _Tp >::isFunction(), Node< _Tp >::isInternal(), Node< _Tp >::isNamespace(), Node< _Tp >::isPrivate(), Node< _Tp >::isQmlType(), Node< _Tp >::isRelatedNonmember(), FunctionNode::isSomeCtor(), Node< _Tp >::isTypedef(), Node< _Tp >::isVariable(), and Node< _Tp >::parent().

Referenced by Sections::buildStdCppClassRefPageSections().

+ Here is the call graph for this function:
+ Here is the caller 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 260 of file sections.cpp.

References Node< _Tp >::isPrivate(), Node< _Tp >::isRelatedNonmember(), and Node< _Tp >::parent().

+ Here is the call graph for this function:

◆ isEmpty()

bool Section::isEmpty ( ) const
inlinenodiscard

Definition at line 38 of file sections.h.

◆ members()

const NodeVector & Section::members ( ) const
inlinenodiscard

Definition at line 49 of file sections.h.

◆ obsoleteMembers()

const NodeVector & Section::obsoleteMembers ( ) const
inlinenodiscard

Definition at line 56 of file sections.h.

◆ plural()

const QString & Section::plural ( ) const
inlinenodiscard

Definition at line 48 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 281 of file sections.cpp.

Referenced by Sections::buildStdCppClassRefPageSections(), Sections::buildStdQmlTypeRefPageSections(), and Sections::buildStdRefPageSections().

+ Here is the caller graph for this function:

◆ reimplementedMembers()

const NodeVector & Section::reimplementedMembers ( ) const
inlinenodiscard

Definition at line 50 of file sections.h.

◆ setAggregate()

void Section::setAggregate ( Aggregate * t)
inline

Definition at line 59 of file sections.h.

◆ singular()

const QString & Section::singular ( ) const
inlinenodiscard

Definition at line 47 of file sections.h.

◆ style()

Style Section::style ( ) const
inlinenodiscard

Definition at line 44 of file sections.h.

◆ title()

const QString & Section::title ( ) const
inlinenodiscard

Definition at line 45 of file sections.h.

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