This class provides exclusive access to the qdoc database, which consists of a forrest of trees and a lot of maps and other useful data structures. More...

#include <qdocdatabase.h>

Collaboration diagram for QDocDatabase:

Public Types
using	FindFunctionPtr = void (QDocDatabase::)(Aggregate )

Public Member Functions
	~QDocDatabase ()=default
Tree *	findTree (const QString &t)
const CNMap &	groups ()
	Returns a const reference to the collection of all group nodes in the primary tree.
const CNMap &	modules ()
	Returns a const reference to the collection of all module nodes in the primary tree.
const CNMap &	qmlModules ()
	Returns a const reference to the collection of all QML module nodes in the primary tree.
CollectionNode *	addGroup (const QString &name)
	Looks up the group named name in the primary tree.
CollectionNode *	addModule (const QString &name)
	Looks up the module named name in the primary tree.
CollectionNode *	addQmlModule (const QString &name)
	Looks up the QML module named name in the primary tree.
CollectionNode *	addToGroup (const QString &name, Node *node)
	Looks up the group node named name in the collection of all group nodes.
CollectionNode *	addToModule (const QString &name, Node *node)
	Looks up the module node named name in the collection of all module nodes.
CollectionNode *	addToQmlModule (const QString &name, Node *node)
	Looks up the QML module named name.
void	addExampleNode (ExampleNode *n)
ExampleNodeMap &	exampleNodeMap ()
QmlTypeNode *	findQmlType (const QString &name, const Node *relative=nullptr)
QmlTypeNode *	findQmlType (const QString &qmid, const QString &name, const Node *relative=nullptr)
	Returns the QML type node identified by the QML module id qmid and QML type name, or `nullptr` if no type was found.
QmlTypeNode *	findQmlType (const ImportRec &import, const QString &name, const Node *relative=nullptr)
QmlTypeNode *	findQmlTypeInPrimaryTree (const QString &qmid, const QString &name)
	Returns the QML node identified by the QML module id qmid and name, searching in the primary tree only.
NodeMultiMap &	getCppClasses ()
	Returns a reference to the map of all C++ classes.
NodeMultiMap &	getObsoleteClasses ()
	Returns a reference to the map of obsolete C++ clases.
NodeMultiMap &	getClassesWithObsoleteMembers ()
	Returns a reference to the map of C++ classes with obsolete members.
NodeMultiMap &	getObsoleteQmlTypes ()
	Returns a reference to the map of obsolete QML types.
NodeMultiMap &	getQmlTypesWithObsoleteMembers ()
	Returns a reference to the map of QML types with obsolete members.
NodeMultiMap &	getNamespaces ()
	Returns a reference to the namespace map.
NodeMultiMap &	getQmlValueTypes ()
	Returns a reference to the map of QML basic types.
NodeMultiMap &	getQmlTypes ()
	Returns a reference to the multimap of QML types.
NodeMultiMap &	getExamples ()
	Returns a reference to the multimap of example nodes.
NodeMultiMap &	getAttributions ()
	Returns a reference to the multimap of attribution nodes.
NodeMapMap &	getFunctionIndex ()
	Returns the function index.
TextToNodeMap &	getLegaleseTexts ()
	Returns a reference to the collection of legalese texts.
const NodeMultiMap &	getClassMap (const QString &key)
	Find the key in the map of new class maps, and return a reference to the value, which is a NodeMap.
const NodeMultiMap &	getQmlTypeMap (const QString &key)
	Find the key in the map of new QML type maps, and return a reference to the value, which is a NodeMap.
const NodeMultiMap &	getSinceMap (const QString &key)
	Find the key in the map of new {since} maps, and return a reference to the value, which is a NodeMultiMap.
Aggregate *	findRelatesNode (const QStringList &path)
void	resolveStuff ()
	Performs several housekeeping tasks prior to generating the documentation.
void	insertTarget (const QString &name, const QString &title, TargetRec::TargetType type, Node *node, int priority)
const Node *	findNodeForAtom (const Atom atom, const Node relative, QString &ref, Genus genus=Genus::DontCare)
	Searches for the node that matches the path in atom and the specified genus.
ClassNode *	findClassNode (const QStringList &path)
Node *	findNodeForInclude (const QStringList &path)
const FunctionNode *	findFunctionNode (const QString &target, const Node *relative, Genus genus)
	Finds the function node for the qualified function path in target and returns a pointer to it.
const Node *	findTypeNode (const QString &type, const Node *relative, Genus genus)
	This function is called for autolinking to a type, which could be a function return type or a parameter type.
