aboutsummaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorJerome Pasion <jerome.pasion@qt.io>2025-11-03 15:24:21 +0100
committerJerome Pasion <jerome.pasion@qt.io>2025-11-07 09:34:15 +0100
commit738e7b06b5282c3fd615acdfdc456dfc1a05c5ef (patch)
tree209b63c6469c77fcb5e6ea86725a84ed0dcb8d2b /src
parent6852645ee8f551970c78166a578a1d60fbc24b65 (diff)
Doc: Fix QDoc warnings for internal classes and functions
-Mark internal functions with \internal -Sometimes the solution is to have a \class command and marked internal -Fixed whitespace issues when the new marking introduced them Task-number: QTBUG-141665 Change-Id: I4f744aa94ca679da74b6c5e846e49a73346e2625 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
Diffstat (limited to 'src')
-rw-r--r--src/plugins/qmltooling/qmldbg_profiler/qqmlprofilerservice.cpp5
-rw-r--r--src/qml/debugger/qqmldebugservice.cpp5
-rw-r--r--src/qml/jsruntime/qv4engine.cpp5
-rw-r--r--src/qml/jsruntime/qv4resolvedtypereference.cpp4
-rw-r--r--src/qml/qml/ftw/qqmlthread_impl.cpp6
-rw-r--r--src/qml/qml/qqmlabstractbinding.cpp5
-rw-r--r--src/qml/qml/qqmlboundsignal.cpp6
-rw-r--r--src/qml/qml/qqmlincubator.cpp16
-rw-r--r--src/qml/qml/qqmlmetatype.cpp6
-rw-r--r--src/qml/qml/qqmlproperty.cpp6
-rw-r--r--src/qml/qml/qqmlpropertycache.cpp1
-rw-r--r--src/qml/qml/qqmlvaluetypeproxybinding.cpp4
-rw-r--r--src/qml/qmldirparser/qqmldirparser.cpp3
-rw-r--r--src/qmlcompiler/qqmljsmetatypes.cpp2
-rw-r--r--src/qmlcompiler/qqmlsa.cpp1
15 files changed, 59 insertions, 16 deletions
diff --git a/src/plugins/qmltooling/qmldbg_profiler/qqmlprofilerservice.cpp b/src/plugins/qmltooling/qmldbg_profiler/qqmlprofilerservice.cpp
index 1bb4c03cc8..4d9c73e2ea 100644
--- a/src/plugins/qmltooling/qmldbg_profiler/qqmlprofilerservice.cpp
+++ b/src/plugins/qmltooling/qmldbg_profiler/qqmlprofilerservice.cpp
@@ -21,6 +21,11 @@ QT_BEGIN_NAMESPACE
Q_QML_DEBUG_PLUGIN_LOADER(QQmlAbstractProfilerAdapter)
+/*!
+ \class QQmlProfilerServiceImpl
+ \inmodule QtQml
+ \internal
+*/
QQmlProfilerServiceImpl::QQmlProfilerServiceImpl(QObject *parent) :
QQmlConfigurableDebugService<QQmlProfilerService>(1, parent),
m_waitingForStop(false), m_globalEnabled(false), m_globalFeatures(0)
diff --git a/src/qml/debugger/qqmldebugservice.cpp b/src/qml/debugger/qqmldebugservice.cpp
index 56cffc169c..ffc8daa877 100644
--- a/src/qml/debugger/qqmldebugservice.cpp
+++ b/src/qml/debugger/qqmldebugservice.cpp
@@ -111,6 +111,7 @@ void ObjectReferenceHash::remove(QObject *obj)
}
/*!
+ \internal
Returns a unique id for \a object. Calling this method multiple times
for the same object will return the same id.
*/
@@ -132,7 +133,9 @@ int QQmlDebugService::idForObject(QObject *object)
}
/*!
- Returns the mapping of objects to unique \a ids, created through calls to idForObject().
+ \internal
+ Returns the mapping of objects to unique \a ids, created through
+ calls to idForObject().
*/
const QHash<int, QObject *> &QQmlDebugService::objectsForIds()
{
diff --git a/src/qml/jsruntime/qv4engine.cpp b/src/qml/jsruntime/qv4engine.cpp
index cae6cb992f..a3cd7e64cd 100644
--- a/src/qml/jsruntime/qv4engine.cpp
+++ b/src/qml/jsruntime/qv4engine.cpp
@@ -347,6 +347,11 @@ void ExecutionEngine::initializeStaticMembers()
QMetaType::registerConverter<QJSValue, QSequentialIterable>(jsvalueToSequence);
}
+/*!
+ \class QV4::ExecutionEngine
+ \inmodule QtQml
+ \internal
+*/
ExecutionEngine::ExecutionEngine(QJSEngine *jsEngine)
: executableAllocator(new QV4::ExecutableAllocator)
, regExpAllocator(new QV4::ExecutableAllocator)
diff --git a/src/qml/jsruntime/qv4resolvedtypereference.cpp b/src/qml/jsruntime/qv4resolvedtypereference.cpp
index 0fcbbcbfae..ac6773d044 100644
--- a/src/qml/jsruntime/qv4resolvedtypereference.cpp
+++ b/src/qml/jsruntime/qv4resolvedtypereference.cpp
@@ -33,7 +33,9 @@ void ResolvedTypeReference::doDynamicTypeCheck()
}
/*!
-Returns the property cache, creating one if it doesn't already exist. The cache is not referenced.
+ \internal
+ Returns the property cache, creating one if it doesn't already exist. The
+ cache is not referenced.
*/
QQmlPropertyCache::ConstPtr ResolvedTypeReference::createPropertyCache()
{
diff --git a/src/qml/qml/ftw/qqmlthread_impl.cpp b/src/qml/qml/ftw/qqmlthread_impl.cpp
index 1114e71e29..30da0a6301 100644
--- a/src/qml/qml/ftw/qqmlthread_impl.cpp
+++ b/src/qml/qml/ftw/qqmlthread_impl.cpp
@@ -236,8 +236,10 @@ QThread *QQmlThread::thread() const
}
/*!
- * And object living in the QML thread, in case you want to parent other objects to it.
- */
+ \internal
+ An object living in the QML thread, in case you want to parent
+ other objects to it.
+*/
QObject *QQmlThread::threadObject() const
{
return &d->m_threadObject;
diff --git a/src/qml/qml/qqmlabstractbinding.cpp b/src/qml/qml/qqmlabstractbinding.cpp
index d1c0a855d1..ba8d7d76c7 100644
--- a/src/qml/qml/qqmlabstractbinding.cpp
+++ b/src/qml/qml/qqmlabstractbinding.cpp
@@ -10,6 +10,11 @@
QT_BEGIN_NAMESPACE
+/*!
+ \class QQmlAbstractBinding
+ \inmodule QtQml
+ \internal
+*/
QQmlAbstractBinding::QQmlAbstractBinding()
: m_targetIndex(-1)
{
diff --git a/src/qml/qml/qqmlboundsignal.cpp b/src/qml/qml/qqmlboundsignal.cpp
index 5050705b3a..e91e343da7 100644
--- a/src/qml/qml/qqmlboundsignal.cpp
+++ b/src/qml/qml/qqmlboundsignal.cpp
@@ -28,6 +28,12 @@ Q_TRACE_POINT(qtqml, QQmlHandlingSignal_entry, const QQmlEngine *engine, const Q
const QString &fileName, int line, int column)
Q_TRACE_POINT(qtqml, QQmlHandlingSignal_exit)
+/*!
+ \class QQmlBoundSignal
+ \inmodule QtQml
+ \internal
+*/
+
QQmlBoundSignalExpression::QQmlBoundSignalExpression(const QObject *target, int index, const QQmlRefPointer<QQmlContextData> &ctxt, QObject *scope,
const QString &expression, const QString &fileName, quint16 line, quint16 column,
const QString &handlerName, const QString &parameterString)
diff --git a/src/qml/qml/qqmlincubator.cpp b/src/qml/qml/qqmlincubator.cpp
index 16fd052512..0748f3b18f 100644
--- a/src/qml/qml/qqmlincubator.cpp
+++ b/src/qml/qml/qqmlincubator.cpp
@@ -715,13 +715,15 @@ QObject *QQmlIncubator::object() const
}
/*!
-Return a pointer to a list of properties which are required but haven't
-been set yet.
-This list can be modified, so that subclasses which implement special logic
-setInitialProperties can mark properties set there as no longer required.
-
-\sa QQmlIncubator::setInitialProperties
-\since 5.15
+ \internal
+ Return a pointer to a list of properties which are required but
+ haven't been set yet.
+ This list can be modified, so that subclasses which implement
+ special logic setInitialProperties can mark properties set there
+ as no longer required.
+
+ \sa QQmlIncubator::setInitialProperties
+ \since 5.15
*/
RequiredProperties *QQmlIncubatorPrivate::requiredProperties()
{
diff --git a/src/qml/qml/qqmlmetatype.cpp b/src/qml/qml/qqmlmetatype.cpp
index 01ace87378..754d2713a7 100644
--- a/src/qml/qml/qqmlmetatype.cpp
+++ b/src/qml/qml/qqmlmetatype.cpp
@@ -20,6 +20,12 @@ Q_STATIC_LOGGING_CATEGORY(lcTypeRegistration, "qt.qml.typeregistration")
QT_BEGIN_NAMESPACE
+/*!
+ \class QQmlMetaType
+ \inmodule QtQml
+ \internal
+*/
+
struct LockedData : private QQmlMetaTypeData
{
friend class QQmlMetaTypeDataPtr;
diff --git a/src/qml/qml/qqmlproperty.cpp b/src/qml/qml/qqmlproperty.cpp
index e7366b74b3..6d7de72a6d 100644
--- a/src/qml/qml/qqmlproperty.cpp
+++ b/src/qml/qml/qqmlproperty.cpp
@@ -80,6 +80,12 @@ qWarning() << "Pixel size should now be 24:" << property.read().toInt();
*/
/*!
+ \class QQmlPropertyPrivate
+ \inmodule QtQml
+ \internal
+*/
+
+/*!
Create an invalid QQmlProperty.
*/
QQmlProperty::QQmlProperty() = default;
diff --git a/src/qml/qml/qqmlpropertycache.cpp b/src/qml/qml/qqmlpropertycache.cpp
index 68b06be95f..aa98f50f15 100644
--- a/src/qml/qml/qqmlpropertycache.cpp
+++ b/src/qml/qml/qqmlpropertycache.cpp
@@ -124,6 +124,7 @@ void QQmlPropertyData::load(const QMetaMethod &m)
}
/*!
+ \internal
Creates a standalone QQmlPropertyCache of \a metaObject. It is separate from the usual
QQmlPropertyCache hierarchy. It's parent is not equal to any other QQmlPropertyCache
created from QObject::staticMetaObject, for example.
diff --git a/src/qml/qml/qqmlvaluetypeproxybinding.cpp b/src/qml/qml/qqmlvaluetypeproxybinding.cpp
index a1cf9f802b..cabceaa63f 100644
--- a/src/qml/qml/qqmlvaluetypeproxybinding.cpp
+++ b/src/qml/qml/qqmlvaluetypeproxybinding.cpp
@@ -47,7 +47,9 @@ QQmlAbstractBinding *QQmlValueTypeProxyBinding::binding(QQmlPropertyIndex proper
}
/*!
-Removes a collection of bindings, corresponding to the set bits in \a mask.
+ \internal
+ Removes a collection of bindings, corresponding to the set bits
+ in \a mask.
*/
void QQmlValueTypeProxyBinding::removeBindings(quint32 mask)
{
diff --git a/src/qml/qmldirparser/qqmldirparser.cpp b/src/qml/qmldirparser/qqmldirparser.cpp
index 7c1fd3d11f..a7a85b60c2 100644
--- a/src/qml/qmldirparser/qqmldirparser.cpp
+++ b/src/qml/qmldirparser/qqmldirparser.cpp
@@ -117,9 +117,6 @@ QString QQmlDirParser::scanQuotedWord(const QChar *&ch, quint16 lineNumber, quin
return result;
}
-/*!
-\a url is used for generating errors.
-*/
bool QQmlDirParser::parse(const QString &source)
{
quint16 lineNumber = 0;
diff --git a/src/qmlcompiler/qqmljsmetatypes.cpp b/src/qmlcompiler/qqmljsmetatypes.cpp
index 843527ea96..2b67925717 100644
--- a/src/qmlcompiler/qqmljsmetatypes.cpp
+++ b/src/qmlcompiler/qqmljsmetatypes.cpp
@@ -11,7 +11,7 @@ QT_BEGIN_NAMESPACE
/*!
\class QQmlJSMetaPropertyBinding
-
+ \inmodule QtQmlCompiler
\internal
Represents a single QML binding of a specific type. Typically, when you
diff --git a/src/qmlcompiler/qqmlsa.cpp b/src/qmlcompiler/qqmlsa.cpp
index dbeb9b0c7d..0da46f32ad 100644
--- a/src/qmlcompiler/qqmlsa.cpp
+++ b/src/qmlcompiler/qqmlsa.cpp
@@ -705,6 +705,7 @@ QQmlJSMetaMethod MethodPrivate::method(const QQmlSA::Method &method)
/*!
\class QQmlSA::PropertyPrivate
+ \inmodule QtQmlCompiler
\internal
*/
PropertyPrivate::PropertyPrivate(Property *iface) : q_ptr{ iface } { }
generated by cgit v1.2.3 (git 2.25.1) at 2025-12-23 10:58:30 +0000