A class for creating vectors of collections for documentation. More...

#include <sections.h>

Collaboration diagram for Sections:

Public Types

enum VectorIndex {
PublicTypes = 0 , DetailsMemberTypes = 0 , SinceNamespaces = 0 , StdNamespaces = 0 ,
QmlEnumTypes = 0 , QmlProperties = 1 , Properties = 1 , DetailsProperties = 1 ,
SinceClasses = 1 , StdClasses = 1 , QmlAttachedProperties = 2 , PublicFunctions = 2 ,
DetailsMemberFunctions = 2 , SinceMemberFunctions = 2 , StdTypes = 2 , QmlSignals = 3 ,
PublicSlots = 3 , DetailsMemberVariables = 3 , SinceNamespaceFunctions = 3 , StdVariables = 3 ,
QmlSignalHandlers = 4 , Signals = 4 , SinceGlobalFunctions = 4 , DetailsRelatedNonmembers = 4 ,
StdStaticVariables = 4 , QmlAttachedSignals = 5 , PublicVariables = 5 , SinceMacros = 5 ,
DetailsMacros = 5 , StdFunctions = 5 , QmlMethods = 6 , StaticPublicMembers = 6 ,
SinceEnumTypes = 6 , StdMacros = 6 , QmlAttachedMethods = 7 , SinceEnumValues = 7 ,
ProtectedTypes = 7 , SinceTypeAliases = 8 , ProtectedFunctions = 8 , SinceProperties = 9 ,
ProtectedSlots = 9 , SinceVariables = 10 , ProtectedVariables = 10 , SinceQmlTypes = 11 ,
StaticProtectedMembers = 11 , PrivateTypes = 12 , SinceQmlEnumTypes = 12 , SinceQmlProperties = 13 ,
PrivateFunctions = 13 , SinceQmlSignals = 14 , PrivateSlots = 14 , SinceQmlSignalHandlers = 15 ,
PrivateVariables = 15 , StaticPrivateMembers = 16 , SinceQmlMethods = 16 , RelatedNonmembers = 17 ,
Macros = 18
}

Public Member Functions
	Sections (Aggregate *aggregate)
	This constructor builds the vectors of sections based on the type of the aggregate node.
	Sections (const NodeMultiMap &nsmap)
	This constructor builds a vector of sections from the since node map, nsmap.
	~Sections ()
	The behavior of the destructor depends on the type of the Aggregate node that was passed to the constructor.
void	clear (SectionVector &v)
	Reset each Section in vector v to its initialized state.
void	reduce (SectionVector &v)
	Linearize the maps in each Section in v.
void	buildStdRefPageSections ()
	Build the section vectors for a standard reference page, when the aggregate node is not a C++ class or a QML type.
void	buildStdCppClassRefPageSections ()
	Build the section vectors for a standard reference page, when the aggregate node is a C++.
void	buildStdQmlTypeRefPageSections ()
	Build the section vectors for a standard reference page, when the aggregate node is a QML type.
bool	hasObsoleteMembers (SectionPtrVector summary_spv, SectionPtrVector details_spv) const
	Returns true if any sections in this object contain obsolete members.
SectionVector &	sinceSections ()
SectionVector &	stdSummarySections ()
SectionVector &	stdDetailsSections ()
SectionVector &	stdCppClassSummarySections ()
SectionVector &	stdCppClassDetailsSections ()
SectionVector &	stdQmlTypeSummarySections ()
SectionVector &	stdQmlTypeDetailsSections ()
const SectionVector &	stdSummarySections () const
const SectionVector &	stdDetailsSections () const
const SectionVector &	stdCppClassSummarySections () const
const SectionVector &	stdCppClassDetailsSections () const
const SectionVector &	stdQmlTypeSummarySections () const
const SectionVector &	stdQmlTypeDetailsSections () const
Aggregate *	aggregate () const

Static Public Member Functions
static Section &	allMembersSection ()

Detailed Description

A class for creating vectors of collections for documentation.

Each element in a vector is an instance of Section, which contains all the elements that will be documented in one section of a reference documentation page.