const Node *	findNodeForTarget (const QString &target, const Node *relative)
	Finds the node that will generate the documentation that contains the target and returns a pointer to it.
const PageNode *	findPageNodeByTitle (const QString &title)
Node *	findNodeByNameAndType (const QStringList &path, bool(Node::*isMatch)() const)
const CollectionNode *	getCollectionNode (const QString &name, NodeType type)
const CollectionNode *	getModuleNode (const Node *relative)
	Returns the collection node representing the module that relative node belongs to, or `nullptr` if there is no such module in the primary tree.
FunctionNode *	findFunctionNodeForTag (const QString &tag)
FunctionNode *	findMacroNode (const QString &t)
QStringList	groupNamesForNode (Node *node)
void	addPropertyFunction (PropertyNode *property, const QString &funcName, PropertyNode::FunctionRole funcRole)
void	setVersion (const QString &v)
QString	version () const
void	readIndexes (const QStringList &indexFiles)
	Reads and parses the qdoc index files listed in indexFiles.
void	generateIndex (const QString &fileName, const QString &url, const QString &title, const Generator *hrefGenerator)
	Generates a qdoc index file and writes it to fileName.
void	processForest ()
	This function calls a set of functions for each tree in the forest that has not already been analyzed.
NamespaceNode *	primaryTreeRoot ()
	Returns a pointer to the root node of the primary tree.
void	newPrimaryTree (const QString &module)
void	setPrimaryTree (const QString &t)
NamespaceNode *	newIndexTree (const QString &module)
const QList< Tree * > &	searchOrder ()
void	setLocalSearch ()
void	setSearchOrder (const QList< Tree * > &searchOrder)
void	setSearchOrder (QStringList &t)
void	mergeCollections (NodeType type, CNMap &cnm, const Node *relative)
	Finds all the collection nodes of the specified type and merges them into the collection node map cnm.
void	mergeCollections (CollectionNode *c)
	Finds all the collection nodes with the same name and type as c and merges their members into the members list of c.
void	clearSearchOrder ()
QStringList	keys ()
void	resolveNamespaces ()
	Multiple namespace nodes for namespace X can exist in the qdoc database in different trees.
void	resolveProxies ()
	Each instance of class Tree that represents an index file must be traversed to find all instances of class ProxyNode.
void	resolveBaseClasses ()
void	updateNavigation ()
	Updates navigation (previous/next page links and the navigation parent) for pages listed in the TOC, specified by the `navigation.toctitles` configuration variable.
Tree *	primaryTree ()

Static Public Member Functions
static QDocDatabase *	qdocDB ()
	Creates the singleton.
static void	destroyQdocDB ()
	Destroys the singleton.
static NodeMultiMap &	obsoleteClasses ()
static NodeMultiMap &	obsoleteQmlTypes ()
static NodeMultiMap &	classesWithObsoleteMembers ()
static NodeMultiMap &	qmlTypesWithObsoleteMembers ()
static NodeMultiMap &	cppClasses ()
static NodeMultiMap &	qmlBasicTypes ()
static NodeMultiMap &	qmlTypes ()
static NodeMultiMap &	examples ()
static NodeMultiMapMap &	newClassMaps ()
static NodeMultiMapMap &	newQmlTypeMaps ()
static NodeMultiMapMap &	newEnumValueMaps ()
static NodeMultiMapMap &	newSinceMaps ()

Friends
class	Tree

Detailed Description

This class provides exclusive access to the qdoc database, which consists of a forrest of trees and a lot of maps and other useful data structures.

Definition at line 175 of file qdocdatabase.h.

Member Typedef Documentation

◆ FindFunctionPtr

using QDocDatabase::FindFunctionPtr = void (QDocDatabase::*)(Aggregate *)

Definition at line 182 of file qdocdatabase.h.

Constructor & Destructor Documentation

◆ ~QDocDatabase()

QDocDatabase::~QDocDatabase ( )

default

Member Function Documentation

◆ addExampleNode()

void QDocDatabase::addExampleNode ( ExampleNode * n )

inline

Definition at line 207 of file qdocdatabase.h.

References primaryTree().

Referenced by CppCodeParser::processMetaCommands().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addGroup()

CollectionNode * QDocDatabase::addGroup ( const QString & name )

inline

Looks up the group named name in the primary tree.

If a match is found, a pointer to the node is returned. Otherwise, a new group node named name is created and inserted into the collection, and the pointer to that node is returned.

Definition at line 190 of file qdocdatabase.h.

References primaryTree().

