qdocdatabase.h File Reference

(1d94c76327fa0053f88d4e0a0884706753862b35)

#include "config.h"
#include "examplenode.h"
#include "genustypes.h"
#include "propertynode.h"
#include "text.h"
#include "tree.h"
#include <QtCore/qdebug.h>
#include <QtCore/qflags.h>
#include <QtCore/qmap.h>
#include <QtCore/qstring.h>

Include dependency graph for qdocdatabase.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	QDocForest
	A class representing a forest of Tree objects. More...
class	QDocDatabase
	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...

Enumerations
enum	FindFlag {   SearchBaseClasses = 0x1 , SearchEnumValues = 0x2 , TypesOnly = 0x4 , IgnoreModules = 0x8 ,   QmlAttachedProperties = 0x10 }
enum class	LinkReferenceOrigin : unsigned char { Auto , Explicit }
	Specifies whether a link reference passed to the scoped findNodeForTarget() overload was authored in the documentation source or produced automatically. More...

Variables
QT_BEGIN_NAMESPACE typedef QMultiMap< Text, const Node * >	TextToNodeMap

Enumeration Type Documentation

FindFlag

enum FindFlag

Enumerator
SearchBaseClasses
SearchEnumValues
TypesOnly
IgnoreModules
QmlAttachedProperties

Definition at line 28 of file qdocdatabase.h.

LinkReferenceOrigin

enum class LinkReferenceOrigin : unsigned char

strong

Specifies whether a link reference passed to the scoped findNodeForTarget() overload was authored in the documentation source or produced automatically.

\value Auto The reference was produced automatically, such as by autolinking a word in the source text. The lookup keeps the historical interpretation and does not reinterpret QML dot-path notation. \value Explicit The reference was written with a link directive. QML dot-path notation, such as {Type.property}, resolves through the import-aware QML lookup even when no QML genus is stated.

Enumerator
Auto
Explicit

Definition at line 55 of file qdocdatabase.h.

Variable Documentation

TextToNodeMap

QT_BEGIN_NAMESPACE typedef QMultiMap<Text, const Node *> TextToNodeMap

Definition at line 21 of file qdocdatabase.h.