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
cppcodeparser.cpp File Reference

(8b1ca61f169b0cf7d85a59817b4cc9c29df38b93)

#include "cppcodeparser.h"
#include "access.h"
#include "qmlenumnode.h"
#include "classnode.h"
#include "clangcodeparser.h"
#include "collectionnode.h"
#include "comparisoncategory.h"
#include "config.h"
#include "examplenode.h"
#include "externalpagenode.h"
#include "functionnode.h"
#include "generator.h"
#include "genustypes.h"
#include "headernode.h"
#include "inclusionfilter.h"
#include "inclusionpolicy.h"
#include "namespacenode.h"
#include "qdocdatabase.h"
#include "qmltypenode.h"
#include "qmlpropertyarguments.h"
#include "qmlpropertynode.h"
#include "sharedcommentnode.h"
#include "utilities.h"
#include <QtCore/qdebug.h>
#include <QtCore/qmap.h>
#include <algorithm>
Include dependency graph for cppcodeparser.cpp:

Go to the source code of this file.

Typedefs

typedef bool(Node::* NodeTypeTestFunc) () const

Functions

QmlTypeNodefindOrCreateQmlType (const QString &moduleName, const QString &name, const Location &location)
 Finds a QmlTypeNode name, under the specific moduleName, from the primary tree.
static void checkModuleInclusion (Node *n)
 For each node that is part of C++ API and produces a documentation page, this function ensures that the node belongs to a module.

Variables

static QT_BEGIN_NAMESPACE const QMap< QString, NodeTypes_nodeTypeMap
static const QMap< QString, NodeTypeTestFuncs_nodeTypeTestFuncMap

Typedef Documentation

◆ NodeTypeTestFunc

typedef bool(Node::* NodeTypeTestFunc)() const

Definition at line 50 of file cppcodeparser.cpp.

Function Documentation

◆ checkModuleInclusion()

void checkModuleInclusion ( Node * n)
static

For each node that is part of C++ API and produces a documentation page, this function ensures that the node belongs to a module.

Definition at line 992 of file cppcodeparser.cpp.

References Class, Node< _Tp >::doc(), HeaderFile, Node< _Tp >::isInAPI(), Doc::location(), Namespace, Node< _Tp >::nodeType(), QDocDatabase::qdocDB(), Struct, and Union.

Here is the call graph for this function:

◆ findOrCreateQmlType()

QmlTypeNode * findOrCreateQmlType ( const QString & moduleName,
const QString & name,
const Location & location )

Finds a QmlTypeNode name, under the specific moduleName, from the primary tree.

If one is not found, creates one.

Returns the found or created node.

Definition at line 221 of file cppcodeparser.cpp.

References QDocDatabase::qdocDB(), and Node< _Tp >::setLocation().

Here is the call graph for this function:

Variable Documentation

◆ s_nodeTypeMap

QT_BEGIN_NAMESPACE const QMap< QString, NodeType > s_nodeTypeMap
static
Initial value:

Definition at line 42 of file cppcodeparser.cpp.

◆ s_nodeTypeTestFuncMap

const QMap< QString, NodeTypeTestFunc > s_nodeTypeTestFuncMap
static
Initial value:
{
}
bool isNamespace() const
Returns true if the node type is Namespace.
Definition node.h:108
bool isTypedef() const
Returns true if the node type is Typedef.
Definition node.h:126
bool isEnumType() const
Returns true if the node type is Enum.
Definition node.h:93
bool isStruct() const
Returns true if the node type is Struct.
Definition node.h:123
bool isVariable() const
Returns true if the node type is Variable.
Definition node.h:131
bool isProperty() const
Returns true if the node type is Property.
Definition node.h:112
bool isTypeAlias() const
Returns true if the node type is Typedef.
Definition node.h:125
virtual bool isClassNode() const
Returns true if this is an instance of ClassNode.
Definition node.h:143
bool isUnion() const
Returns true if the node type is Union.
Definition node.h:130

Definition at line 51 of file cppcodeparser.cpp.