Here is the call graph for this function:

◆ addModule()

CollectionNode * QDocDatabase::addModule ( const QString & name )

inline

Looks up the module named name in the primary tree.

If a match is found, a pointer to the node is returned. Otherwise, a new module node named name is created and inserted into the collection, and the pointer to that node is returned.

Definition at line 191 of file qdocdatabase.h.

References primaryTree().

Here is the call graph for this function:

◆ addPropertyFunction()

void QDocDatabase::addPropertyFunction	(	PropertyNode *	property,
		const QString &	funcName,
		PropertyNode::FunctionRole	funcRole )

inline

Definition at line 329 of file qdocdatabase.h.

References primaryTree().

Here is the call graph for this function:

◆ addQmlModule()

CollectionNode * QDocDatabase::addQmlModule ( const QString & name )

inline

Looks up the QML module named name in the primary tree.

If a match is found, a pointer to the node is returned. Otherwise, a new QML module node named name is created and inserted into the collection, and the pointer to that node is returned.

Definition at line 192 of file qdocdatabase.h.

References primaryTree().

Here is the call graph for this function:

◆ addToGroup()

CollectionNode * QDocDatabase::addToGroup	(	const QString &	name,
		Node *	node )

inline

Looks up the group node named name in the collection of all group nodes.

If a match is not found, a new group node named name is created and inserted into the collection. Then append node to the group's members list, and append the group node to the member list of the node. The parent of the node is not changed by this function. Returns a pointer to the group node.

Definition at line 194 of file qdocdatabase.h.

References primaryTree().

Here is the call graph for this function:

◆ addToModule()

CollectionNode * QDocDatabase::addToModule	(	const QString &	name,
		Node *	node )

inline

Looks up the module node named name in the collection of all module nodes.

If a match is not found, a new module node named name is created and inserted into the collection. Then append node to the module's members list. The parent of node is not changed by this function. Returns the module node.

Definition at line 198 of file qdocdatabase.h.

References primaryTree().

Here is the call graph for this function:

◆ addToQmlModule()

CollectionNode * QDocDatabase::addToQmlModule	(	const QString &	name,
		Node *	node )

inline

Looks up the QML module named name.

If it isn't there, create it. Then append node to the QML module's member list. The parent of node is not changed by this function.

Definition at line 202 of file qdocdatabase.h.

References primaryTree().

Here is the call graph for this function:

◆ classesWithObsoleteMembers()

NodeMultiMap & QDocDatabase::classesWithObsoleteMembers ( )

inlinestatic

Definition at line 220 of file qdocdatabase.h.

◆ clearSearchOrder()

void QDocDatabase::clearSearchOrder ( )

inline

Definition at line 354 of file qdocdatabase.h.

Referenced by processQdocconfFile().

Here is the caller graph for this function:

◆ cppClasses()

NodeMultiMap & QDocDatabase::cppClasses ( )

inlinestatic

Definition at line 222 of file qdocdatabase.h.

◆ destroyQdocDB()

void QDocDatabase::destroyQdocDB ( )

static

Destroys the singleton.

Definition at line 381 of file qdocdatabase.cpp.

Referenced by main().

Here is the caller graph for this function:

◆ exampleNodeMap()

ExampleNodeMap & QDocDatabase::exampleNodeMap ( )

inline

Definition at line 208 of file qdocdatabase.h.

References primaryTree().

Referenced by ManifestWriter::generateExampleManifestFile(), and ManifestWriter::generateManifestFiles().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ examples()

NodeMultiMap & QDocDatabase::examples ( )

inlinestatic

Definition at line 225 of file qdocdatabase.h.

◆ findClassNode()

ClassNode * QDocDatabase::findClassNode ( const QStringList & path )

inline

Definition at line 287 of file qdocdatabase.h.

◆ findFunctionNode()

const FunctionNode * QDocDatabase::findFunctionNode	(	const QString &	target,
		const Node *	relative,
		Genus	genus )

Finds the function node for the qualified function path in target and returns a pointer to it.

The target is a function signature with or without parameters but without the return type.

relative is the node in the primary tree where the search begins. It is not used in the other trees, if the node is not found in the primary tree. genus can be used to force the search to find a C++ function or a QML function.

The entire forest is searched, but the first match is accepted.

Definition at line 1102 of file qdocdatabase.cpp.

◆ findFunctionNodeForTag()

FunctionNode * QDocDatabase::findFunctionNodeForTag ( const QString & tag )

inline

Definition at line 307 of file qdocdatabase.h.

References primaryTree().

