From 3ed2ec14870c4035cfd1bd986f6d8f4f55890270 Mon Sep 17 00:00:00 2001 From: Friedemann Kleint Date: Mon, 24 Mar 2014 16:20:11 +0100 Subject: Fix some documentation errors. Correct links and fix typos, remove obsolete documentation, fix some snippets, mark some classes as internal. Change-Id: I9a3266605f060783413d32740057a57a820c8929 Reviewed-by: Laszlo Agocs --- src/gui/kernel/qdrag.cpp | 2 +- src/gui/kernel/qevent.cpp | 4 ++-- src/gui/kernel/qopenglcontext.cpp | 4 ++-- src/gui/kernel/qsessionmanager.cpp | 8 ++++---- src/gui/kernel/qsurfaceformat.cpp | 2 +- 5 files changed, 10 insertions(+), 10 deletions(-) (limited to 'src/gui/kernel') diff --git a/src/gui/kernel/qdrag.cpp b/src/gui/kernel/qdrag.cpp index 465c04cdc8..d7fd4d5bc0 100644 --- a/src/gui/kernel/qdrag.cpp +++ b/src/gui/kernel/qdrag.cpp @@ -101,7 +101,7 @@ QT_BEGIN_NAMESPACE \l{QWidget::mouseMoveEvent()}{mouseMoveEvent()} to check whether a QDrag is required. - \sa {Drag and Drop}, QClipboard, QMimeData, QWindowsMime, QMacPasteboardMime, + \sa {Drag and Drop}, QClipboard, QMimeData, QMacPasteboardMime, {Draggable Icons Example}, {Draggable Text Example}, {Drop Site Example}, {Fridge Magnets Example} */ diff --git a/src/gui/kernel/qevent.cpp b/src/gui/kernel/qevent.cpp index 92d9871dc5..bb7000a266 100644 --- a/src/gui/kernel/qevent.cpp +++ b/src/gui/kernel/qevent.cpp @@ -628,7 +628,7 @@ QHoverEvent::~QHoverEvent() \a modifiers holds the keyboard modifier flags at the time of the event, and \a orient holds the wheel's orientation. - \sa pos(), pixelDelta(), angleDelta(), state() + \sa pos(), pixelDelta(), angleDelta() */ #ifndef QT_NO_WHEELEVENT QWheelEvent::QWheelEvent(const QPointF &pos, int delta, @@ -659,7 +659,7 @@ QWheelEvent::~QWheelEvent() \a orient holds the wheel's orientation. - \sa pos(), pixelDelta(), angleDelta(), state() + \sa pos(), pixelDelta(), angleDelta() */ QWheelEvent::QWheelEvent(const QPointF &pos, const QPointF& globalPos, int delta, Qt::MouseButtons buttons, Qt::KeyboardModifiers modifiers, diff --git a/src/gui/kernel/qopenglcontext.cpp b/src/gui/kernel/qopenglcontext.cpp index 5087e33b47..e258218e85 100644 --- a/src/gui/kernel/qopenglcontext.cpp +++ b/src/gui/kernel/qopenglcontext.cpp @@ -165,7 +165,7 @@ void QOpenGLVersionProfile::setVersion(int majorVersion, int minorVersion) /*! Returns the OpenGL profile. Only makes sense if profiles are supported by this version. - \sa setProfile(), supportsProfiles() + \sa setProfile() */ QSurfaceFormat::OpenGLContextProfile QOpenGLVersionProfile::profile() const { @@ -176,7 +176,7 @@ QSurfaceFormat::OpenGLContextProfile QOpenGLVersionProfile::profile() const Sets the OpenGL profile \a profile. Only makes sense if profiles are supported by this version. - \sa profile(), supportsProfiles() + \sa profile() */ void QOpenGLVersionProfile::setProfile(QSurfaceFormat::OpenGLContextProfile profile) { diff --git a/src/gui/kernel/qsessionmanager.cpp b/src/gui/kernel/qsessionmanager.cpp index b9ef35854c..a428840ca8 100644 --- a/src/gui/kernel/qsessionmanager.cpp +++ b/src/gui/kernel/qsessionmanager.cpp @@ -201,7 +201,7 @@ QString QSessionManager::sessionKey() const Here's an example of how an application's QGuiApplication::commitDataRequest() might be implemented: - \snippet code/src_gui_kernel_qguiapplication.cpp 8 + \snippet code/src_gui_kernel_qguiapplication.cpp 1 If an error occurred within the application while saving its data, you may want to try allowsErrorInteraction() instead. @@ -293,7 +293,7 @@ QSessionManager::RestartHint QSessionManager::restartHint() const If the session manager is capable of restoring sessions it will execute \a command in order to restore the application. The command defaults to - \snippet code/src_gui_kernel_qguiapplication.cpp 9 + \snippet code/src_gui_kernel_qguiapplication.cpp 2 The \c -session option is mandatory; otherwise QGuiApplication cannot tell whether it has been restored or what the current session identifier @@ -321,7 +321,7 @@ void QSessionManager::setRestartCommand(const QStringList &command) To iterate over the list, you can use the \l foreach pseudo-keyword: - \snippet code/src_gui_kernel_qguiapplication.cpp 10 + \snippet code/src_gui_kernel_qguiapplication.cpp 3 \sa setRestartCommand(), restartHint() */ @@ -347,7 +347,7 @@ void QSessionManager::setDiscardCommand(const QStringList &command) To iterate over the list, you can use the \l foreach pseudo-keyword: - \snippet code/src_gui_kernel_qguiapplication.cpp 11 + \snippet code/src_gui_kernel_qguiapplication.cpp 4 \sa setDiscardCommand(), restartCommand(), setRestartCommand() */ diff --git a/src/gui/kernel/qsurfaceformat.cpp b/src/gui/kernel/qsurfaceformat.cpp index 23c0e59779..2b8e611dff 100644 --- a/src/gui/kernel/qsurfaceformat.cpp +++ b/src/gui/kernel/qsurfaceformat.cpp @@ -387,7 +387,7 @@ void QSurfaceFormat::setOption(QSurfaceFormat::FormatOption option, bool on) Returns true if the format option \a option is set; otherwise returns false. - \sa options(), testOption() + \sa options() */ bool QSurfaceFormat::testOption(QSurfaceFormat::FormatOption option) const { -- cgit v1.2.3