Definition at line 81 of file sections.h.

Member Enumeration Documentation

◆ VectorIndex

enum Sections::VectorIndex

Enumerator
PublicTypes
DetailsMemberTypes
SinceNamespaces
StdNamespaces
QmlEnumTypes
QmlProperties
Properties
DetailsProperties
SinceClasses
StdClasses
QmlAttachedProperties
PublicFunctions
DetailsMemberFunctions
SinceMemberFunctions
StdTypes
QmlSignals
PublicSlots
DetailsMemberVariables
SinceNamespaceFunctions
StdVariables
QmlSignalHandlers
Signals
SinceGlobalFunctions
DetailsRelatedNonmembers
StdStaticVariables
QmlAttachedSignals
PublicVariables
SinceMacros
DetailsMacros
StdFunctions
QmlMethods
StaticPublicMembers
SinceEnumTypes
StdMacros
QmlAttachedMethods
SinceEnumValues
ProtectedTypes
SinceTypeAliases
ProtectedFunctions
SinceProperties
ProtectedSlots
SinceVariables
ProtectedVariables
SinceQmlTypes
StaticProtectedMembers
PrivateTypes
SinceQmlEnumTypes
SinceQmlProperties
PrivateFunctions
SinceQmlSignals
PrivateSlots
SinceQmlSignalHandlers
PrivateVariables
StaticPrivateMembers
SinceQmlMethods
RelatedNonmembers
Macros

Definition at line 84 of file sections.h.

Constructor & Destructor Documentation

◆ Sections() [1/2]

Sections::Sections ( Aggregate * aggregate )

explicit

This constructor builds the vectors of sections based on the type of the aggregate node.

Definition at line 366 of file sections.cpp.

References buildStdCppClassRefPageSections(), buildStdQmlTypeRefPageSections(), buildStdRefPageSections(), Class, HeaderFile, Namespace, Node< _Tp >::nodeType(), Proxy, QmlType, QmlValueType, Struct, and Union.

Referenced by DocBookGenerator::generateCppReferencePage(), HtmlGenerator::generateCppReferencePage(), DocBookGenerator::generateProxyPage(), and HtmlGenerator::generateProxyPage().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Sections() [2/2]

Sections::Sections ( const NodeMultiMap & nsmap )

explicit

This constructor builds a vector of sections from the since node map, nsmap.

Definition at line 398 of file sections.cpp.

References Enum, Function, Node< _Tp >::isClassNode(), Node< _Tp >::isNamespace(), Node< _Tp >::nodeType(), and sinceSections().

Referenced by HtmlGenerator::generateAtom().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ~Sections()

Sections::~Sections ( )

The behavior of the destructor depends on the type of the Aggregate node that was passed to the constructor.

If the constructor was passed a multimap, the destruction is a bit different because there was no Aggregate node.

Definition at line 489 of file sections.cpp.

References allMembersSection(), Class, Section::clear(), clear(), Node< _Tp >::nodeType(), QmlType, QmlValueType, sinceSections(), stdCppClassDetailsSections(), stdCppClassSummarySections(), stdDetailsSections(), stdQmlTypeDetailsSections(), stdQmlTypeSummarySections(), stdSummarySections(), Struct, and Union.

Here is the call graph for this function:

Member Function Documentation

◆ aggregate()

Aggregate * Sections::aggregate ( ) const

inlinenodiscard

Definition at line 184 of file sections.h.

◆ allMembersSection()

Section & Sections::allMembersSection ( )

inlinestatic

Definition at line 156 of file sections.h.

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

Here is the caller graph for this function:

◆ buildStdCppClassRefPageSections()

void Sections::buildStdCppClassRefPageSections ( )

Build the section vectors for a standard reference page, when the aggregate node is a C++.

Definition at line 881 of file sections.cpp.

References allMembersSection(), Node< _Tp >::createContext(), Section::insert(), InclusionFilter::isIncluded(), Node< _Tp >::isProperty(), Node< _Tp >::isRelatedNonmember(), Node< _Tp >::isSharedCommentNode(), Section::reduce(), reduce(), Aggregate::relatedByProxy(), stdCppClassDetailsSections(), and stdCppClassSummarySections().