Here is the call graph for this function:

◆ findMacroNode()

FunctionNode * QDocDatabase::findMacroNode ( const QString & t )

inline

Definition at line 311 of file qdocdatabase.h.

References primaryTree().

Here is the call graph for this function:

◆ findNodeByNameAndType()

Node * QDocDatabase::findNodeByNameAndType	(	const QStringList &	path,
		bool(Node::*	isMatch )() const )

inline

Definition at line 297 of file qdocdatabase.h.

◆ findNodeForAtom()

const Node * QDocDatabase::findNodeForAtom	(	const Atom *	atom,
		const Node *	relative,
		QString &	ref,
		Genus	genus = Genus::DontCare )

Searches for the node that matches the path in atom and the specified genus.

The relative node is used if the first leg of the path is empty, i.e. if the path begins with '#'. The function also sets ref if there remains an unused leg in the path after the node is found. The node is returned as well as the ref. If the returned node pointer is null, ref is also not valid.

Definition at line 1491 of file qdocdatabase.cpp.

References Atom::domain(), Atom::genus(), Atom::isLinkAtom(), Node< _Tp >::isPageNode(), Node< _Tp >::root(), SearchBaseClasses, SearchEnumValues, and Node< _Tp >::tree().

Here is the call graph for this function:

◆ findNodeForInclude()

Node * QDocDatabase::findNodeForInclude ( const QStringList & path )

inline

Definition at line 288 of file qdocdatabase.h.

◆ findNodeForTarget()

const Node * QDocDatabase::findNodeForTarget	(	const QString &	target,
		const Node *	relative )

Finds the node that will generate the documentation that contains the target and returns a pointer to it.

Can this be improved by using the target map in Tree?

Definition at line 1186 of file qdocdatabase.cpp.

References SearchBaseClasses, and SearchEnumValues.

◆ findPageNodeByTitle()

const PageNode * QDocDatabase::findPageNodeByTitle ( const QString & title )

inline

Definition at line 293 of file qdocdatabase.h.

◆ findQmlType() [1/3]

QmlTypeNode * QDocDatabase::findQmlType	(	const ImportRec &	import,
		const QString &	name,
		const Node *	relative = nullptr )

◆ findQmlType() [2/3]

QmlTypeNode * QDocDatabase::findQmlType	(	const QString &	name,
		const Node *	relative = nullptr )

inline

Definition at line 210 of file qdocdatabase.h.

◆ findQmlType() [3/3]

QmlTypeNode * QDocDatabase::findQmlType	(	const QString &	qmid,
		const QString &	name,
		const Node *	relative = nullptr )

Returns the QML type node identified by the QML module id qmid and QML type name, or nullptr if no type was found.

If the QML module id is empty, looks up the QML type by name only.

Definition at line 639 of file qdocdatabase.cpp.

◆ findQmlTypeInPrimaryTree()

QmlTypeNode * QDocDatabase::findQmlTypeInPrimaryTree	(	const QString &	qmid,
		const QString &	name )

Returns the QML node identified by the QML module id qmid and name, searching in the primary tree only.

If qmid is an empty string, searches for the node using name only.

Returns nullptr if no node was found.

Definition at line 687 of file qdocdatabase.cpp.

References primaryTree(), primaryTreeRoot(), and TypesOnly.

Here is the call graph for this function:

◆ findRelatesNode()

Aggregate * QDocDatabase::findRelatesNode ( const QStringList & path )

inlinenodiscard

Definition at line 259 of file qdocdatabase.h.

◆ findTree()

Tree * QDocDatabase::findTree ( const QString & t )

inline

Definition at line 184 of file qdocdatabase.h.

◆ findTypeNode()

const Node * QDocDatabase::findTypeNode	(	const QString &	type,
		const Node *	relative,
		Genus	genus )

This function is called for autolinking to a type, which could be a function return type or a parameter type.

The tree node that represents the type is returned. All the trees are searched until a match is found. When searching the primary tree, the search begins at relative and proceeds up the parent chain. When searching the index trees, the search begins at the root.

Definition at line 1129 of file qdocdatabase.cpp.

References Node< _Tp >::genus(), QmlTypeNode::importList(), and Node< _Tp >::isQmlType().

Here is the call graph for this function:

◆ generateIndex()

void QDocDatabase::generateIndex	(	const QString &	fileName,
		const QString &	url,
		const QString &	title,
		const Generator *	hrefGenerator )

Generates a qdoc index file and writes it to fileName.

The index file is generated with the parameters url, title, and hrefGenerator.

