From 88466bcb2162cd063912dbb0e73982095c15dcba Mon Sep 17 00:00:00 2001 From: Volker Hilsheimer Date: Tue, 29 Sep 2009 00:24:01 +0200 Subject: doc: add some more \since 4.6 tags --- src/corelib/global/qglobal.cpp | 2 ++ src/corelib/tools/qlocale.cpp | 5 ++++- src/gui/graphicsview/qgraphicslayout.cpp | 2 ++ src/gui/image/qimagereader.cpp | 18 ++++++++++++------ src/gui/inputmethod/qinputcontext.cpp | 2 ++ src/gui/kernel/qapplication_s60.cpp | 4 ++++ src/gui/painting/qcolor.cpp | 23 +++++++++++++++++++++++ src/gui/painting/qpainter.cpp | 4 ++++ src/gui/painting/qprinter.cpp | 6 ++++-- src/testlib/qtestcase.cpp | 1 + 10 files changed, 58 insertions(+), 9 deletions(-) diff --git a/src/corelib/global/qglobal.cpp b/src/corelib/global/qglobal.cpp index 97362af..63e2891 100644 --- a/src/corelib/global/qglobal.cpp +++ b/src/corelib/global/qglobal.cpp @@ -1066,6 +1066,7 @@ bool qSharedBuild() /*! \fn QSysInfo::SymbianVersion QSysInfo::symbianVersion() + \since 4.6 Returns the version of the Symbian operating system on which the application is run (Symbian only). @@ -1073,6 +1074,7 @@ bool qSharedBuild() /*! \fn QSysInfo::S60Version QSysInfo::s60Version() + \since 4.6 Returns the version of the S60 SDK system on which the application is run (S60 only). diff --git a/src/corelib/tools/qlocale.cpp b/src/corelib/tools/qlocale.cpp index dc61adb..4a66b92 100644 --- a/src/corelib/tools/qlocale.cpp +++ b/src/corelib/tools/qlocale.cpp @@ -637,7 +637,8 @@ static QString winSystemPMText() } /*! - Returns the fallback locale obtained from the system. + \since 4.6 + Returns the fallback locale obtained from the system. */ QLocale QSystemLocale::fallbackLocale() const { @@ -1283,6 +1284,8 @@ QVariant QSystemLocale::query(QueryType type, QVariant /* in */) const #elif !defined(Q_OS_SYMBIAN) /*! + \since 4.6 + Returns a fallback locale, that will get used for everything that is not explicitly overridden by the system locale. */ diff --git a/src/gui/graphicsview/qgraphicslayout.cpp b/src/gui/graphicsview/qgraphicslayout.cpp index f9800bc..2e9a30c 100644 --- a/src/gui/graphicsview/qgraphicslayout.cpp +++ b/src/gui/graphicsview/qgraphicslayout.cpp @@ -420,6 +420,8 @@ void QGraphicsLayout::widgetEvent(QEvent *e) */ /*! + \since 4.6 + This function is a convenience function provided for custom layouts, and will go through all items in the layout and reparent their graphics items to the closest QGraphicsWidget ancestor of the layout. diff --git a/src/gui/image/qimagereader.cpp b/src/gui/image/qimagereader.cpp index aff186b..074f3eb 100644 --- a/src/gui/image/qimagereader.cpp +++ b/src/gui/image/qimagereader.cpp @@ -696,14 +696,17 @@ bool QImageReader::autoDetectImageFormat() const /*! - Specifies that the image reader should decide which plugin to use - solely based on the contents in the datastream. + If \a ignored is set to true, then the image reader will ignore + specified formats or file extensions and decide which plugin to + use only based on the contents in the datastream. Setting this flag means that all image plugins gets loaded. Each plugin will read the first bytes in the image data and decide if - the plugin is compatible or not. The flag is set to \a ignored. + the plugin is compatible or not. - This also disables auto detecting image format. + This also disables auto detecting the image format. + + \sa decideFormatFromContent() */ void QImageReader::setDecideFormatFromContent(bool ignored) @@ -713,8 +716,11 @@ void QImageReader::setDecideFormatFromContent(bool ignored) /*! - Returns wether the image reader should decide which plugin to use - sloley based on the contents of the datastream + Returns whether the image reader should decide which plugin to use + only based on the contents of the datastream rather than on the file + extension. + + \sa setDecideFormatFromContent() */ bool QImageReader::decideFormatFromContent() const diff --git a/src/gui/inputmethod/qinputcontext.cpp b/src/gui/inputmethod/qinputcontext.cpp index 81cc3b8..8ee417f 100644 --- a/src/gui/inputmethod/qinputcontext.cpp +++ b/src/gui/inputmethod/qinputcontext.cpp @@ -469,6 +469,8 @@ bool QInputContext::x11FilterEvent(QWidget * /*keywidget*/, XEvent * /*event*/) #ifdef Q_WS_S60 /*! + \since 4.6 + This function may be overridden only if input method is depending on Symbian and you need raw TWsEvent. Otherwise, this function must not. diff --git a/src/gui/kernel/qapplication_s60.cpp b/src/gui/kernel/qapplication_s60.cpp index 8daac42..0637652 100644 --- a/src/gui/kernel/qapplication_s60.cpp +++ b/src/gui/kernel/qapplication_s60.cpp @@ -1305,6 +1305,7 @@ void QApplication::beep() /*! \warning This function is only available on Symbian. + \since 4.6 This function processes an individual Symbian window server \a event. It returns 1 if the event was handled, 0 if @@ -1427,6 +1428,7 @@ int QApplication::s60ProcessEvent(TWsEvent *event) /*! \warning This virtual function is only available on Symbian. + \since 4.6 If you create an application that inherits QApplication and reimplement this function, you get direct access to events that the are received @@ -1444,6 +1446,7 @@ bool QApplication::s60EventFilter(TWsEvent * /* aEvent */) /*! \warning This function is only available on Symbian. + \since 4.6 Handles \a{command}s which are typically handled by CAknAppUi::HandleCommandL(). Qts Ui integration into Symbian is @@ -1475,6 +1478,7 @@ void QApplication::symbianHandleCommand(int command) /*! \warning This function is only available on Symbian. + \since 4.6 Handles the resource change specified by \a type. diff --git a/src/gui/painting/qcolor.cpp b/src/gui/painting/qcolor.cpp index 5659aef..62e08f3 100644 --- a/src/gui/painting/qcolor.cpp +++ b/src/gui/painting/qcolor.cpp @@ -691,6 +691,8 @@ void QColor::setHsv(int h, int s, int v, int a) } /*! + \since 4.6 + Sets the contents pointed to by \a h, \a s, \a l, and \a a, to the hue, saturation, lightness, and alpha-channel (transparency) components of the color's HSL value. @@ -719,6 +721,8 @@ void QColor::getHslF(qreal *h, qreal *s, qreal *l, qreal *a) const } /*! + \since 4.6 + Sets the contents pointed to by \a h, \a s, \a l, and \a a, to the hue, saturation, lightness, and alpha-channel (transparency) components of the color's HSL value. @@ -747,6 +751,8 @@ void QColor::getHsl(int *h, int *s, int *l, int *a) const } /*! + \since 4.6 + Sets a HSL color lightness; \a h is the hue, \a s is the saturation, \a l is the lightness and \a a is the alpha component of the HSL color. @@ -773,6 +779,8 @@ void QColor::setHslF(qreal h, qreal s, qreal l, qreal a) } /*! + \since 4.6 + Sets a HSL color value; \a h is the hue, \a s is the saturation, \a l is the lightness and \a a is the alpha component of the HSL color. @@ -1332,6 +1340,8 @@ qreal QColor::valueF() const } /*! + \since 4.6 + Returns the hue color component of this color. \sa getHslF(), getHsl() @@ -1344,6 +1354,8 @@ int QColor::hslHue() const } /*! + \since 4.6 + Returns the saturation color component of this color. \sa saturationF(), getHsv(), {QColor#The HSV Color Model}{The HSV Color @@ -1357,6 +1369,8 @@ int QColor::hslSaturation() const } /*! + \since 4.6 + Returns the lightness color component of this color. \sa lightnessF(), getHsl() @@ -1369,6 +1383,8 @@ int QColor::lightness() const } /*! + \since 4.6 + Returns the hue color component of this color. \sa hue(), getHslF() @@ -1381,6 +1397,8 @@ qreal QColor::hslHueF() const } /*! + \since 4.6 + Returns the saturation color component of this color. \sa saturationF() getHslF() @@ -1393,6 +1411,8 @@ qreal QColor::hslSaturationF() const } /*! + \since 4.6 + Returns the lightness color component of this color. \sa value() getHslF() @@ -1979,6 +1999,8 @@ QColor QColor::fromHsvF(qreal h, qreal s, qreal v, qreal a) } /*! + \since 4.6 + Static convenience function that returns a QColor constructed from the HSV color values, \a h (hue), \a s (saturation), \a l (lightness), and \a a (alpha-channel, i.e. transparency). @@ -2010,6 +2032,7 @@ QColor QColor::fromHsl(int h, int s, int l, int a) /*! \overload + \since 4.6 Static convenience function that returns a QColor constructed from the HSV color values, \a h (hue), \a s (saturation), \a l (lightness), and \a a diff --git a/src/gui/painting/qpainter.cpp b/src/gui/painting/qpainter.cpp index ed1b5d1..f271af9 100644 --- a/src/gui/painting/qpainter.cpp +++ b/src/gui/painting/qpainter.cpp @@ -1895,6 +1895,8 @@ QPaintEngine *QPainter::paintEngine() const } /*! + \since 4.6 + Flushes the painting pipeline and prepares for the user issuing commands directly to the underlying graphics context. Must be followed by a call to endNativePainting(). @@ -1919,6 +1921,8 @@ void QPainter::beginNativePainting() } /*! + \since 4.6 + Restores the painter after manually issuing native painting commands. Lets the painter restore any native state that it relies on before calling any other painter commands. diff --git a/src/gui/painting/qprinter.cpp b/src/gui/painting/qprinter.cpp index eb9b11b..5ff0b96 100644 --- a/src/gui/painting/qprinter.cpp +++ b/src/gui/painting/qprinter.cpp @@ -1275,7 +1275,7 @@ QPrinter::ColorMode QPrinter::colorMode() const buffering up the copies and in those cases the application must make an explicit call to the print code for each copy. - \sa setNumCopies() + \sa setNumCopies(), actualNumCopies() */ int QPrinter::numCopies() const @@ -1286,13 +1286,15 @@ int QPrinter::numCopies() const /*! + \since 4.6 + Returns the number of copies that will be printed. The default value is 1. This function always returns the actual value specified in the print dialog or using setNumCopies(). - \sa setNumCopies(), numCopies(); + \sa setNumCopies(), numCopies() */ int QPrinter::actualNumCopies() const { diff --git a/src/testlib/qtestcase.cpp b/src/testlib/qtestcase.cpp index a2f0179..eb4dee1 100644 --- a/src/testlib/qtestcase.cpp +++ b/src/testlib/qtestcase.cpp @@ -735,6 +735,7 @@ QT_BEGIN_NAMESPACE */ /*! \fn void QTest::qWaitForWindowShown(QWidget *window) + \since 4.6 Waits until the \a window is shown in the screen. This is mainly useful for asynchronous systems like X11, where a window will be mapped to screen some -- cgit v0.12