Referenced by Sections().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildStdQmlTypeRefPageSections()

void Sections::buildStdQmlTypeRefPageSections ( )

Build the section vectors for a standard reference page, when the aggregate node is a QML type.

Definition at line 929 of file sections.cpp.

References allMembersSection(), Section::classNodesList(), Node< _Tp >::isAbstract(), Aggregate::qmlBaseNode(), Section::reduce(), reduce(), stdQmlTypeDetailsSections(), and stdQmlTypeSummarySections().

Referenced by Sections().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildStdRefPageSections()

void Sections::buildStdRefPageSections ( )

Build the section vectors for a standard reference page, when the aggregate node is not a C++ class or a QML type.

If this is for a namespace page then if the namespace node itself does not have documentation, only its children that have documentation should be documented. In other words, there are cases where a namespace is declared but does not have documentation, but some of the elements declared in that namespace do have documentation.

This special processing of namespaces that do not have a documentation comment is meant to allow documenting its members that do have documentation while avoiding posting error messages for its members that are not documented.

Definition at line 622 of file sections.cpp.

References allMembersSection(), Node< _Tp >::hasDoc(), NamespaceNode::includedChildren(), Node< _Tp >::isNamespace(), Node< _Tp >::isSharingComment(), Section::reduce(), reduce(), Aggregate::relatedByProxy(), stdDetailsSections(), and stdSummarySections().

Referenced by Sections().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clear()

void Sections::clear ( SectionVector & v )

Reset each Section in vector v to its initialized state.

Definition at line 530 of file sections.cpp.

Referenced by ~Sections().

Here is the caller graph for this function:

◆ hasObsoleteMembers()

bool Sections::hasObsoleteMembers	(	SectionPtrVector *	summary_spv,
		SectionPtrVector *	details_spv ) const

Returns true if any sections in this object contain obsolete members.

If it returns false, then summary_spv and details_spv have not been modified. Otherwise, both vectors will contain pointers to the sections that contain obsolete members.

Definition at line 993 of file sections.cpp.

References Node< _Tp >::isClassNode(), Node< _Tp >::isQmlType(), stdCppClassDetailsSections(), stdCppClassSummarySections(), stdDetailsSections(), stdQmlTypeDetailsSections(), stdQmlTypeSummarySections(), and stdSummarySections().

Here is the call graph for this function:

◆ reduce()

void Sections::reduce ( SectionVector & v )

Linearize the maps in each Section in v.

Definition at line 539 of file sections.cpp.

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

Here is the caller graph for this function:

◆ sinceSections()

SectionVector & Sections::sinceSections ( )

inline

Definition at line 157 of file sections.h.

Referenced by Sections(), ~Sections(), and HtmlGenerator::generateAtom().

Here is the caller graph for this function:

◆ stdCppClassDetailsSections() [1/2]

SectionVector & Sections::stdCppClassDetailsSections ( )

inline

Definition at line 161 of file sections.h.

Referenced by ~Sections(), buildStdCppClassRefPageSections(), DocBookGenerator::generateCppReferencePage(), and HtmlGenerator::generateCppReferencePage().

Here is the caller graph for this function:

◆ stdCppClassDetailsSections() [2/2]

const SectionVector & Sections::stdCppClassDetailsSections ( ) const

inlinenodiscard

Definition at line 171 of file sections.h.

Referenced by hasObsoleteMembers().

Here is the caller graph for this function:

◆ stdCppClassSummarySections() [1/2]

SectionVector & Sections::stdCppClassSummarySections ( )

inline

Definition at line 160 of file sections.h.

Referenced by ~Sections(), buildStdCppClassRefPageSections(), and HtmlGenerator::generateCppReferencePage().

Here is the caller graph for this function:

◆ stdCppClassSummarySections() [2/2]

const SectionVector & Sections::stdCppClassSummarySections ( ) const

