Doc: Fix various errors

Change-Id: I07503dd379779148b674ab0f806f6eeac5d7d4b7
Reviewed-by: Kim M. Kalland <kim.kalland@nokia.com>
This commit is contained in:
aavit 2012-08-30 14:25:17 +02:00 committed by Qt by Nokia
parent dc5359a312
commit 244e3e2aa0
7 changed files with 37 additions and 54 deletions

View File

@ -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. Queries and returns the state of the modifier keys on the keyboard.
Unlike keyboardModifiers, this method returns the actual keys held Unlike keyboardModifiers, this method returns the actual keys held

View File

@ -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() 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 \brief Return the cursor's hotspot
*/ */

View File

@ -258,36 +258,6 @@ QPlatformScreen * QPlatformScreen::platformScreenForWindow(const QWindow *window
Reimplement in subclass to return the image format which corresponds to the screen format 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 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. hardware does not support page flipping. The default implementation returns 0.

View File

@ -90,9 +90,13 @@ void QPlatformScreenBuffer::displayed()
\preliminary \preliminary
\ingroup qpa \ingroup qpa
\brief The QPlatformScreenPageFlipper class provides an abstraction for flipping the screen \brief The QPlatformScreenPageFlipper class provides an abstract interface for display buffer swapping
page.
*/ 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) QPlatformScreenPageFlipper::QPlatformScreenPageFlipper(QObject *parent)
: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 QT_END_NAMESPACE

View File

@ -73,7 +73,8 @@ bool QPlatformServices::openDocument(const QUrl &url)
/*! /*!
* \brief QPlatformServices::desktopEnvironment returns the active desktop environment. * \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 QByteArray QPlatformServices::desktopEnvironment() const
{ {

View File

@ -98,26 +98,26 @@ QPlatformSystemTrayIcon::~QPlatformSystemTrayIcon()
/*! /*!
\fn void QPlatformSystemTrayIcon::showMessage(const QString &msg, const QString &title, \fn void QPlatformSystemTrayIcon::showMessage(const QString &msg, const QString &title,
const QIcon &icon, MessageIcon iconType, int secs) 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 Shows a balloon message for the entry with the given \a title, message \a msg and \a icon for
the time specified in \secs. \a iconType is used as a hint for the implementing platform. the time specified in \a secs. \a iconType is used as a hint for the implementing platform.
\sa QSystemTrayIcon::showMessage \sa QSystemTrayIcon::showMessage
*/ */
/*! /*!
\fn bool QPlatformSystemTrayIcon::isSystemTrayAvailable() \fn bool QPlatformSystemTrayIcon::isSystemTrayAvailable() const
Returns true if the system tray is available on the platform. 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. 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. This signal is emitted when the user activates the system tray icon.
\a reason specifies the reason for activation. \a reason specifies the reason for activation.
\sa QSystemTrayIcon::ActivationReason. \sa QSystemTrayIcon::ActivationReason
*/ */
QT_END_NAMESPACE QT_END_NAMESPACE

View File

@ -286,8 +286,7 @@ QList<QScreen *> QScreen::virtualSiblings() const
} }
/*! /*!
\property QScreen::virtualSize Returns the pixel size of the virtual desktop corresponding to this screen.
\brief the pixel size of the virtual desktop corresponding to this screen
This is the combined size of the virtual siblings' individual geometries. This is the combined size of the virtual siblings' individual geometries.
@ -315,13 +314,11 @@ QRect QScreen::virtualGeometry() const
} }
/*! /*!
\property QScreen::availableVirtualSize Returns the available pixel size of the virtual desktop corresponding to this screen.
\brief the available pixel size of the virtual desktop corresponding to this screen
This is the combined size of the virtual siblings' individual available geometries. This is the combined size of the virtual siblings' individual available geometries.
\sa availableSize() \sa availableSize(), virtualSiblings()
\sa virtualSiblings()
*/ */
QSize QScreen::availableVirtualSize() const QSize QScreen::availableVirtualSize() const
{ {
@ -329,13 +326,11 @@ QSize QScreen::availableVirtualSize() const
} }
/*! /*!
\property QScreen::availableVirtualGeometry Returns the available size of the virtual desktop corresponding to this screen.
\brief the available size of the virtual desktop corresponding to this screen
This is the union of the virtual siblings' individual available geometries. This is the union of the virtual siblings' individual available geometries.
\sa availableGeometry() \sa availableGeometry(), virtualSiblings()
\sa virtualSiblings()
*/ */
QRect QScreen::availableVirtualGeometry() const QRect QScreen::availableVirtualGeometry() const
{ {