summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJerome Pasion <jerome.pasion@digia.com>2013-10-08 12:00:24 +0200
committerThe Qt Project <gerrit-noreply@qt-project.org>2013-10-08 12:13:26 +0200
commit4673ca52eec52c7b233a4efebf7e2f21be0011c5 (patch)
tree094aa5445f9655e217127129edef51823d0eb552
parent421ee46b982d274fe7e7a2f7a4269e39134d31d2 (diff)
downloadqtscript-4673ca52eec52c7b233a4efebf7e2f21be0011c5.tar.gz
Doc: Adding "\inmodule QtScript" to Qt Script classes.
-reduces QDoc warnings -lists the classes in the C++ pages Change-Id: I97db6b8bec4d44d1ee37ed2925ef7309cd0d420f Reviewed-by: Jędrzej Nowacki <jedrzej.nowacki@digia.com>
-rw-r--r--src/script/api/qscriptable.cpp1
-rw-r--r--src/script/api/qscriptclass.cpp2
-rw-r--r--src/script/api/qscriptclasspropertyiterator.cpp2
-rw-r--r--src/script/api/qscriptcontext.cpp2
-rw-r--r--src/script/api/qscriptcontextinfo.cpp2
-rw-r--r--src/script/api/qscriptengine.cpp2
-rw-r--r--src/script/api/qscriptengineagent.cpp1
-rw-r--r--src/script/api/qscriptextensionplugin.cpp2
-rw-r--r--src/script/api/qscriptprogram.cpp2
-rw-r--r--src/script/api/qscriptstring.cpp2
-rw-r--r--src/script/api/qscriptvalue.cpp2
-rw-r--r--src/script/api/qscriptvalueiterator.cpp2
12 files changed, 13 insertions, 9 deletions
diff --git a/src/script/api/qscriptable.cpp b/src/script/api/qscriptable.cpp
index 96bdbe9..f84d683 100644
--- a/src/script/api/qscriptable.cpp
+++ b/src/script/api/qscriptable.cpp
@@ -30,6 +30,7 @@ QT_BEGIN_NAMESPACE
/*!
\since 4.3
\class QScriptable
+ \inmodule QtScript
\brief The QScriptable class provides access to the Qt Script environment from Qt C++ member functions.
diff --git a/src/script/api/qscriptclass.cpp b/src/script/api/qscriptclass.cpp
index 8e286c8..de08e4f 100644
--- a/src/script/api/qscriptclass.cpp
+++ b/src/script/api/qscriptclass.cpp
@@ -27,7 +27,7 @@
/*!
\since 4.4
\class QScriptClass
-
+ \inmodule QtScript
\brief The QScriptClass class provides an interface for defining custom behavior of (a class of) Qt Script objects.
\ingroup script
diff --git a/src/script/api/qscriptclasspropertyiterator.cpp b/src/script/api/qscriptclasspropertyiterator.cpp
index 34c6d45..e9f03c8 100644
--- a/src/script/api/qscriptclasspropertyiterator.cpp
+++ b/src/script/api/qscriptclasspropertyiterator.cpp
@@ -30,7 +30,7 @@ QT_BEGIN_NAMESPACE
/*!
\since 4.4
\class QScriptClassPropertyIterator
-
+ \inmodule QtScript
\brief The QScriptClassPropertyIterator class provides an iterator interface for custom Qt Script objects.
\ingroup script
diff --git a/src/script/api/qscriptcontext.cpp b/src/script/api/qscriptcontext.cpp
index cbded31..2791cf3 100644
--- a/src/script/api/qscriptcontext.cpp
+++ b/src/script/api/qscriptcontext.cpp
@@ -44,7 +44,7 @@ QT_BEGIN_NAMESPACE
/*!
\since 4.3
\class QScriptContext
-
+ \inmodule QtScript
\brief The QScriptContext class represents a Qt Script function invocation.
\ingroup script
diff --git a/src/script/api/qscriptcontextinfo.cpp b/src/script/api/qscriptcontextinfo.cpp
index 15f0966..16f8ef6 100644
--- a/src/script/api/qscriptcontextinfo.cpp
+++ b/src/script/api/qscriptcontextinfo.cpp
@@ -42,7 +42,7 @@ QT_BEGIN_NAMESPACE
/*!
\since 4.4
\class QScriptContextInfo
-
+ \inmodule QtScript
\brief The QScriptContextInfo class provides additional information about a QScriptContext.
\ingroup script
diff --git a/src/script/api/qscriptengine.cpp b/src/script/api/qscriptengine.cpp
index 4c7670d..6972ddb 100644
--- a/src/script/api/qscriptengine.cpp
+++ b/src/script/api/qscriptengine.cpp
@@ -93,6 +93,7 @@ QT_BEGIN_NAMESPACE
\since 4.3
\class QScriptEngine
\reentrant
+ \inmodule QtScript
\brief The QScriptEngine class provides an environment for evaluating Qt Script code.
@@ -4418,6 +4419,7 @@ QScriptValue QScriptEngine::objectById(qint64 id) const
/*!
\since 4.5
\class QScriptSyntaxCheckResult
+ \inmodule QtScript
\brief The QScriptSyntaxCheckResult class provides the result of a script syntax check.
diff --git a/src/script/api/qscriptengineagent.cpp b/src/script/api/qscriptengineagent.cpp
index 176773d..5d03fe5 100644
--- a/src/script/api/qscriptengineagent.cpp
+++ b/src/script/api/qscriptengineagent.cpp
@@ -35,6 +35,7 @@ QT_BEGIN_NAMESPACE
/*!
\since 4.4
\class QScriptEngineAgent
+ \inmodule QtScript
\brief The QScriptEngineAgent class provides an interface to report events pertaining to QScriptEngine execution.
diff --git a/src/script/api/qscriptextensionplugin.cpp b/src/script/api/qscriptextensionplugin.cpp
index a3e6fe7..4ebc5a1 100644
--- a/src/script/api/qscriptextensionplugin.cpp
+++ b/src/script/api/qscriptextensionplugin.cpp
@@ -32,7 +32,7 @@ QT_BEGIN_NAMESPACE
\since 4.3
\class QScriptExtensionPlugin
\brief The QScriptExtensionPlugin class provides an abstract base for custom QScript extension plugins.
-
+ \inmodule QtScript
\ingroup plugins
QScriptExtensionPlugin is a plugin interface that makes it
diff --git a/src/script/api/qscriptprogram.cpp b/src/script/api/qscriptprogram.cpp
index a66f198..d14f2b0 100644
--- a/src/script/api/qscriptprogram.cpp
+++ b/src/script/api/qscriptprogram.cpp
@@ -35,7 +35,7 @@ QT_BEGIN_NAMESPACE
/*!
\since 4.7
\class QScriptProgram
-
+ \inmodule QtScript
\brief The QScriptProgram class encapsulates a Qt Script program.
\ingroup script
diff --git a/src/script/api/qscriptstring.cpp b/src/script/api/qscriptstring.cpp
index 34767ac..e67fb9b 100644
--- a/src/script/api/qscriptstring.cpp
+++ b/src/script/api/qscriptstring.cpp
@@ -32,7 +32,7 @@ QT_BEGIN_NAMESPACE
/*!
\since 4.4
\class QScriptString
-
+ \inmodule QtScript
\brief The QScriptString class acts as a handle to "interned" strings in a QScriptEngine.
\ingroup script
diff --git a/src/script/api/qscriptvalue.cpp b/src/script/api/qscriptvalue.cpp
index 3e307a2..b3b9248 100644
--- a/src/script/api/qscriptvalue.cpp
+++ b/src/script/api/qscriptvalue.cpp
@@ -45,7 +45,7 @@
/*!
\since 4.3
\class QScriptValue
-
+ \inmodule QtScript
\brief The QScriptValue class acts as a container for the Qt Script data types.
\ingroup script
diff --git a/src/script/api/qscriptvalueiterator.cpp b/src/script/api/qscriptvalueiterator.cpp
index a1cd8ba..276d88b 100644
--- a/src/script/api/qscriptvalueiterator.cpp
+++ b/src/script/api/qscriptvalueiterator.cpp
@@ -41,7 +41,7 @@ QT_BEGIN_NAMESPACE
/*!
\since 4.3
\class QScriptValueIterator
-
+ \inmodule QtScript
\brief The QScriptValueIterator class provides a Java-style iterator for QScriptValue.
\ingroup script