inlinenodiscard

Definition at line 167 of file sections.h.

Referenced by hasObsoleteMembers().

Here is the caller graph for this function:

◆ stdDetailsSections() [1/2]

SectionVector & Sections::stdDetailsSections ( )

inline

Definition at line 159 of file sections.h.

Referenced by ~Sections(), buildStdRefPageSections(), DocBookGenerator::generateCppReferencePage(), HtmlGenerator::generateCppReferencePage(), DocBookGenerator::generateProxyPage(), and HtmlGenerator::generateProxyPage().

Here is the caller graph for this function:

◆ stdDetailsSections() [2/2]

const SectionVector & Sections::stdDetailsSections ( ) const

inlinenodiscard

Definition at line 166 of file sections.h.

Referenced by hasObsoleteMembers().

Here is the caller graph for this function:

◆ stdQmlTypeDetailsSections() [1/2]

SectionVector & Sections::stdQmlTypeDetailsSections ( )

inline

Definition at line 163 of file sections.h.

Referenced by ~Sections(), buildStdQmlTypeRefPageSections(), and HtmlGenerator::generateQmlTypePage().

Here is the caller graph for this function:

◆ stdQmlTypeDetailsSections() [2/2]

const SectionVector & Sections::stdQmlTypeDetailsSections ( ) const

inlinenodiscard

Definition at line 179 of file sections.h.

Referenced by hasObsoleteMembers().

Here is the caller graph for this function:

◆ stdQmlTypeSummarySections() [1/2]

SectionVector & Sections::stdQmlTypeSummarySections ( )

inline

Definition at line 162 of file sections.h.

Referenced by ~Sections(), buildStdQmlTypeRefPageSections(), and HtmlGenerator::generateQmlTypePage().

Here is the caller graph for this function:

◆ stdQmlTypeSummarySections() [2/2]

const SectionVector & Sections::stdQmlTypeSummarySections ( ) const

inlinenodiscard

Definition at line 175 of file sections.h.

Referenced by hasObsoleteMembers().

Here is the caller graph for this function:

◆ stdSummarySections() [1/2]

SectionVector & Sections::stdSummarySections ( )

inline

Definition at line 158 of file sections.h.

Referenced by ~Sections(), buildStdRefPageSections(), HtmlGenerator::generateCppReferencePage(), and HtmlGenerator::generateProxyPage().

Here is the caller graph for this function:

◆ stdSummarySections() [2/2]

const SectionVector & Sections::stdSummarySections ( ) const

inlinenodiscard

Definition at line 165 of file sections.h.

Referenced by hasObsoleteMembers().

Here is the caller graph for this function:

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

qttools/src/qdoc/qdoc/src/qdoc/sections.h (77b014b3a4c322c13d1fd9f3d694df928b3027ea)
qttools/src/qdoc/qdoc/src/qdoc/sections.cpp (1fc041b790a3fb833ce940d91a2b0dec0dba43a2)

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ VectorIndex

Constructor & Destructor Documentation

◆ Sections() [1/2]

◆ Sections() [2/2]

◆ ~Sections()

Member Function Documentation

◆ aggregate()

◆ allMembersSection()

◆ buildStdCppClassRefPageSections()

◆ buildStdQmlTypeRefPageSections()

◆ buildStdRefPageSections()

◆ clear()

◆ hasObsoleteMembers()

◆ reduce()

◆ sinceSections()

◆ stdCppClassDetailsSections() [1/2]

◆ stdCppClassDetailsSections() [2/2]

◆ stdCppClassSummarySections() [1/2]

◆ stdCppClassSummarySections() [2/2]

◆ stdDetailsSections() [1/2]

◆ stdDetailsSections() [2/2]

◆ stdQmlTypeDetailsSections() [1/2]

◆ stdQmlTypeDetailsSections() [2/2]

◆ stdQmlTypeSummarySections() [1/2]

◆ stdQmlTypeSummarySections() [2/2]

◆ stdSummarySections() [1/2]

◆ stdSummarySections() [2/2]