Document which header to include for qmlRegister functions.

Task-number: QTBUG-15630
Reviewed-by: Bea Lam

1 files changed, 16 insertions, 0 deletions

diff --git a/doc/src/declarative/qtdeclarative.qdoc b/doc/src/declarative/qtdeclarative.qdoc
index f2b20329fa..b0c6e06b75 100644
--- a/doc/src/declarative/qtdeclarative.qdoc
+++ b/doc/src/declarative/qtdeclarative.qdoc
@@ -57,6 +57,8 @@
   \relates QDeclarativeEngine
 
   Equivalent to \c Q_DECLARE_METATYPE(TYPE) and \c Q_DECLARE_METATYPE(QDeclarativeListProperty<TYPE>)
+
+  #include <QtDeclarative> to use this macro.
 */
 
 /*!
@@ -68,6 +70,8 @@
   
   Current the only supported type info is \c QML_HAS_ATTACHED_PROPERTIES which
   declares that the \a Type supports \l {Attached Properties}.
+
+  #include <QtDeclarative> to use this macro.
 */
 
 
@@ -86,6 +90,10 @@
   "com.mycompany.qmlcomponents":
 
   \code
+  #include <QtDeclarative>
+
+  ...
+
   qmlRegisterType<MySliderItem>("com.mycompany.qmlcomponents", 1, 0, "Slider");
   \endcode
 
@@ -119,6 +127,8 @@
 
   Returns the QML type id.
 
+  #include <QtDeclarative> to use this function.
+
   \sa qmlRegisterTypeNotAvailable()
 */
 
@@ -154,6 +164,8 @@
 
   Without this, a generic "Game is not a type" message would be given.
 
+  #include <QtDeclarative> to use this function.
+
   \sa qmlRegisterUncreatableType()
 */
 
@@ -166,6 +178,8 @@
   system. Instances of this type cannot be created from the QML
   system.
 
+  #include <QtDeclarative> to use this function.
+
   Returns the QML type id.
 */
 
@@ -176,5 +190,7 @@
   This template function registers the C++ type in the QML system
   under the name \a typeName.
 
+  #include <QtDeclarative> to use this function.
+
   Returns the QML type id.
   */