diff options
author | Topi Reinio <topi.reinio@qt.io> | 2018-04-13 10:54:20 +0200 |
---|---|---|
committer | Topi Reiniƶ <topi.reinio@qt.io> | 2018-04-13 12:00:01 +0000 |
commit | c2657d346455a5a7821fbfbe3b1107d7cf9b0949 (patch) | |
tree | 03fdb9bde5c41bf60607550326d83528e7e2f7fa /src/script/api | |
parent | 781c745277f9b4faa87d341b10ec0ca46eb45a73 (diff) | |
download | qtscript-c2657d346455a5a7821fbfbe3b1107d7cf9b0949.tar.gz |
Doc: Fix documentation warningsv5.11.0-beta4
Use complete function signatures for \fn commands (including template
specifiers) as Clang parser now reads them.
Convert internal class documentation comments to standard C-style
comments.
Change-Id: Ie67eb054171139db12f7e74d077b7dc8453582df
Reviewed-by: Martin Smith <martin.smith@qt.io>
Diffstat (limited to 'src/script/api')
-rw-r--r-- | src/script/api/qscriptengine.cpp | 29 | ||||
-rw-r--r-- | src/script/api/qscriptengine.h | 14 | ||||
-rw-r--r-- | src/script/api/qscriptengineagent.cpp | 2 |
3 files changed, 21 insertions, 24 deletions
diff --git a/src/script/api/qscriptengine.cpp b/src/script/api/qscriptengine.cpp index 3719cdf..c5f437b 100644 --- a/src/script/api/qscriptengine.cpp +++ b/src/script/api/qscriptengine.cpp @@ -3869,7 +3869,7 @@ QStringList QScriptEngine::importedExtensions() const return lst; } -/*! \fn QScriptValue QScriptEngine::toScriptValue(const T &value) +/*! \fn template <typename T> QScriptValue QScriptEngine::toScriptValue(const T &value) Creates a QScriptValue with the given \a value. @@ -3885,7 +3885,7 @@ QStringList QScriptEngine::importedExtensions() const \sa fromScriptValue(), qScriptRegisterMetaType() */ -/*! \fn T QScriptEngine::fromScriptValue(const QScriptValue &value) +/*! \fn template <typename T> T QScriptEngine::fromScriptValue(const QScriptValue &value) Returns the given \a value converted to the template type \c{T}. @@ -3899,7 +3899,7 @@ QStringList QScriptEngine::importedExtensions() const */ /*! - \fn QScriptValue qScriptValueFromValue(QScriptEngine *engine, const T &value) + \fn template <typename T> QScriptValue qScriptValueFromValue(QScriptEngine *engine, const T &value) \since 4.3 \relates QScriptEngine \obsolete @@ -3917,7 +3917,7 @@ QStringList QScriptEngine::importedExtensions() const */ /*! - \fn T qScriptValueToValue(const QScriptValue &value) + \fn template <typename T> T qScriptValueToValue(const QScriptValue &value) \since 4.3 \relates QScriptEngine \obsolete @@ -3934,7 +3934,7 @@ QStringList QScriptEngine::importedExtensions() const */ /*! - \fn QScriptValue qScriptValueFromSequence(QScriptEngine *engine, const Container &container) + \fn template <class Container> QScriptValue qScriptValueFromSequence(QScriptEngine *engine, const Container &container) \since 4.3 \relates QScriptEngine @@ -3953,7 +3953,7 @@ QStringList QScriptEngine::importedExtensions() const */ /*! - \fn void qScriptValueToSequence(const QScriptValue &value, Container &container) + \fn template <class Container> void qScriptValueToSequence(const QScriptValue &value, Container &container) \since 4.3 \relates QScriptEngine @@ -3974,7 +3974,7 @@ QStringList QScriptEngine::importedExtensions() const */ /*! - \fn T qscriptvalue_cast(const QScriptValue &value) + \fn template <typename T> T qscriptvalue_cast(const QScriptValue &value) \since 4.3 \relates QScriptValue @@ -3983,14 +3983,15 @@ QStringList QScriptEngine::importedExtensions() const \sa qScriptRegisterMetaType(), QScriptEngine::toScriptValue() */ -/*! \fn int qScriptRegisterMetaType( - QScriptEngine *engine, +/*! \fn template<typename T> int qScriptRegisterMetaType( + QScriptEngine *eng, QScriptValue (*toScriptValue)(QScriptEngine *, const T &t), void (*fromScriptValue)(const QScriptValue &, T &t), - const QScriptValue &prototype = QScriptValue()) + const QScriptValue &prototype, T *) + \relates QScriptEngine - Registers the type \c{T} in the given \a engine. \a toScriptValue must + Registers the type \c{T} in the given \a eng. \a toScriptValue must be a function that will convert from a value of type \c{T} to a QScriptValue, and \a fromScriptValue a function that does the opposite. \a prototype, if valid, is the prototype that's set on @@ -4071,9 +4072,11 @@ QStringList QScriptEngine::importedExtensions() const QScriptEngine::AutoOwnership ownership. */ -/*! \fn int qScriptRegisterSequenceMetaType( +/*! + \fn template<typename T> int qScriptRegisterSequenceMetaType( QScriptEngine *engine, - const QScriptValue &prototype = QScriptValue()) + const QScriptValue &prototype, T *) + \relates QScriptEngine Registers the sequence type \c{T} in the given \a engine. This diff --git a/src/script/api/qscriptengine.h b/src/script/api/qscriptengine.h index c7bda46..04f678d 100644 --- a/src/script/api/qscriptengine.h +++ b/src/script/api/qscriptengine.h @@ -378,11 +378,8 @@ int qScriptRegisterMetaType( QScriptEngine *eng, QScriptValue (*toScriptValue)(QScriptEngine *, const T &t), void (*fromScriptValue)(const QScriptValue &, T &t), - const QScriptValue &prototype = QScriptValue() -#ifndef qdoc - , T * /* dummy */ = 0 -#endif -) + const QScriptValue &prototype = QScriptValue(), + T * /* dummy */ = 0) { const int id = qRegisterMetaType<T>(); // make sure it's registered @@ -420,11 +417,8 @@ void qScriptValueToSequence(const QScriptValue &value, Container &cont) template<typename T> int qScriptRegisterSequenceMetaType( QScriptEngine *engine, - const QScriptValue &prototype = QScriptValue() -#ifndef qdoc - , T * /* dummy */ = 0 -#endif -) + const QScriptValue &prototype = QScriptValue(), + T * /* dummy */ = 0) { return qScriptRegisterMetaType<T>(engine, qScriptValueFromSequence, qScriptValueToSequence, prototype); diff --git a/src/script/api/qscriptengineagent.cpp b/src/script/api/qscriptengineagent.cpp index 12b8b53..ac9a016 100644 --- a/src/script/api/qscriptengineagent.cpp +++ b/src/script/api/qscriptengineagent.cpp @@ -440,7 +440,7 @@ void QScriptEngineAgent::exceptionCatch(qint64 scriptId, } #if 0 -/*! +/* This function is called when a property of the given \a object has been added, changed or removed. |