Doc: Fixed qdoc warnings.

10 files changed, 54 insertions, 66 deletions

diff --git a/src/gui/kernel/qactiongroup.cpp b/src/gui/kernel/qactiongroup.cpp
index 95ea8af..20787e4 100644
--- a/src/gui/kernel/qactiongroup.cpp
+++ b/src/gui/kernel/qactiongroup.cpp
@@ -108,8 +108,8 @@ void QActionGroupPrivate::_q_actionHovered()
 
     \ingroup mainwindow-classes
 
-    In some situations it is useful to group actions together. For
-    example, if you have a \gui{Left Align} action, a \gui{Right
+    In some situations it is useful to group QAction objects together.
+    For example, if you have a \gui{Left Align} action, a \gui{Right
     Align} action, a \gui{Justify} action, and a \gui{Center} action,
     only one of these actions should be active at any one time. One
     simple way of achieving this is to group the actions together in
diff --git a/src/gui/kernel/qapplication_mac.mm b/src/gui/kernel/qapplication_mac.mm
index f607a72..c0c97e9 100644
--- a/src/gui/kernel/qapplication_mac.mm
+++ b/src/gui/kernel/qapplication_mac.mm
@@ -2623,8 +2623,6 @@ OSStatus QApplicationPrivate::globalAppleEventProcessor(const AppleEvent *ae, Ap
     Return true if you want to stop the event from being processed.
     Return false for normal event dispatching. The default
     implementation returns false.
-
-    \sa macEventFilter(void *nsevent)
 */
 bool QApplication::macEventFilter(EventHandlerCallRef, EventRef)
 {
diff --git a/src/gui/kernel/qapplication_qpa.cpp b/src/gui/kernel/qapplication_qpa.cpp
index b754cf7..8441355 100644
--- a/src/gui/kernel/qapplication_qpa.cpp
+++ b/src/gui/kernel/qapplication_qpa.cpp
@@ -444,6 +444,9 @@ void QApplication::alert(QWidget *, int)
 {
 }
 
+/*!
+    \internal
+*/
 QPlatformNativeInterface *QApplication::platformNativeInterface()
 {
     QPlatformIntegration *pi = QApplicationPrivate::platformIntegration();
diff --git a/src/gui/kernel/qevent.cpp b/src/gui/kernel/qevent.cpp
index 277a5e8..910b43a 100644
--- a/src/gui/kernel/qevent.cpp
+++ b/src/gui/kernel/qevent.cpp
@@ -3103,10 +3103,10 @@ QUrl QFileOpenEvent::url() const
 }
 
 /*!
-    \fn bool openFile(QFile &file, QIODevice::OpenMode flags) const
+    \fn bool QFileOpenEvent::openFile(QFile &file, QIODevice::OpenMode flags) const
 
-    Opens a QFile on the file referenced by this event.
-    Returns true if successful; otherwise returns false.
+    Opens a QFile on the \a file referenced by this event in the mode specified
+    by \a flags. Returns true if successful; otherwise returns false.
 
     This is necessary as some files cannot be opened by name, but require specific
     information stored in this event.
diff --git a/src/gui/kernel/qgenericplugin_qpa.cpp b/src/gui/kernel/qgenericplugin_qpa.cpp
index 43d6525..17453f3 100644
--- a/src/gui/kernel/qgenericplugin_qpa.cpp
+++ b/src/gui/kernel/qgenericplugin_qpa.cpp
@@ -53,7 +53,7 @@ QT_BEGIN_NAMESPACE
     \brief The QGenericPlugin class is an abstract base class for
     window-system related plugins in Qt QPA.
 
-    Note that this class is only available in \l{Qt QPA}.
+    Note that this class is only available in Qt QPA.
 
     A mouse plugin can be created by subclassing
     QGenericPlugin and reimplementing the pure virtual keys() and
diff --git a/src/gui/kernel/qgenericpluginfactory_qpa.cpp b/src/gui/kernel/qgenericpluginfactory_qpa.cpp
index abc575a..c77ea11 100644
--- a/src/gui/kernel/qgenericpluginfactory_qpa.cpp
+++ b/src/gui/kernel/qgenericpluginfactory_qpa.cpp
@@ -65,8 +65,7 @@ Q_GLOBAL_STATIC_WITH_ARGS(QFactoryLoader, loader,
     \brief The QGenericPluginFactory class creates window-system
     related plugin drivers in Qt QPA.
 
-    Note that this class is only available in \l{Qt QPA}.
-
+    Note that this class is only available in Qt QPA.
 
     \sa QGenericPlugin
 */
diff --git a/src/gui/kernel/qplatformcursor_qpa.cpp b/src/gui/kernel/qplatformcursor_qpa.cpp
index 2ea8332..f430f6e 100644
--- a/src/gui/kernel/qplatformcursor_qpa.cpp
+++ b/src/gui/kernel/qplatformcursor_qpa.cpp
@@ -52,48 +52,46 @@ QT_BEGIN_NAMESPACE
 QList <QWeakPointer<QPlatformCursor> > QPlatformCursorPrivate::instances;
 
 /*!
-    \class QGraphicsSystemCursor
+    \class QPlatformCursor
 
-    \brief The QGraphicsSystemCursor class provides information about
+    \brief The QPlatformCursor class provides information about
     pointer device events (movement, buttons), and requests to change
     the currently displayed cursor.
 
-    Note that QGraphicsSystemCursor does not include any graphics for
+    Note that QPlatformCursor does not include any graphics for
     display. An application that sets a QCursor may provide its own
     graphics.
 
-    \sa QGraphicsSystemCursorImage
+    \sa QPlatformCursorImage
 */
 
 /*!
-    \fn virtual void QGraphicsSystemCursor::pointerEvent(const QMouseEvent & event)
+    \fn virtual void QPlatformCursor::pointerEvent(const QMouseEvent & event)
 
     This method is called by Qt whenever a QMouseEvent is generated by the
     underlying pointer input. \a event is a reference to the QMouseEvent in
     question. A default do-nothing implementation is provided.
-
-    \sa QApplicationPrivate::handleMouseEvent()
 */
 
 /*!
-    \fn virtual void QGraphicsSystemCursor::changeCursor(QCursor * widgetCursor, QWidget * widget)
+    \fn virtual void QPlatformCursor::changeCursor(QCursor * widgetCursor, QWidget * widget)
 
     \brief This method is called by Qt whenever the cursor graphic should be changed.
 
-    Implementation of this method is mandatory for a subclass of QGraphicsSystemCursor.
+    Implementation of this method is mandatory for a subclass of QPlatformCursor.
 
     \a widgetCursor is a pointer to the QCursor that should be displayed.
 
     \a widget is a pointer to the widget currently displayed at QCursor::pos(). Note
     that this may be 0 if the current position is not occupied by a displayed widget.
 
-    \sa QApplicationPrivate::handleMouseEvent(), QCursor::pos()
+    \sa QCursor::pos()
 */
 
 /*!
-    \fn QGraphicsSystemCursor::QGraphicsSystemCursor()
+    \fn QPlatformCursor::QPlatformCursor()
 
-    \brief Constructs a QGraphicsSystemCursor
+    \brief Constructs a QPlatformCursor
 */
 QPlatformCursor::QPlatformCursor(QPlatformScreen *scr )
         : screen(scr)
@@ -106,12 +104,12 @@ QPlatformCursor::QPlatformCursor(QPlatformScreen *scr )
 // from src/gui/embedded/QGraphicsSystemCursorImage_qws.cpp
 
 /*!
-    \class QGraphicsSystemCursorImage
+    \class QPlatformCursorImage
 
-    \brief The QGraphicsSystemCursorImage class provides a set of graphics
+    \brief The QPlatformCursorImage class provides a set of graphics
     intended to be used as cursors.
 
-    \sa QGraphicsSystemCursor
+    \sa QPlatformCursor
 */
 
 static QPlatformCursorImage *systemCursorTable[Qt::LastCursor+1];
@@ -502,7 +500,7 @@ void QPlatformCursorImage::createSystemCursor(int id)
 }
 
 /*!
-    \fn void QGraphicsSystemCursorImage::set(Qt::CursorShape id)
+    \fn void QPlatformCursorImage::set(Qt::CursorShape id)
 
     \brief Calling this method sets the cursor image to the specified shape
 
@@ -531,15 +529,8 @@ void QPlatformCursorImage::set(Qt::CursorShape id)
 }
 
 /*!
-    \fn void QGraphicsSystemCursorImage::set(const QImage * image, int hx, int hy)
-
-    \brief Set the cursor image to the specified QImage, with the hotsport at (hx, hy)
-
-    \a image A pointer to a QImage
-
-    \a hx The x coordinate of the cursor's hotspot
-
-    \a hy the y coordinate of the cursor's hotspot
+    Sets the cursor image to the given \a image, with the hotspot at the
+    point specified by (\a hx, \a hy).
 */
 
 void QPlatformCursorImage::set(const QImage &image, int hx, int hy)
@@ -550,22 +541,19 @@ void QPlatformCursorImage::set(const QImage &image, int hx, int hy)
 }
 
 /*!
-    \fn void QGraphicsSystemCursorImage::set(const uchar *data, const uchar *mask, int width, int height, int hx, int hy)
-
-    \brief set the cursor image to the graphic represented by the combination of data, mask,
-    width, and height
+    \fn void QPlatformCursorImage::set(const uchar *data, const uchar *mask, int width, int height, int hx, int hy)
 
-    \a data The pixel data of the graphic
-
-    \a mask Mask data for the graphic. pixels in data with a corresponding mask bit of 0 are not drawn
-
-    \a width The width of the graphic in pixels
-
-    \a height The height of the graphic in pixels
+    Sets the cursor image to the graphic represented by the combination of
+    \a data and \a mask, with dimensions given by \a width and \a height and a
+    hotspot at the point specified by (\a hx, \a hy).
 
-    \a hx The X hotspot of the cursor graphic
+    The image data specified by \a data must be supplied in the format
+    described by QImage::Format_Indexed8.
 
-    \a hy The Y hotspot of the cursor graphic
+    The corresponding mask data specified by \a mask must be supplied in a
+    character array containing packed 1 bit per pixel format data, with any
+    padding bits at the end of the array. Bits of value 0 represent transparent
+    pixels in the image data.
 */
 void QPlatformCursorImage::set(const uchar *data, const uchar *mask,
                     int width, int height, int hx, int hy)
@@ -625,7 +613,7 @@ void QPlatformCursorImage::set(const uchar *data, const uchar *mask,
 }
 
 /*!
-    \fn QGraphicsSystemCursorImage::QGraphicsSystemCursorImage(const uchar *data, const uchar *mask, int width, int height, int hotX, int hotY)
+    \fn QPlatformCursorImage::QPlatformCursorImage(const uchar *data, const uchar *mask, int width, int height, int hotX, int hotY)
 
     \brief set the cursor image to the graphic represented by the combination of data, mask,
     width, and height
@@ -646,13 +634,13 @@ void QPlatformCursorImage::set(const uchar *data, const uchar *mask,
 */
 
 /*!
-  \fn QImage *QGraphicsSystemCursorImage::image()
+  \fn QImage *QPlatformCursorImage::image()
 
   \brief Return the cursor graphic as a pointer to a QImage
 */
 
 /*!
-    \fn QPoint QGraphicsSystemCursorImage::hotspot()
+    \fn QPoint QPlatformCursorImage::hotspot()
 
     \brief Return the cursor's hotspot
 */
diff --git a/src/gui/kernel/qplatformglcontext_qpa.cpp b/src/gui/kernel/qplatformglcontext_qpa.cpp
index 1810532..918b41b 100644
--- a/src/gui/kernel/qplatformglcontext_qpa.cpp
+++ b/src/gui/kernel/qplatformglcontext_qpa.cpp
@@ -191,17 +191,17 @@ void QPlatformGLContext::deleteQGLContext()
     which maps to the QPlatformGLContext.
 */
 
-/*! \fn void swapBuffers()
+/*! \fn void QPlatformGLContext::swapBuffers()
     Reimplement in subclass to native swap buffers calls
 */
 
-/*! getProcAddress(const QString& procName)
+/*! \fn void *QPlatformGLContext::getProcAddress(const QString &procName)
     Reimplement in subclass to native getProcAddr calls.
 
     Note: its convenient to use qPrintable(const QString &str) to get the const char * pointer
 */
 
-/*! platformWindowFormat() const
+/*! \fn QPlatformWindowFormat QPlatformGLContext::platformWindowFormat() const
     QWidget has the function qplatformWindowFormat(). That function is for the application
     programmer to request the format of the window and the context that he wants.
 
diff --git a/src/gui/kernel/qplatformintegration_qpa.cpp b/src/gui/kernel/qplatformintegration_qpa.cpp
index 8ff12eb..fa12518 100644
--- a/src/gui/kernel/qplatformintegration_qpa.cpp
+++ b/src/gui/kernel/qplatformintegration_qpa.cpp
@@ -132,20 +132,20 @@ QPlatformNativeInterface * QPlatformIntegration::nativeInterface() const
     the recommended approach for making new platform plugin is to copy an existing plugin inside
     the QTSRCTREE/src/plugins/platform and develop the plugin inside the source tree.
 
-    The minimal platformintegration is the smallest platform integration it is possible to make,
+    The minimal platform integration is the smallest platform integration it is possible to make,
     which makes it an ideal starting point for new plugins. For a slightly more advanced plugin,
     consider reviewing the directfb plugin, or the testlite plugin.
 */
 
 /*!
-    \fn QPixmapData *createPixmapData(QPixmapData::PixelType type) const
+    \fn QPixmapData *QPlatformIntegration::createPixmapData(QPixmapData::PixelType type) const
 
     Factory function for QPixmapData. PixelType can be either PixmapType or BitmapType.
     \sa QPixmapData
 */
 
 /*!
-    \fn QPlatformWindow *createPlatformWindow(QWidget *widget, WId winId = 0) const
+    \fn QPlatformWindow *QPlatformIntegration::createPlatformWindow(QWidget *widget, WId winId = 0) const
 
     Factory function for QPlatformWindow. The widget parameter is a pointer to the top level
     widget(tlw) which the QPlatformWindow is suppose to be created for. The WId handle is actually
@@ -162,7 +162,7 @@ QPlatformNativeInterface * QPlatformIntegration::nativeInterface() const
 */
 
 /*!
-    \fn QWindowSurface *createWindowSurface(QWidget *widget, WId winId) const
+    \fn QWindowSurface *QPlatformIntegration::createWindowSurface(QWidget *widget, WId winId) const
 
     Factory function for QWindowSurface. The QWidget parameter is a pointer to the
     top level widget(tlw) the window surface is created for. A QPlatformWindow is always created
@@ -175,7 +175,7 @@ QPlatformNativeInterface * QPlatformIntegration::nativeInterface() const
 */
 
 /*!
-    \fn void moveToScreen(QWidget *window, int screen)
+    \fn void QPlatformIntegration::moveToScreen(QWidget *window, int screen)
 
     This function is called when a QWidget is displayed on screen, or the QWidget is to be
     displayed on a new screen. The QWidget parameter is a pointer to the top level widget and
@@ -187,14 +187,14 @@ QPlatformNativeInterface * QPlatformIntegration::nativeInterface() const
 */
 
 /*!
-    \fn QList<QPlatformScreen *> screens() const
+    \fn QList<QPlatformScreen *> QPlatformIntegration::screens() const
 
     Accessor function to a list of all the screens on the current system. The screen with the
     index == 0 is the default/main screen.
 */
 
 /*!
-    \fn bool isVirtualDesktop()
+    \fn bool QPlatformIntegration::isVirtualDesktop()
 
     Returns if the current windowing system configuration defines all the screens to be one
     desktop(virtual desktop), or if each screen is a desktop of its own.
@@ -203,7 +203,7 @@ QPlatformNativeInterface * QPlatformIntegration::nativeInterface() const
 */
 
 /*!
-    \fn QPixmap grabWindow(WId window, int x, int y, int width, int height) const
+    \fn QPixmap QPlatformIntegration::grabWindow(WId window, int x, int y, int width, int height) const
 
     This function is called when Qt needs to be able to grab the content of a window.
 
diff --git a/src/gui/kernel/qplatformscreen_qpa.cpp b/src/gui/kernel/qplatformscreen_qpa.cpp
index c9f3dc6..5e3c453 100644
--- a/src/gui/kernel/qplatformscreen_qpa.cpp
+++ b/src/gui/kernel/qplatformscreen_qpa.cpp
@@ -110,20 +110,20 @@ QPlatformScreen * QPlatformScreen::platformScreenForWidget(const QWidget *widget
     QPlatformScreen is also used by the public api QDesktopWidget for information about the desktop.
  */
 
-/*! \fn geometry() const
+/*! \fn QRect QPlatformScreen::geometry() const = 0
     Reimplement in subclass to return the pixel geometry of the screen
 */
 
-/*! \fn availableGeometry() const
+/*! \fn QRect QPlatformScreen::availableGeometry() const
     Reimplement in subclass to return the pixel geometry of the available space
     This normally is the desktop screen minus the task manager, global menubar etc.
 */
 
-/*! \fn depth() const
+/*! \fn int QPlatformScreen::depth() const = 0
     Reimplement in subclass to return current depth of the screen
 */
 
-/*! \fn format() const
+/*! \fn QImage::Format QPlatformScreen::format() const = 0
     Reimplement in subclass to return the image format which corresponds to the screen format
 */