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
Sections Class Reference

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 section vectors based on the type of the aggregate node.
 Sections (const NodeMultiMap &nsmap)
 This constructor builds the since sections from the since node map, nsmap.
bool hasObsoleteMembers (SectionPtrVector *summary_spv, SectionPtrVector *details_spv) const
 Returns true if any sections in this object contain obsolete members.
SectionVector & summarySections ()
SectionVector & detailsSections ()
Section & allMembersSection ()
SectionVector & sinceSections ()
const SectionVector & summarySections () const
const SectionVector & detailsSections () const
const Section & allMembersSection () const
const SectionVector & sinceSections () const
Aggregate * aggregate () const

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.

The constructor determines the appropriate section layout based on the aggregate's node type (C++ class, QML type, or generic namespace/header). Callers access the result through the unified summarySections() and detailsSections() accessors without needing to know which variant was selected.

Definition at line 79 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 section vectors based on the type of the aggregate node.

Definition at line 371 of file sections.cpp.

References 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 the since sections from the since node map, nsmap.

Definition at line 409 of file sections.cpp.

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

Referenced by HtmlGenerator::generateAtom().

Here is the call graph for this function:
Here is the caller graph for this function:

Member Function Documentation

◆ aggregate()

Aggregate * Sections::aggregate ( ) const
inlinenodiscard

Definition at line 160 of file sections.h.

◆ allMembersSection() [1/2]

Section & Sections::allMembersSection ( )
inline

Definition at line 152 of file sections.h.

◆ allMembersSection() [2/2]

const Section & Sections::allMembersSection ( ) const
inlinenodiscard

Definition at line 157 of file sections.h.

◆ detailsSections() [1/2]

SectionVector & Sections::detailsSections ( )
inline

Definition at line 151 of file sections.h.

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

Here is the caller graph for this function:

◆ detailsSections() [2/2]

const SectionVector & Sections::detailsSections ( ) const
inlinenodiscard

Definition at line 156 of file sections.h.

◆ hasObsoleteMembers()

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

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 963 of file sections.cpp.

◆ sinceSections() [1/2]

SectionVector & Sections::sinceSections ( )
inline

Definition at line 153 of file sections.h.

Referenced by HtmlGenerator::generateAtom().

Here is the caller graph for this function:

◆ sinceSections() [2/2]

const SectionVector & Sections::sinceSections ( ) const
inlinenodiscard

Definition at line 158 of file sections.h.

◆ summarySections() [1/2]

SectionVector & Sections::summarySections ( )
inline

Definition at line 150 of file sections.h.

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

Here is the caller graph for this function:

◆ summarySections() [2/2]

const SectionVector & Sections::summarySections ( ) const
inlinenodiscard

Definition at line 155 of file sections.h.

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