The hrefGenerator is used to compute document locations (hrefs) for nodes. For index files, this should be the HTML generator to ensure correct .html file extensions in the generated hrefs. If null, defaults to the HTML generator.

Definition at line 1248 of file qdocdatabase.cpp.

References primaryTree().

Here is the call graph for this function:

◆ getAttributions()

NodeMultiMap & QDocDatabase::getAttributions ( )

Returns a reference to the multimap of attribution nodes.

Definition at line 796 of file qdocdatabase.cpp.

◆ getClassesWithObsoleteMembers()

NodeMultiMap & QDocDatabase::getClassesWithObsoleteMembers ( )

Returns a reference to the map of C++ classes with obsolete members.

Definition at line 742 of file qdocdatabase.cpp.

◆ getClassMap()

const NodeMultiMap & QDocDatabase::getClassMap ( const QString & key )

Find the key in the map of new class maps, and return a reference to the value, which is a NodeMap.

If key is not found, return a reference to an empty NodeMap.

Definition at line 870 of file qdocdatabase.cpp.

References emptyNodeMultiMap_.

◆ getCollectionNode()

const CollectionNode * QDocDatabase::getCollectionNode	(	const QString &	name,
		NodeType	type )

inline

Definition at line 301 of file qdocdatabase.h.

◆ getCppClasses()

NodeMultiMap & QDocDatabase::getCppClasses ( )

Returns a reference to the map of all C++ classes.

Definition at line 814 of file qdocdatabase.cpp.

◆ getExamples()

NodeMultiMap & QDocDatabase::getExamples ( )

Returns a reference to the multimap of example nodes.

Definition at line 787 of file qdocdatabase.cpp.

◆ getFunctionIndex()

NodeMapMap & QDocDatabase::getFunctionIndex ( )

Returns the function index.

This data structure is used to output the function index page.

Definition at line 824 of file qdocdatabase.cpp.

◆ getLegaleseTexts()

TextToNodeMap & QDocDatabase::getLegaleseTexts ( )

Returns a reference to the collection of legalese texts.

Definition at line 733 of file qdocdatabase.cpp.

◆ getModuleNode()

const CollectionNode * QDocDatabase::getModuleNode ( const Node * relative )

Returns the collection node representing the module that relative node belongs to, or nullptr if there is no such module in the primary tree.

Definition at line 1272 of file qdocdatabase.cpp.

References Node< _Tp >::genus(), Module, primaryTree(), and QmlModule.

Here is the call graph for this function:

◆ getNamespaces()

NodeMultiMap & QDocDatabase::getNamespaces ( )

Returns a reference to the namespace map.

Constructs the namespace map if it hasn't been constructed yet.

Note: This function must not be called in the prepare phase.

Definition at line 959 of file qdocdatabase.cpp.

References resolveNamespaces().

Here is the call graph for this function:

◆ getObsoleteClasses()

NodeMultiMap & QDocDatabase::getObsoleteClasses ( )

Returns a reference to the map of obsolete C++ clases.

Definition at line 805 of file qdocdatabase.cpp.

◆ getObsoleteQmlTypes()

NodeMultiMap & QDocDatabase::getObsoleteQmlTypes ( )

Returns a reference to the map of obsolete QML types.

Definition at line 751 of file qdocdatabase.cpp.

◆ getQmlTypeMap()

const NodeMultiMap & QDocDatabase::getQmlTypeMap ( const QString & key )

Find the key in the map of new QML type maps, and return a reference to the value, which is a NodeMap.

If the key is not found, return a reference to an empty NodeMap.

Definition at line 882 of file qdocdatabase.cpp.

References emptyNodeMultiMap_.

◆ getQmlTypes()

NodeMultiMap & QDocDatabase::getQmlTypes ( )

Returns a reference to the multimap of QML types.

Definition at line 778 of file qdocdatabase.cpp.

◆ getQmlTypesWithObsoleteMembers()

NodeMultiMap & QDocDatabase::getQmlTypesWithObsoleteMembers ( )

Returns a reference to the map of QML types with obsolete members.

Definition at line 760 of file qdocdatabase.cpp.

◆ getQmlValueTypes()

NodeMultiMap & QDocDatabase::getQmlValueTypes ( )

Returns a reference to the map of QML basic types.

Definition at line 769 of file qdocdatabase.cpp.

Referenced by QmlPropertyNode::validateDataType().

Here is the caller graph for this function:

◆ getSinceMap()

const NodeMultiMap & QDocDatabase::getSinceMap ( const QString & key )

