diff options
author | Qt Continuous Integration System <qt-info@nokia.com> | 2011-07-08 16:27:24 (GMT) |
---|---|---|
committer | Qt Continuous Integration System <qt-info@nokia.com> | 2011-07-08 16:27:24 (GMT) |
commit | 8f52cddb714fbdd616c813045e8ca1f96851bdfc (patch) | |
tree | 40b0210235052e9d23d990c11452d7ce7b603371 /src/corelib | |
parent | ab4002004b59aaa900962d5e39c8186e909f327f (diff) | |
parent | f037c0e87d186a01f07cb9aa360dcc496d11145e (diff) | |
download | Qt-8f52cddb714fbdd616c813045e8ca1f96851bdfc.zip Qt-8f52cddb714fbdd616c813045e8ca1f96851bdfc.tar.gz Qt-8f52cddb714fbdd616c813045e8ca1f96851bdfc.tar.bz2 |
Merge branch 'master' of scm.dev.nokia.troll.no:qt/qt-doc-staging into master-integration
* 'master' of scm.dev.nokia.troll.no:qt/qt-doc-staging:
Applied fix (dea9ca8b7a4166e1c3d3fc374621ad02c1220d3a)from qt5/qtbase.
Committing the qt-webpages.qdoc file with the online links
Preparing documentation package for 4.8-beta
Doc: Clarified the range of return values from QLineF::angle().
Doc: Fixed \since declarations. (cherry picked from commit 358e018dbb4b4dbdbfc702a6d462f113a1357e1e)
Doc: Standardized on QtQuick for \since declarations. (cherry picked from commit 609dc22f719ecb8d48349fd56f84960bbf46d731)
Doc: Removed whitespace. (cherry picked from commit 01b3f508d1f7e9951baf60f487feadfa98ba4751)
Modified \since command behavior slightly to handle project and version.
Doc: Added a simple introduction to Qt and fixed links. (cherry picked from commit 9ed61311bce15b8f1bb4b30ee9133f1a2355f41d)
Doc: Added more appropriate links to help reduce confusion.
Doc: Removed non-ASCII characters from the documentation. (cherry picked from commit 1bd6f1bd280ee6e1ecd4de2291c8ccfb4d06b7a4)
Doc: Updated documentation with \since 4.8 declarations.
Diffstat (limited to 'src/corelib')
-rw-r--r-- | src/corelib/io/qfile.cpp | 2 | ||||
-rw-r--r-- | src/corelib/tools/qline.cpp | 5 | ||||
-rw-r--r-- | src/corelib/tools/qlocale.qdoc | 1 | ||||
-rw-r--r-- | src/corelib/tools/qpoint.cpp | 9 | ||||
-rw-r--r-- | src/corelib/tools/qset.qdoc | 1 | ||||
-rw-r--r-- | src/corelib/tools/qstring.cpp | 3 | ||||
-rw-r--r-- | src/corelib/xml/qxmlstream.cpp | 5 |
7 files changed, 23 insertions, 3 deletions
diff --git a/src/corelib/io/qfile.cpp b/src/corelib/io/qfile.cpp index 66edf58..929b2f9 100644 --- a/src/corelib/io/qfile.cpp +++ b/src/corelib/io/qfile.cpp @@ -358,6 +358,7 @@ QFilePrivate::setError(QFile::FileError err, int errNum) /*! \enum QFile::FileHandleFlag + \since 4.8 This enum is used when opening a file to specify additional options which only apply to files and not to a generic @@ -1657,6 +1658,7 @@ bool QFile::atEnd() const /*! \fn bool QFile::seek(qint64 pos) + \since 4.8 For random-access devices, this function sets the current position to \a pos, returning true on success, or false if an error occurred. diff --git a/src/corelib/tools/qline.cpp b/src/corelib/tools/qline.cpp index af3b7d5..0f67652 100644 --- a/src/corelib/tools/qline.cpp +++ b/src/corelib/tools/qline.cpp @@ -564,8 +564,9 @@ qreal QLineF::length() const Returns the angle of the line in degrees. - Positive values for the angles mean counter-clockwise while negative values - mean the clockwise direction. Zero degrees is at the 3 o'clock position. + The return value will be in the range of values from 0.0 up to but not + including 360.0. The angles are measured counter-clockwise from a point + on the x-axis to the right of the origin (x > 0). \sa setAngle() */ diff --git a/src/corelib/tools/qlocale.qdoc b/src/corelib/tools/qlocale.qdoc index fd139c3..5d4f305 100644 --- a/src/corelib/tools/qlocale.qdoc +++ b/src/corelib/tools/qlocale.qdoc @@ -608,6 +608,7 @@ /*! \enum QLocale::Script + \since 4.8 This enumerated type is used to specify a script. diff --git a/src/corelib/tools/qpoint.cpp b/src/corelib/tools/qpoint.cpp index bd32fe7..ae6ed71 100644 --- a/src/corelib/tools/qpoint.cpp +++ b/src/corelib/tools/qpoint.cpp @@ -188,6 +188,7 @@ QT_BEGIN_NAMESPACE /*! \fn QPoint &QPoint::operator*=(float factor) + \since 4.8 Multiplies this point's coordinates by the given \a factor, and returns a reference to this point. @@ -200,6 +201,7 @@ QT_BEGIN_NAMESPACE /*! \fn QPoint &QPoint::operator*=(double factor) + \since 4.8 Multiplies this point's coordinates by the given \a factor, and returns a reference to this point. For example: @@ -214,6 +216,7 @@ QT_BEGIN_NAMESPACE /*! \fn QPoint &QPoint::operator*=(int factor) + \since 4.8 Multiplies this point's coordinates by the given \a factor, and returns a reference to this point. @@ -259,6 +262,7 @@ QT_BEGIN_NAMESPACE /*! \fn const QPoint operator*(const QPoint &point, float factor) \relates QPoint + \since 4.8 Returns a copy of the given \a point multiplied by the given \a factor. @@ -271,6 +275,7 @@ QT_BEGIN_NAMESPACE /*! \fn const QPoint operator*(const QPoint &point, double factor) \relates QPoint + \since 4.8 Returns a copy of the given \a point multiplied by the given \a factor. @@ -283,6 +288,7 @@ QT_BEGIN_NAMESPACE /*! \fn const QPoint operator*(const QPoint &point, int factor) \relates QPoint + \since 4.8 Returns a copy of the given \a point multiplied by the given \a factor. @@ -293,6 +299,7 @@ QT_BEGIN_NAMESPACE \fn const QPoint operator*(float factor, const QPoint &point) \overload \relates QPoint + \since 4.8 Returns a copy of the given \a point multiplied by the given \a factor. */ @@ -301,6 +308,7 @@ QT_BEGIN_NAMESPACE \fn const QPoint operator*(double factor, const QPoint &point) \overload \relates QPoint + \since 4.8 Returns a copy of the given \a point multiplied by the given \a factor. */ @@ -309,6 +317,7 @@ QT_BEGIN_NAMESPACE \fn const QPoint operator*(int factor, const QPoint &point) \overload \relates QPoint + \since 4.8 Returns a copy of the given \a point multiplied by the given \a factor. */ diff --git a/src/corelib/tools/qset.qdoc b/src/corelib/tools/qset.qdoc index f562c68..31129e0 100644 --- a/src/corelib/tools/qset.qdoc +++ b/src/corelib/tools/qset.qdoc @@ -124,6 +124,7 @@ /*! \fn void QSet::swap(QSet<T> &other) + \since 4.8 Swaps set \a other with this set. This operation is very fast and never fails. diff --git a/src/corelib/tools/qstring.cpp b/src/corelib/tools/qstring.cpp index ee45cfd..791bfff 100644 --- a/src/corelib/tools/qstring.cpp +++ b/src/corelib/tools/qstring.cpp @@ -839,18 +839,21 @@ int QString::grow(int size) /*! \typedef QString::const_reference + \since 4.8 The QString::const_reference typedef provides an STL-style const reference for QString. */ /*! \typedef QString::reference + \since 4.8 The QString::const_reference typedef provides an STL-style reference for QString. */ /*! \typedef QString::value_type + \since 4.8 The QString::const_reference typedef provides an STL-style value type for QString. diff --git a/src/corelib/xml/qxmlstream.cpp b/src/corelib/xml/qxmlstream.cpp index caaffd3..9682688 100644 --- a/src/corelib/xml/qxmlstream.cpp +++ b/src/corelib/xml/qxmlstream.cpp @@ -3381,7 +3381,10 @@ int QXmlStreamWriter::autoFormattingIndent() const } /*! - Returns \c true if the stream failed to write to the underlying device. + \since 4.8 + + Returns true if the stream failed to write to the underlying device; + otherwise returns false. The error status is never reset. Writes happening after the error occurred are ignored, even if the error condition is cleared. |