Doc: Fix various errors

Change-Id: I07503dd379779148b674ab0f806f6eeac5d7d4b7
Reviewed-by: Kim M. Kalland <kim.kalland@nokia.com>

diff --git a/src/gui/kernel/qguiapplication.cpp b/src/gui/kernel/qguiapplication.cpp
index bc77205..8ffc969 100644 (file)
--- a/src/gui/kernel/qguiapplication.cpp
+++ b/src/gui/kernel/qguiapplication.cpp
@@ -963,7 +963,7 @@ Qt::KeyboardModifiers QGuiApplication::keyboardModifiers()
 }
 
 /*!
-    \fn Qt::KeyboardModifiers QApplication::queryKeyboardModifiers()
+    \fn Qt::KeyboardModifiers QGuiApplication::queryKeyboardModifiers()
 
     Queries and returns the state of the modifier keys on the keyboard.
     Unlike keyboardModifiers, this method returns the actual keys held

diff --git a/src/gui/kernel/qplatformcursor.cpp b/src/gui/kernel/qplatformcursor.cpp
index 40b7967..dd5d88d 100644 (file)
--- a/src/gui/kernel/qplatformcursor.cpp
+++ b/src/gui/kernel/qplatformcursor.cpp
@@ -102,9 +102,9 @@ QList<QPlatformCursor *> QPlatformCursorPrivate::getInstances()
 */
 
 /*!
-    \fn QPlatformCursor::QPlatformCursor(QPlatformScreen *screen)
+    \fn QPlatformCursor::QPlatformCursor()
 
-    Constructs a QPlatformCursor for the given \a screen.
+    Constructs a QPlatformCursor.
 */
 QPlatformCursor::QPlatformCursor()
 {
@@ -656,7 +656,7 @@ void QPlatformCursorImage::set(const uchar *data, const uchar *mask,
 */
 
 /*!
-    \fn QPoint QPlatformCursorImage::hotspot()
+    \fn QPoint QPlatformCursorImage::hotspot() const
 
     \brief Return the cursor's hotspot
 */

diff --git a/src/gui/kernel/qplatformscreen.cpp b/src/gui/kernel/qplatformscreen.cpp
index d946e4f..1dc4975 100644 (file)
--- a/src/gui/kernel/qplatformscreen.cpp
+++ b/src/gui/kernel/qplatformscreen.cpp
@@ -258,36 +258,6 @@ QPlatformScreen * QPlatformScreen::platformScreenForWindow(const QWindow *window
     Reimplement in subclass to return the image format which corresponds to the screen format
 */
 
-
-/*!
-    \class QPlatformScreenPageFlipper
-    \since 5.0
-    \internal
-    \preliminary
-    \ingroup qpa
-
-    \brief The QPlatformScreenPageFlipper class provides an abstract interface for display buffer swapping
-
-    Implement the displayBuffer() function to initiate a buffer swap. The
-    bufferDisplayed() signal should be emitted once the buffer is actually displayed on
-    the screen. The bufferReleased() signal should be emitted when the buffer data is no
-    longer owned by the display hardware.
-*/
-
-/*!  \fn bool QPlatformScreenPageFlipper::displayBuffer(void *bufferHandle)
-
-Implemented in subclasses to display the buffer referenced by \a bufferHandle directly on
-the screen. Returns \c true if it is possible to display the buffer, and \c false if the
-buffer cannot be displayed.
-
-If this function returns true, the buffer must not be modified or destroyed before the
-bufferReleased() signal is emitted.  The signal bufferDisplayed() is emitted when the buffer
-is displayed on the screen. The two signals may be emitted in either order.
-
-This function is allowed to block.
-*/
-
-
 /*!
   Implemented in subclasses to return a page flipper object for the screen, or 0 if the
   hardware does not support page flipping. The default implementation returns 0.

diff --git a/src/gui/kernel/qplatformscreenpageflipper.cpp b/src/gui/kernel/qplatformscreenpageflipper.cpp
index babecb0..15ec0c7 100644 (file)
--- a/src/gui/kernel/qplatformscreenpageflipper.cpp
+++ b/src/gui/kernel/qplatformscreenpageflipper.cpp
@@ -90,9 +90,13 @@ void QPlatformScreenBuffer::displayed()
     \preliminary
     \ingroup qpa
 
-    \brief The QPlatformScreenPageFlipper class provides an abstraction for flipping the screen
-    page.
- */
+    \brief The QPlatformScreenPageFlipper class provides an abstract interface for display buffer swapping
+
+    Implement the displayBuffer() function to initiate a buffer swap. The
+    bufferDisplayed() signal should be emitted once the buffer is actually displayed on
+    the screen. The bufferReleased() signal should be emitted when the buffer data is no
+    longer owned by the display hardware.
+*/
 
 QPlatformScreenPageFlipper::QPlatformScreenPageFlipper(QObject *parent)
     :QObject(parent)
@@ -100,5 +104,18 @@ QPlatformScreenPageFlipper::QPlatformScreenPageFlipper(QObject *parent)
 
 }
 
+/*!
+    \fn bool QPlatformScreenPageFlipper::displayBuffer(QPlatformScreenBuffer *buffer)
+
+    Implemented in subclasses to display \a buffer directly on the screen. Returns \c true
+    if it is possible to display the buffer, and \c false if the buffer cannot be displayed.
+
+    If this function returns true, the buffer must not be modified or destroyed before the
+    bufferReleased() signal is emitted.  The signal bufferDisplayed() is emitted when the buffer
+    is displayed on the screen. The two signals may be emitted in either order.
+
+    This function is allowed to block.
+*/
+
 QT_END_NAMESPACE
 

diff --git a/src/gui/kernel/qplatformservices.cpp b/src/gui/kernel/qplatformservices.cpp
index 9a1ea40..9184246 100644 (file)
--- a/src/gui/kernel/qplatformservices.cpp
+++ b/src/gui/kernel/qplatformservices.cpp
@@ -73,7 +73,8 @@ bool QPlatformServices::openDocument(const QUrl &url)
 
 /*!
  * \brief QPlatformServices::desktopEnvironment returns the active desktop environment.
- * \return On Unix this function returns KDE, GNOME or UNKNOWN.
+ *
+ * On Unix this function returns KDE, GNOME or UNKNOWN.
  */
 QByteArray QPlatformServices::desktopEnvironment() const
 {

diff --git a/src/gui/kernel/qplatformsystemtrayicon_qpa.cpp b/src/gui/kernel/qplatformsystemtrayicon_qpa.cpp
index 304fc29..425fbda 100644 (file)
--- a/src/gui/kernel/qplatformsystemtrayicon_qpa.cpp
+++ b/src/gui/kernel/qplatformsystemtrayicon_qpa.cpp
@@ -98,26 +98,26 @@ QPlatformSystemTrayIcon::~QPlatformSystemTrayIcon()
 /*!
     \fn void QPlatformSystemTrayIcon::showMessage(const QString &msg, const QString &title,
                                                   const QIcon &icon, MessageIcon iconType, int secs)
-    Shows a balloon message for the entry with the given \a title, message \msg and \a icon for
-    the time specified in \secs. \a iconType is used as a hint for the implementing platform.
+    Shows a balloon message for the entry with the given \a title, message \a msg and \a icon for
+    the time specified in \a secs. \a iconType is used as a hint for the implementing platform.
     \sa QSystemTrayIcon::showMessage
 */
 
 /*!
-    \fn bool QPlatformSystemTrayIcon::isSystemTrayAvailable()
+    \fn bool QPlatformSystemTrayIcon::isSystemTrayAvailable() const
     Returns true if the system tray is available on the platform.
 */
 
 /*!
-    bool QPlatformSystemTrayIcon::supportsMessages()
+    \fn bool QPlatformSystemTrayIcon::supportsMessages() const
     Returns true if the system tray supports messages on the platform.
 */
 
 /*!
-    \fn void activated(QPlatformSystemTrayIcon::ActivationReason reason)
+    \fn void QPlatformSystemTrayIcon::activated(QPlatformSystemTrayIcon::ActivationReason reason)
     This signal is emitted when the user activates the system tray icon.
     \a reason specifies the reason for activation.
-    \sa QSystemTrayIcon::ActivationReason.
+    \sa QSystemTrayIcon::ActivationReason
 */
 
 QT_END_NAMESPACE

diff --git a/src/gui/kernel/qscreen.cpp b/src/gui/kernel/qscreen.cpp
index 5d32a83..497c095 100644 (file)
--- a/src/gui/kernel/qscreen.cpp
+++ b/src/gui/kernel/qscreen.cpp
@@ -286,8 +286,7 @@ QList<QScreen *> QScreen::virtualSiblings() const
 }
 
 /*!
-  \property QScreen::virtualSize
-  \brief the pixel size of the virtual desktop corresponding to this screen
+  Returns the pixel size of the virtual desktop corresponding to this screen.
 
   This is the combined size of the virtual siblings' individual geometries.
 
@@ -315,13 +314,11 @@ QRect QScreen::virtualGeometry() const
 }
 
 /*!
-  \property QScreen::availableVirtualSize
-  \brief the available pixel size of the virtual desktop corresponding to this screen
+  Returns the available pixel size of the virtual desktop corresponding to this screen.
 
   This is the combined size of the virtual siblings' individual available geometries.
 
-  \sa availableSize()
-  \sa virtualSiblings()
+  \sa availableSize(), virtualSiblings()
 */
 QSize QScreen::availableVirtualSize() const
 {
@@ -329,13 +326,11 @@ QSize QScreen::availableVirtualSize() const
 }
 
 /*!
-  \property QScreen::availableVirtualGeometry
-  \brief the available size of the virtual desktop corresponding to this screen
+  Returns the available size of the virtual desktop corresponding to this screen.
 
   This is the union of the virtual siblings' individual available geometries.
 
-  \sa availableGeometry()
-  \sa virtualSiblings()
+  \sa availableGeometry(), virtualSiblings()
 */
 QRect QScreen::availableVirtualGeometry() const
 {