Doc: Fixed QtQuick.Window documentation

-fixed import statement in \qmlmodule and \inqmlmodule command.
-Removed extra identifier in property documentation.

Task-number: QTBUG-33360
Change-Id: I1e7ca5f418c327d42247ab4f4a11733c63d8c273
Reviewed-by: Alan Alpert <aalpert@blackberry.com>
Reviewed-by: Shawn Rutledge <shawn.rutledge@digia.com>
Reviewed-by: Lars Knoll <lars.knoll@digia.com>

diff --git a/src/imports/window/plugin.cpp b/src/imports/window/plugin.cpp
index 059044e..31c7899 100644 (file)
--- a/src/imports/window/plugin.cpp
+++ b/src/imports/window/plugin.cpp
@@ -46,7 +46,7 @@
 QT_BEGIN_NAMESPACE
 
 /*!
-    \qmlmodule QtQuick.Window 2
+    \qmlmodule QtQuick.Window 2.1
     \title Qt Quick Window QML Types
     \ingroup qmlmodules
     \brief Provides QML types for window management

diff --git a/src/quick/items/qquickscreen.cpp b/src/quick/items/qquickscreen.cpp
index e32f313..6957eea 100644 (file)
--- a/src/quick/items/qquickscreen.cpp
+++ b/src/quick/items/qquickscreen.cpp
@@ -52,7 +52,7 @@ QT_BEGIN_NAMESPACE
 /*!
     \qmltype Screen
     \instantiates QQuickScreenAttached
-    \inqmlmodule QtQuick.Window 2
+    \inqmlmodule QtQuick.Window
     \ingroup qtquick-visual-utility
     \brief The Screen attached object provides information about the Screen an Item or Window is displayed on.
 
@@ -80,26 +80,26 @@ QT_BEGIN_NAMESPACE
 */
 
 /*!
-    \qmlattachedproperty String QtQuick.Window::Screen::name
+    \qmlattachedproperty string Screen::name
     \readonly
     \since 5.1
 
     The name of the screen.
 */
 /*!
-    \qmlattachedproperty int QtQuick.Window::Screen::width
+    \qmlattachedproperty int Screen::width
     \readonly
 
     This contains the width of the screen in pixels.
 */
 /*!
-    \qmlattachedproperty int QtQuick.Window::Screen::height
+    \qmlattachedproperty int Screen::height
     \readonly
 
     This contains the height of the screen in pixels.
 */
 /*!
-    \qmlattachedproperty int QtQuick.Window::Screen::desktopAvailableWidth
+    \qmlattachedproperty int Screen::desktopAvailableWidth
     \readonly
     \since 5.1
 
@@ -113,7 +113,7 @@ QT_BEGIN_NAMESPACE
     \endqml
 */
 /*!
-    \qmlattachedproperty int QtQuick.Window::Screen::desktopAvailableHeight
+    \qmlattachedproperty int Screen::desktopAvailableHeight
     \readonly
     \since 5.1
 
@@ -127,7 +127,7 @@ QT_BEGIN_NAMESPACE
     \endqml
 */
 /*!
-    \qmlattachedproperty real QtQuick.Window::Screen::logicalPixelDensity
+    \qmlattachedproperty real Screen::logicalPixelDensity
     \readonly
     \since 5.1
 
@@ -136,14 +136,14 @@ QT_BEGIN_NAMESPACE
     pixels.
 */
 /*!
-    \qmlattachedproperty real QtQuick.Window::Screen::pixelDensity
+    \qmlattachedproperty real Screen::pixelDensity
     \readonly
     \since 5.2
 
     The number of physical pixels per millimeter.
 */
 /*!
-    \qmlattachedproperty Qt::ScreenOrientation QtQuick.Window::Screen::primaryOrientation
+    \qmlattachedproperty Qt::ScreenOrientation Screen::primaryOrientation
     \readonly
 
     This contains the primary orientation of the screen.  If the
@@ -160,7 +160,7 @@ QT_BEGIN_NAMESPACE
     automatically, so again you will see the primaryOrientation change.
 */
 /*!
-    \qmlattachedproperty Qt::ScreenOrientation QtQuick.Window::Screen::orientation
+    \qmlattachedproperty Qt::ScreenOrientation Screen::orientation
     \readonly
 
     This contains the current orientation of the screen, from the accelerometer
@@ -174,7 +174,7 @@ QT_BEGIN_NAMESPACE
     \l Item.transform to rotate your content.
 */
 /*!
-    \qmlattachedmethod int QtQuick.Window::Screen::angleBetween(Qt::ScreenOrientation a, Qt::ScreenOrientation b)
+    \qmlattachedmethod int Screen::angleBetween(Qt::ScreenOrientation a, Qt::ScreenOrientation b)
 
     Returns the rotation angle, in degrees, between the two specified angles.
 */