Find the key in the map of new {since} maps, and return a reference to the value, which is a NodeMultiMap.

If key is not found, return a reference to an empty NodeMultiMap.

Definition at line 894 of file qdocdatabase.cpp.

References emptyNodeMultiMap_.

◆ groupNamesForNode()

QStringList QDocDatabase::groupNamesForNode ( Node * node )

Definition at line 1207 of file qdocdatabase.cpp.

References Group, and primaryTree().

Here is the call graph for this function:

◆ groups()

const CNMap & QDocDatabase::groups ( )

inline

Returns a const reference to the collection of all group nodes in the primary tree.

Definition at line 186 of file qdocdatabase.h.

References primaryTree().

Here is the call graph for this function:

◆ insertTarget()

void QDocDatabase::insertTarget	(	const QString &	name,
		const QString &	title,
		TargetRec::TargetType	type,
		Node *	node,
		int	priority )

inline

Definition at line 269 of file qdocdatabase.h.

References primaryTree().

Here is the call graph for this function:

◆ keys()

QStringList QDocDatabase::keys ( )

inline

Definition at line 355 of file qdocdatabase.h.

◆ mergeCollections() [1/2]

void QDocDatabase::mergeCollections ( CollectionNode * c )

Finds all the collection nodes with the same name and type as c and merges their members into the members list of c.

For QML modules, only nodes with matching module identifiers are merged to avoid merging modules with different (major) versions.

Definition at line 1360 of file qdocdatabase.cpp.

References CollectionNode::isMerged(), and CollectionNode::markMerged().

Here is the call graph for this function:

◆ mergeCollections() [2/2]

void QDocDatabase::mergeCollections	(	NodeType	type,
		CNMap &	cnm,
		const Node *	relative )

Finds all the collection nodes of the specified type and merges them into the collection node map cnm.

Nodes that match the relative node are not included.

Definition at line 1300 of file qdocdatabase.cpp.

◆ modules()

const CNMap & QDocDatabase::modules ( )

inline

Returns a const reference to the collection of all module nodes in the primary tree.

Definition at line 187 of file qdocdatabase.h.

References primaryTree().

Here is the call graph for this function:

◆ newClassMaps()

NodeMultiMapMap & QDocDatabase::newClassMaps ( )

inlinestatic

Definition at line 226 of file qdocdatabase.h.

◆ newEnumValueMaps()

NodeMultiMapMap & QDocDatabase::newEnumValueMaps ( )

inlinestatic

Definition at line 228 of file qdocdatabase.h.

◆ newIndexTree()

NamespaceNode * QDocDatabase::newIndexTree ( const QString & module )

inline

Definition at line 347 of file qdocdatabase.h.

◆ newPrimaryTree()

void QDocDatabase::newPrimaryTree ( const QString & module )

inline

Definition at line 345 of file qdocdatabase.h.

◆ newQmlTypeMaps()

NodeMultiMapMap & QDocDatabase::newQmlTypeMaps ( )

inlinestatic

Definition at line 227 of file qdocdatabase.h.

◆ newSinceMaps()

NodeMultiMapMap & QDocDatabase::newSinceMaps ( )

inlinestatic

Definition at line 229 of file qdocdatabase.h.

◆ obsoleteClasses()

NodeMultiMap & QDocDatabase::obsoleteClasses ( )

inlinestatic

Definition at line 218 of file qdocdatabase.h.

◆ obsoleteQmlTypes()

NodeMultiMap & QDocDatabase::obsoleteQmlTypes ( )

inlinestatic

Definition at line 219 of file qdocdatabase.h.

◆ primaryTree()

Tree * QDocDatabase::primaryTree ( )

inline

Definition at line 374 of file qdocdatabase.h.

Referenced by addExampleNode(), addGroup(), addModule(), addPropertyFunction(), addQmlModule(), addToGroup(), addToModule(), addToQmlModule(), exampleNodeMap(), findFunctionNodeForTag(), findMacroNode(), findQmlTypeInPrimaryTree(), generateIndex(), getModuleNode(), groupNamesForNode(), groups(), insertTarget(), modules(), qmlModules(), NativeEnum::resolve(), resolveBaseClasses(), and resolveStuff().

Here is the caller graph for this function:

◆ primaryTreeRoot()

NamespaceNode * QDocDatabase::primaryTreeRoot ( )

inline

Returns a pointer to the root node of the primary tree.

Definition at line 344 of file qdocdatabase.h.

