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

#include <docprivate.h>

Collaboration diagram for DocPrivate:

Public Member Functions

 DocPrivate (const Location &start=Location(), const Location &end=Location(), QString source=QString())
 ~DocPrivate ()
 Deletes the DocPrivateExtra.
void addAlso (const Text &also)
void constructExtra ()
void ref ()
bool deref ()

Public Attributes

int count { 1 }
Location m_start_loc {}
Location m_end_loc {}
QString m_src {}
Text m_text {}
QSet< QString > m_params {}
QList< Text > m_alsoList {}
QStringList m_enumItemList {}
QStringList m_omitEnumItemList {}
QSet< QString > m_metacommandsUsed {}
CommandMap m_metaCommandMap {}
DocPrivateExtra * extra { nullptr }
TopicList m_topics {}
bool m_hasLegalese: 1

Detailed Description

Definition at line 43 of file docprivate.h.

Constructor & Destructor Documentation

◆ DocPrivate()

DocPrivate::DocPrivate ( const Location & start = Location(),
const Location & end = Location(),
QString source = QString() )
inlineexplicit

Definition at line 46 of file docprivate.h.

References DocPrivate(), and m_hasLegalese.

Referenced by DocPrivate().

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

◆ ~DocPrivate()

QT_BEGIN_NAMESPACE DocPrivate::~DocPrivate ( )

Deletes the DocPrivateExtra.

Definition at line 14 of file docprivate.cpp.

Member Function Documentation

◆ addAlso()

void DocPrivate::addAlso ( const Text & also)

Definition at line 19 of file docprivate.cpp.

◆ constructExtra()

void DocPrivate::constructExtra ( )

Definition at line 24 of file docprivate.cpp.

References extra.

Referenced by Doc::constructExtra(), Doc::keywords(), DocParser::parse(), processComparesWithCommand(), Doc::tableOfContents(), Doc::tableOfContentsLevels(), and Doc::targets().

Here is the caller graph for this function:

◆ deref()

bool DocPrivate::deref ( )
inline

Definition at line 54 of file docprivate.h.

References count.

Referenced by Doc::~Doc(), and Doc::operator=().

Here is the caller graph for this function:

◆ ref()

void DocPrivate::ref ( )
inline

Definition at line 53 of file docprivate.h.

References count.

Referenced by Doc::operator=().

Here is the caller graph for this function:

Member Data Documentation

◆ count

int DocPrivate::count { 1 }

Definition at line 56 of file docprivate.h.

Referenced by deref(), and ref().

◆ extra

DocPrivateExtra* DocPrivate::extra { nullptr }

Definition at line 68 of file docprivate.h.

Referenced by Doc::comparesWithMap(), constructExtra(), Doc::hasKeywords(), Doc::hasTableOfContents(), Doc::hasTargets(), Doc::keywords(), Doc::metaTagMap(), processComparesWithCommand(), Doc::tableOfContents(), Doc::tableOfContentsLevels(), and Doc::targets().

◆ m_alsoList

QList<Text> DocPrivate::m_alsoList {}

Definition at line 63 of file docprivate.h.

◆ m_end_loc

Location DocPrivate::m_end_loc {}

Definition at line 59 of file docprivate.h.

◆ m_enumItemList

QStringList DocPrivate::m_enumItemList {}

Definition at line 64 of file docprivate.h.

◆ m_hasLegalese

bool DocPrivate::m_hasLegalese

Definition at line 71 of file docprivate.h.

Referenced by DocPrivate(), Doc::legaleseText(), and DocParser::parse().

◆ m_metaCommandMap

CommandMap DocPrivate::m_metaCommandMap {}

Definition at line 67 of file docprivate.h.

Referenced by Doc::metaCommandArgs(), DocParser::parse(), and processComparesWithCommand().

◆ m_metacommandsUsed

QSet<QString> DocPrivate::m_metacommandsUsed {}

Definition at line 66 of file docprivate.h.

◆ m_omitEnumItemList

QStringList DocPrivate::m_omitEnumItemList {}

Definition at line 65 of file docprivate.h.

◆ m_params

QSet<QString> DocPrivate::m_params {}

Definition at line 62 of file docprivate.h.

◆ m_src

QString DocPrivate::m_src {}

Definition at line 60 of file docprivate.h.

◆ m_start_loc

Location DocPrivate::m_start_loc {}

Definition at line 58 of file docprivate.h.

◆ m_text

Text DocPrivate::m_text {}

Definition at line 61 of file docprivate.h.

Referenced by Doc::body(), DocParser::parse(), and processComparesWithCommand().

◆ m_topics

TopicList DocPrivate::m_topics {}

Definition at line 69 of file docprivate.h.

Referenced by DocParser::parse(), and Doc::topicsUsed().

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