Fill out QML global object documentation

Moves the documentation for functions on the global object from
qmlengine.cpp to globalobject.qdoc (so that qdoc actually generates
them).

The XmlHttpRequest documentation is still just a stub.

2 files changed, 3 insertions, 116 deletions

diff --git a/src/declarative/qml/qmlengine.cpp b/src/declarative/qml/qmlengine.cpp
index 6c303e3..8581751 100644
--- a/src/declarative/qml/qmlengine.cpp
+++ b/src/declarative/qml/qmlengine.cpp
@@ -121,6 +121,8 @@ QmlEnginePrivate::QmlEnginePrivate(QmlEngine *e)
   nodeListClass(0), namedNodeMapClass(0), sqlQueryClass(0), cleanup(0), scriptEngine(this), 
   componentAttacheds(0), rootComponent(0), networkAccessManager(0), typeManager(e), uniqueId(1)
 {
+    // Note that all documentation for stuff put on the global object goes in
+    // doc/src/declarative/globalobject.qdoc
     QScriptValue qtObject =
         scriptEngine.newQMetaObject(StaticQtMetaObject::get());
     scriptEngine.globalObject().setProperty(QLatin1String("Qt"), qtObject);
@@ -584,59 +586,6 @@ QmlContext *QmlEnginePrivate::getContext(QScriptContext *ctxt)
     return contextClass->contextFromValue(scopeNode);
 }
 
-/*!
-    This function is intended for use inside QML only. In C++ just create a
-    component object as usual.
-
-    This function takes the URL of a QML file as its only argument. It returns
-    a component object which can be used to create and load that QML file.
-
-    Example QmlJS is below, remember that QML files that might be loaded
-    over the network cannot be expected to be ready immediately.
-    \code
-        var component;
-        var sprite;
-        function finishCreation(){
-            if(component.isReady()){
-                sprite = component.createObject();
-                if(sprite == 0){
-                    // Error Handling
-                }else{
-                    sprite.parent = page;
-                    sprite.x = 200;
-                    //...
-                }
-            }else if(component.isError()){
-                // Error Handling
-            }
-        }
-
-        component = createComponent("Sprite.qml");
-        if(component.isReady()){
-            finishCreation();
-        }else{
-            component.statusChanged.connect(finishCreation);
-        }
-    \endcode
-
-    If you are certain the files will be local, you could simplify to
-
-    \code
-        component = createComponent("Sprite.qml");
-        sprite = component.createObject();
-        if(sprite == 0){
-            // Error Handling
-            print(component.errorsString());
-        }else{
-            sprite.parent = page;
-            sprite.x = 200;
-            //...
-        }
-    \endcode
-
-    If you want to just create an arbitrary string of QML, instead of
-    loading a qml file, consider the createQmlObject() function.
-*/
 QScriptValue QmlEnginePrivate::createComponent(QScriptContext *ctxt,
                                                QScriptEngine *engine)
 {
@@ -659,31 +608,6 @@ QScriptValue QmlEnginePrivate::createComponent(QScriptContext *ctxt,
     return engine->newQObject(c);
 }
 
-/*!
-    Creates a new object from the specified string of QML. It requires a
-    second argument, which is the id of an existing QML object to use as
-    the new object's parent. If a third argument is provided, this is used
-    as the filepath that the qml came from.
-
-    Example (where targetItem is the id of an existing QML item):
-    \code
-    newObject = createQmlObject('import Qt 4.6; Rectangle {color: "red"; width: 20; height: 20}',
-        targetItem, "dynamicSnippet1");
-    \endcode
-
-    This function is intended for use inside QML only. It is intended to behave
-    similarly to eval, but for creating QML elements.
-
-    Returns the created object, or null if there is an error. In the case of an
-    error, details of the error are output using qWarning().
-
-    Note that this function returns immediately, and therefore may not work if
-    the QML loads new components. If you are trying to load a new component,
-    for example from a QML file, consider the createComponent() function
-    instead. 'New components' refers to external QML files that have not yet
-    been loaded, and so it is safe to use createQmlObject to load built-in
-    components.
-*/
 QScriptValue QmlEnginePrivate::createQmlObject(QScriptContext *ctxt, QScriptEngine *engine)
 {
     QmlEnginePrivate *activeEnginePriv =
@@ -736,32 +660,6 @@ QScriptValue QmlEnginePrivate::createQmlObject(QScriptContext *ctxt, QScriptEngi
     return engine->nullValue();
 }
 
-/*!
-    This function is intended for use inside QML only. In C++ just create a
-    QVector3D as usual.
-
-    This function takes three numeric components and combines them into a
-    QVector3D value that can be used with any property that takes a
-    QVector3D argument.  The following QML code:
-
-    \code
-    transform: Rotation {
-        id: rotation
-        origin.x: Container.width / 2;
-        axis: vector(0, 1, 1)
-    }
-    \endcode
-
-    is equivalent to:
-
-    \code
-    transform: Rotation {
-        id: rotation
-        origin.x: Container.width / 2;
-        axis.x: 0; axis.y: 1; axis.z: 0
-    }
-    \endcode
-*/
 QScriptValue QmlEnginePrivate::vector(QScriptContext *ctxt, QScriptEngine *engine)
 {
     if(ctxt->argumentCount() < 3)
@@ -894,19 +792,7 @@ QScriptValue QmlEnginePrivate::desktopOpenUrl(QScriptContext *ctxt, QScriptEngin
     bool ret = QDesktopServices::openUrl(QUrl(ctxt->argument(0).toString()));
     return e->newVariant(QVariant(ret));
 }
-/*!
-    This function allows tinting one color with another.
-
-    The tint color should usually be mostly transparent, or you will not be able to see the underlying color. The below example provides a slight red tint by having the tint color be pure red which is only 1/16th opaque.
 
-    \qml
-    Rectangle { x: 0; width: 80; height: 80; color: "lightsteelblue" }
-    Rectangle { x: 100; width: 80; height: 80; color: Qt.tint("lightsteelblue", "#10FF0000") }
-    \endqml
-    \image declarative-rect_tint.png
-
-    Tint is most useful when a subtle change is intended to be conveyed due to some event; you can then use tinting to more effectively tune the visible color.
-*/
 QScriptValue QmlEnginePrivate::tint(QScriptContext *ctxt, QScriptEngine *engine)
 {
     if(ctxt->argumentCount() < 2)
diff --git a/src/declarative/qml/qmlengine_p.h b/src/declarative/qml/qmlengine_p.h
index 7629dc1..f5bc015 100644
--- a/src/declarative/qml/qmlengine_p.h
+++ b/src/declarative/qml/qmlengine_p.h
@@ -250,6 +250,7 @@ public:
     QVariant scriptValueToVariant(const QScriptValue &);
 
     static QScriptValue qmlScriptObject(QObject*, QmlEngine*);
+
     static QScriptValue createComponent(QScriptContext*, QScriptEngine*);
     static QScriptValue createQmlObject(QScriptContext*, QScriptEngine*);
     static QScriptValue vector(QScriptContext*, QScriptEngine*);