Referenced by ClangVisitor::ClangVisitor(), QmlDocVisitor::QmlDocVisitor(), findNodeForCursor(), findQmlTypeInPrimaryTree(), Generator::generateDocs(), CppCodeParser::parseMacroArg(), processQdocconfFile(), CppCodeParser::processTopicCommand(), and resolveStuff().

Here is the caller graph for this function:

◆ processForest()

void QDocDatabase::processForest ( )

This function calls a set of functions for each tree in the forest that has not already been analyzed.

In this way, when running qdoc in singleExec mode, each tree is analyzed in turn, and its classes and types are added to the appropriate node maps.

Definition at line 701 of file qdocdatabase.cpp.

References resolveNamespaces().

Referenced by singleExecutionMode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ qdocDB()

QDocDatabase * QDocDatabase::qdocDB ( )

static

Creates the singleton.

Allows only one instance of the class to be created. Returns a pointer to the singleton.

Definition at line 369 of file qdocdatabase.cpp.

Referenced by CodeParser::CodeParser(), ManifestWriter::ManifestWriter(), QmlDocVisitor::QmlDocVisitor(), TOCWriter::TOCWriter(), checkModuleInclusion(), findOrCreateQmlType(), DocBookGenerator::generateAtom(), HtmlGenerator::generateAtom(), generateIndexFile(), FnMatchError::isParentInternal(), loadIndexFiles(), CppCodeParser::parseMacroArg(), CppCodeParser::processMetaCommand(), CppCodeParser::processMetaCommands(), processQdocconfFile(), CppCodeParser::processTopicCommand(), ClassNode::removePrivateAndInternalBases(), HelpProjectWriter::reset(), NativeEnum::resolve(), QmlTypeNode::resolveInheritance(), Aggregate::resolveRelates(), singleExecutionMode(), and QmlPropertyNode::validateDataType().

Here is the caller graph for this function:

◆ qmlBasicTypes()

NodeMultiMap & QDocDatabase::qmlBasicTypes ( )

inlinestatic

Definition at line 223 of file qdocdatabase.h.

◆ qmlModules()

const CNMap & QDocDatabase::qmlModules ( )

inline

Returns a const reference to the collection of all QML module nodes in the primary tree.

Definition at line 188 of file qdocdatabase.h.

References primaryTree().

Here is the call graph for this function:

◆ qmlTypes()

NodeMultiMap & QDocDatabase::qmlTypes ( )

inlinestatic

Definition at line 224 of file qdocdatabase.h.

◆ qmlTypesWithObsoleteMembers()

NodeMultiMap & QDocDatabase::qmlTypesWithObsoleteMembers ( )

inlinestatic

Definition at line 221 of file qdocdatabase.h.

◆ readIndexes()

void QDocDatabase::readIndexes ( const QStringList & indexFiles )

Reads and parses the qdoc index files listed in indexFiles.

Definition at line 1225 of file qdocdatabase.cpp.

◆ resolveBaseClasses()

void QDocDatabase::resolveBaseClasses ( )

Definition at line 942 of file qdocdatabase.cpp.

References primaryTree(), and Aggregate::resolveQmlInheritance().

Referenced by resolveStuff().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resolveNamespaces()

void QDocDatabase::resolveNamespaces ( )

Multiple namespace nodes for namespace X can exist in the qdoc database in different trees.

This function first finds all namespace nodes in all the trees and inserts them into a multimap. Then it combines all the namespace nodes that have the same name into a single namespace node of that name and inserts that combined namespace node into an index.

Definition at line 973 of file qdocdatabase.cpp.

References Aggregate::findAllNamespaces().

Referenced by getNamespaces(), processForest(), and resolveStuff().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resolveProxies()

void QDocDatabase::resolveProxies ( )

Each instance of class Tree that represents an index file must be traversed to find all instances of class ProxyNode.

For each ProxyNode found, look up the ProxyNode's name in the primary Tree. If it is found, it means that the proxy node contains elements (normally just functions) that are documented in the module represented by the Tree containing the proxy node but that are related to the node we found in the primary tree.

Definition at line 1067 of file qdocdatabase.cpp.

References Tree::proxies().

Referenced by resolveStuff().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resolveStuff()

void QDocDatabase::resolveStuff ( )

Performs several housekeeping tasks prior to generating the documentation.

These tasks create required data structures and resolve links.

Definition at line 906 of file qdocdatabase.cpp.

References Tree::markDontDocumentNodes(), Aggregate::markUndocumentedChildrenInternal(), Aggregate::normalizeOverloads(), primaryTree(), primaryTreeRoot(), resolveBaseClasses(), resolveNamespaces(), resolveProxies(), Aggregate::resolveQmlInheritance(), Aggregate::resolveRelates(), and updateNavigation().

