From 267eab3f398646b59f5773173cd22a97b8e9540a Mon Sep 17 00:00:00 2001 From: Nico Vertriest Date: Mon, 27 Jan 2014 15:20:25 +0100 Subject: Doc: correction link, example and parameter issues qtbase MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Moved codecs folder to qtbase/examples Corrected quote in dropsite.qdoc Replaced snippet statement by include statement Added doc for undocumented parameters Task-number: QTBUG-34749 Change-Id: If4de95b8d39e5680fd0f63f8d2b6685a4b0a8052 Reviewed-by: Jędrzej Nowacki Reviewed-by: Sean Harmer --- src/gui/kernel/qguiapplication.cpp | 12 ++++++------ src/gui/kernel/qopenglcontext.cpp | 15 ++++++++------- 2 files changed, 14 insertions(+), 13 deletions(-) (limited to 'src/gui/kernel') diff --git a/src/gui/kernel/qguiapplication.cpp b/src/gui/kernel/qguiapplication.cpp index b2d774b40d..c6376b2647 100644 --- a/src/gui/kernel/qguiapplication.cpp +++ b/src/gui/kernel/qguiapplication.cpp @@ -910,7 +910,7 @@ qreal QGuiApplication::devicePixelRatio() const } /*! - Returns the top level window at the given position, if any. + Returns the top level window at the given position \a pos, if any. */ QWindow *QGuiApplication::topLevelAt(const QPoint &pos) { @@ -2711,7 +2711,7 @@ void QGuiApplicationPrivate::notifyWindowIconChanged() \brief whether the application implicitly quits when the last window is closed. - The default is true. + The default is \c true. If this property is \c true, the applications quits when the last visible primary window (i.e. window with no parent) is closed. @@ -2739,7 +2739,7 @@ bool QGuiApplication::quitOnLastWindowClosed() primary window (i.e. window with no parent) is closed. By default, QGuiApplication quits after this signal is emitted. This feature - can be turned off by setting \l quitOnLastWindowClosed to false. + can be turned off by setting \l quitOnLastWindowClosed to \c false. \sa QWindow::close(), QWindow::isTopLevel() */ @@ -2915,7 +2915,7 @@ void QGuiApplicationPrivate::setApplicationState(Qt::ApplicationState state) Returns \c true if the application is currently saving the \l{Session Management}{session}; otherwise returns \c false. - This is true when commitDataRequest() and saveStateRequest() are emitted, + This is \c true when commitDataRequest() and saveStateRequest() are emitted, but also when the windows are closed afterwards by session management. \sa sessionId(), commitDataRequest(), saveStateRequest() @@ -3186,7 +3186,7 @@ QStyleHints *QGuiApplication::styleHints() /*! Sets whether Qt should use the system's standard colors, fonts, etc., to - \a on. By default, this is true. + \a on. By default, this is \c true. This function must be called before creating the QGuiApplication object, like this: @@ -3202,7 +3202,7 @@ void QGuiApplication::setDesktopSettingsAware(bool on) /*! Returns \c true if Qt is set to use the system's standard colors, fonts, etc.; - otherwise returns \c false. The default is true. + otherwise returns \c false. The default is \c true. \sa setDesktopSettingsAware() */ diff --git a/src/gui/kernel/qopenglcontext.cpp b/src/gui/kernel/qopenglcontext.cpp index d64f996b56..fb7d15c160 100644 --- a/src/gui/kernel/qopenglcontext.cpp +++ b/src/gui/kernel/qopenglcontext.cpp @@ -163,7 +163,7 @@ void QOpenGLVersionProfile::setVersion(int majorVersion, int minorVersion) } /*! - Returns the OpenGL profile. Only make sense if profiles are supported by this version. + Returns the OpenGL profile. Only makes sense if profiles are supported by this version. \sa setProfile(), supportsProfiles() */ @@ -173,7 +173,8 @@ QSurfaceFormat::OpenGLContextProfile QOpenGLVersionProfile::profile() const } /*! - Sets the profile. Only make sense if profiles are supported by this version. + Sets the OpenGL profile \a profile. Only makes sense if profiles are supported by + this version. \sa profile(), supportsProfiles() */ @@ -205,7 +206,7 @@ bool QOpenGLVersionProfile::isLegacyVersion() const /*! Returns \c true if the version number is valid. Note that for a default constructed - QOpenGLVersionProfile object this function will return false. + QOpenGLVersionProfile object this function will return \c false. \sa setVersion(), version() */ @@ -634,9 +635,9 @@ QOpenGLFunctions *QOpenGLContext::functions() const */ /*! - Returns a pointer to an object that provides access to all functions for - the version of the current context. Before using any of the functions - they must be initialized by calling QAbstractOpenGLFunctions::initializeOpenGLFunctions(). + Returns a pointer to an object that provides access to all functions for the + \a versionProfile of the current context. Before using any of the functions they must + be initialized by calling QAbstractOpenGLFunctions::initializeOpenGLFunctions(). Usually one would use the template version of this function to automatically have the result cast to the correct type. @@ -704,7 +705,7 @@ QSet QOpenGLContext::extensions() const /*! Returns \c true if this OpenGL context supports the specified OpenGL - \a extension, false otherwise. + \a extension, \c false otherwise. The context or a sharing context must be current. -- cgit v1.2.3