diff --git a/src/quick/items/qquickwindow.cpp b/src/quick/items/qquickwindow.cpp
index 28a5df7..41a1781 100644 (file)
--- a/src/quick/items/qquickwindow.cpp
+++ b/src/quick/items/qquickwindow.cpp
@@ -865,7 +865,7 @@ void QQuickWindowPrivate::cleanup(QSGNode *n)
 /*!
     \qmltype Window
     \instantiates QQuickWindow
-    \inqmlmodule QtQuick.Window 2
+    \inqmlmodule QtQuick.Window
     \ingroup qtquick-visual
     \brief Creates a new top-level window
 
@@ -2114,7 +2114,7 @@ bool QQuickWindowPrivate::dragOverThreshold(qreal d, Qt::Axis axis, QMouseEvent
 }
 
 /*!
-    \qmlproperty list<Object> QtQuick.Window::Window::data
+    \qmlproperty list<Object> Window::data
     \default
 
     The data property allows you to freely mix visual children, resources
@@ -2631,7 +2631,7 @@ QOpenGLContext *QQuickWindow::openglContext() const
 /*!
     \qmltype CloseEvent
     \instantiates QQuickCloseEvent
-    \inqmlmodule QtQuick.Window 2
+    \inqmlmodule QtQuick.Window
     \ingroup qtquick-visual
     \brief Notification that a \l Window is about to be closed
     \since 5.1
@@ -2644,7 +2644,7 @@ QOpenGLContext *QQuickWindow::openglContext() const
 */
 
 /*!
-    \qmlproperty bool QtQuick.Window::CloseEvent::accepted
+    \qmlproperty bool CloseEvent::accepted
 
     This property indicates whether the application will allow the user to
     close the window.  It is true by default.
@@ -2659,7 +2659,7 @@ QOpenGLContext *QQuickWindow::openglContext() const
 */
 
 /*!
-    \qmlsignal QtQuick.Window::closing(CloseEvent close)
+    \qmlsignal closing(CloseEvent close)
     \since 5.1
 
     This signal is emitted when the user tries to close the window.
@@ -3019,7 +3019,7 @@ QSGTexture *QQuickWindow::createTextureFromId(uint id, const QSize &size, Create
 }
 
 /*!
-    \qmlproperty color QtQuick.Window::Window::color
+    \qmlproperty color Window::color
 
     The background color for the window.
 
@@ -3148,7 +3148,7 @@ void QQuickWindow::resetOpenGLState()
 }
 
 /*!
-    \qmlproperty string QtQuick.Window::Window::title
+    \qmlproperty string Window::title
 
     The window's title in the windowing system.
 
@@ -3159,7 +3159,7 @@ void QQuickWindow::resetOpenGLState()
  */
 
 /*!
-    \qmlproperty Qt::WindowModality QtQuick.Window::Window::modality
+    \qmlproperty Qt::WindowModality Window::modality
 
     The modality of the window.
 
@@ -3169,7 +3169,7 @@ void QQuickWindow::resetOpenGLState()
  */
 
 /*!
-    \qmlproperty Qt::WindowFlags QtQuick.Window::Window::flags
+    \qmlproperty Qt::WindowFlags Window::flags
 
     The window flags of the window.
 
@@ -3182,10 +3182,10 @@ void QQuickWindow::resetOpenGLState()
  */
 
 /*!
-    \qmlproperty int QtQuick.Window::Window::x
-    \qmlproperty int QtQuick.Window::Window::y
-    \qmlproperty int QtQuick.Window::Window::width
-    \qmlproperty int QtQuick.Window::Window::height
+    \qmlproperty int Window::x
+    \qmlproperty int Window::y
+    \qmlproperty int Window::width
+    \qmlproperty int Window::height
 
     Defines the window's position and size.
 
@@ -3200,8 +3200,8 @@ void QQuickWindow::resetOpenGLState()
  */
 
 /*!
-    \qmlproperty int QtQuick.Window::Window::minimumWidth
-    \qmlproperty int QtQuick.Window::Window::minimumHeight
+    \qmlproperty int Window::minimumWidth
+    \qmlproperty int Window::minimumHeight
     \since 5.1
 
     Defines the window's minimum size.
@@ -3211,8 +3211,8 @@ void QQuickWindow::resetOpenGLState()
  */
 
 /*!
-    \qmlproperty int QtQuick.Window::Window::maximumWidth
-    \qmlproperty int QtQuick.Window::Window::maximumHeight
+    \qmlproperty int Window::maximumWidth
+    \qmlproperty int Window::maximumHeight
     \since 5.1
 
     Defines the window's maximum size.
@@ -3222,7 +3222,7 @@ void QQuickWindow::resetOpenGLState()
  */
 
 /*!
-    \qmlproperty bool QtQuick.Window::Window::visible
+    \qmlproperty bool Window::visible
 
     Whether the window is visible on the screen.
 
@@ -3232,7 +3232,7 @@ void QQuickWindow::resetOpenGLState()
  */
 
 /*!
-    \qmlproperty QWindow::Visibility QtQuick.Window::Window::visibility
+    \qmlproperty QWindow::Visibility Window::visibility
 
     The screen-occupation state of the window.
 
@@ -3252,7 +3252,7 @@ void QQuickWindow::resetOpenGLState()
  */
 
 /*!
-    \qmlproperty Qt::ScreenOrientation QtQuick.Window::Window::contentOrientation
+    \qmlproperty Qt::ScreenOrientation Window::contentOrientation
 
     This is a hint to the window manager in case it needs to display
     additional content like popups, dialogs, status bars, or similar
@@ -3273,7 +3273,7 @@ void QQuickWindow::resetOpenGLState()
  */
 
 /*!
-    \qmlproperty real QtQuick.Window::Window::opacity
+    \qmlproperty real Window::opacity
 
     The opacity of the window.
 
@@ -3290,7 +3290,7 @@ void QQuickWindow::resetOpenGLState()
  */
 
 /*!
-    \qmlproperty Item QtQuick.Window::Window::activeFocusItem
+    \qmlproperty Item Window::activeFocusItem
     \since 5.1
 
     The item which currently has active focus or \c null if there is
@@ -3298,7 +3298,7 @@ void QQuickWindow::resetOpenGLState()
  */
 
 /*!
-    \qmlproperty QtQuick.Window::Window::active
+    \qmlproperty Window::active
     \since 5.1
 
     The active status of the window.