Referenced by processQdocconfFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ searchOrder()

const QList< Tree * > & QDocDatabase::searchOrder ( )

inline

Definition at line 348 of file qdocdatabase.h.

◆ setLocalSearch()

void QDocDatabase::setLocalSearch ( )

inline

Definition at line 349 of file qdocdatabase.h.

Referenced by updateNavigation().

Here is the caller graph for this function:

◆ setPrimaryTree()

void QDocDatabase::setPrimaryTree ( const QString & t )

inline

Definition at line 346 of file qdocdatabase.h.

◆ setSearchOrder() [1/2]

void QDocDatabase::setSearchOrder ( const QList< Tree * > & searchOrder )

inline

Definition at line 350 of file qdocdatabase.h.

◆ setSearchOrder() [2/2]

void QDocDatabase::setSearchOrder ( QStringList & t )

inline

Definition at line 351 of file qdocdatabase.h.

◆ setVersion()

void QDocDatabase::setVersion ( const QString & v )

inline

Definition at line 335 of file qdocdatabase.h.

◆ updateNavigation()

void QDocDatabase::updateNavigation ( )

Updates navigation (previous/next page links and the navigation parent) for pages listed in the TOC, specified by the navigation.toctitles configuration variable.

if navigation.toctitles.inclusive is true, include also the TOC page(s) themselves as a 'root' item in the navigation bar (breadcrumbs) that are generated for HTML output.

Definition at line 1584 of file qdocdatabase.cpp.

References setLocalSearch().

Referenced by resolveStuff().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ version()

QString QDocDatabase::version ( ) const

inlinenodiscard

Definition at line 336 of file qdocdatabase.h.

◆ Tree

friend class Tree

friend

Definition at line 362 of file qdocdatabase.h.

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

qttools/src/qdoc/qdoc/src/qdoc/qdocdatabase.h (5b47e42a539a8ac27ab4f41ab41d813d54ee7c1e)
qttools/src/qdoc/qdoc/src/qdoc/qdocdatabase.cpp (5b47e42a539a8ac27ab4f41ab41d813d54ee7c1e)

Public Types

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Member Typedef Documentation

◆ FindFunctionPtr

Constructor & Destructor Documentation

◆ ~QDocDatabase()

Member Function Documentation

◆ addExampleNode()

◆ addGroup()

◆ addModule()

◆ addPropertyFunction()

◆ addQmlModule()

◆ addToGroup()

◆ addToModule()

◆ addToQmlModule()

◆ classesWithObsoleteMembers()

◆ clearSearchOrder()

◆ cppClasses()

◆ destroyQdocDB()

◆ exampleNodeMap()

◆ examples()

◆ findClassNode()

◆ findFunctionNode()

◆ findFunctionNodeForTag()

◆ findMacroNode()

◆ findNodeByNameAndType()

◆ findNodeForAtom()

◆ findNodeForInclude()

◆ findNodeForTarget()

◆ findPageNodeByTitle()

◆ findQmlType() [1/3]

◆ findQmlType() [2/3]

◆ findQmlType() [3/3]

◆ findQmlTypeInPrimaryTree()

◆ findRelatesNode()

◆ findTree()

◆ findTypeNode()

◆ generateIndex()

◆ getAttributions()

◆ getClassesWithObsoleteMembers()

◆ getClassMap()

◆ getCollectionNode()

◆ getCppClasses()

◆ getExamples()

◆ getFunctionIndex()

◆ getLegaleseTexts()

◆ getModuleNode()

◆ getNamespaces()

◆ getObsoleteClasses()

◆ getObsoleteQmlTypes()

◆ getQmlTypeMap()

◆ getQmlTypes()

◆ getQmlTypesWithObsoleteMembers()

◆ getQmlValueTypes()

◆ getSinceMap()

◆ groupNamesForNode()

◆ groups()

◆ insertTarget()

◆ keys()

◆ mergeCollections() [1/2]

◆ mergeCollections() [2/2]

◆ modules()

◆ newClassMaps()

◆ newEnumValueMaps()

◆ newIndexTree()

◆ newPrimaryTree()

◆ newQmlTypeMaps()

◆ newSinceMaps()

◆ obsoleteClasses()

◆ obsoleteQmlTypes()

◆ primaryTree()

◆ primaryTreeRoot()

◆ processForest()

◆ qdocDB()

◆ qmlBasicTypes()

◆ qmlModules()

◆ qmlTypes()