From d94ac55a013f970f81f382a38cb4722530fc99eb Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Thu, 17 Jan 2013 12:38:24 +0100 Subject: Doc: Fix documentation for devicePixelRatio() functions Fix Incorrect use of \sa, missing markup for comment block and typos. Change-Id: I1b7e477b7429ace30ca3ab25c4814c8cba659a65 Reviewed-by: Venugopal Shivashankar Reviewed-by: Jerome Pasion --- src/gui/kernel/qguiapplication.cpp | 5 ++--- src/gui/kernel/qscreen.cpp | 7 +++---- src/gui/kernel/qwindow.cpp | 3 +-- 3 files changed, 6 insertions(+), 9 deletions(-) diff --git a/src/gui/kernel/qguiapplication.cpp b/src/gui/kernel/qguiapplication.cpp index 190d52776a..810def937d 100644 --- a/src/gui/kernel/qguiapplication.cpp +++ b/src/gui/kernel/qguiapplication.cpp @@ -709,10 +709,9 @@ QList QGuiApplication::screens() device-independent pixels. Use this function only when you don't know which window you are targeting. - If you do know the target window use QWindow::devicePixelRatio() instead. + If you do know the target window, use QWindow::devicePixelRatio() instead. - \sa QWindow::devicePixelRatio(); - \sa QGuiApplicaiton::devicePixelRatio(); + \sa QWindow::devicePixelRatio() */ qreal QGuiApplication::devicePixelRatio() const { diff --git a/src/gui/kernel/qscreen.cpp b/src/gui/kernel/qscreen.cpp index f5467ab742..6b69e5cb49 100644 --- a/src/gui/kernel/qscreen.cpp +++ b/src/gui/kernel/qscreen.cpp @@ -214,13 +214,12 @@ qreal QScreen::logicalDotsPerInch() const return (dpi.first + dpi.second) * qreal(0.5); } -/* +/*! Returns the ratio between physical pixels and device-independent pixels for the screen. - Common values are 1.0 on normal displays and 2.0 on Apple retina displays. + Common values are 1.0 on normal displays and 2.0 on Apple "retina" displays. - \sa QWindow::devicePixelRatio(); - \sa QGuiApplicaiton::devicePixelRatio(); + \sa QWindow::devicePixelRatio(), QGuiApplication::devicePixelRatio() */ qreal QScreen::devicePixelRatio() const { diff --git a/src/gui/kernel/qwindow.cpp b/src/gui/kernel/qwindow.cpp index 22ad748fb5..82be77df06 100644 --- a/src/gui/kernel/qwindow.cpp +++ b/src/gui/kernel/qwindow.cpp @@ -765,8 +765,7 @@ Qt::ScreenOrientation QWindow::contentOrientation() const Common values are 1.0 on normal displays and 2.0 on Apple "retina" displays. - \sa QWindow::devicePixelRatio(); - \sa QGuiApplicaiton::devicePixelRatio(); + \sa QScreen::devicePixelRatio(), QGuiApplication::devicePixelRatio() */ qreal QWindow::devicePixelRatio() const { -- cgit v1.2.3