diff options
Diffstat (limited to 'src/corelib')
60 files changed, 1111 insertions, 1111 deletions
diff --git a/src/corelib/animation/qvariantanimation.cpp b/src/corelib/animation/qvariantanimation.cpp index 35a340836d..2262a3836e 100644 --- a/src/corelib/animation/qvariantanimation.cpp +++ b/src/corelib/animation/qvariantanimation.cpp @@ -98,18 +98,18 @@ QT_BEGIN_NAMESPACE supported QVariant types: \list - \o \l{QMetaType::}{Int} - \o \l{QMetaType::}{Double} - \o \l{QMetaType::}{Float} - \o \l{QMetaType::}{QLine} - \o \l{QMetaType::}{QLineF} - \o \l{QMetaType::}{QPoint} - \o \l{QMetaType::}{QPointF} - \o \l{QMetaType::}{QSize} - \o \l{QMetaType::}{QSizeF} - \o \l{QMetaType::}{QRect} - \o \l{QMetaType::}{QRectF} - \o \l{QMetaType::}{QColor} + \li \l{QMetaType::}{Int} + \li \l{QMetaType::}{Double} + \li \l{QMetaType::}{Float} + \li \l{QMetaType::}{QLine} + \li \l{QMetaType::}{QLineF} + \li \l{QMetaType::}{QPoint} + \li \l{QMetaType::}{QPointF} + \li \l{QMetaType::}{QSize} + \li \l{QMetaType::}{QSizeF} + \li \l{QMetaType::}{QRect} + \li \l{QMetaType::}{QRectF} + \li \l{QMetaType::}{QColor} \endlist If you need to interpolate other variant types, including custom diff --git a/src/corelib/codecs/codecs.qdoc b/src/corelib/codecs/codecs.qdoc index 2127a0a4cf..669072f789 100644 --- a/src/corelib/codecs/codecs.qdoc +++ b/src/corelib/codecs/codecs.qdoc @@ -77,9 +77,9 @@ are met: \list 1 - \o Redistributions of source code must retain the above copyright + \li Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. - \o Redistributions in binary form must reproduce the above copyright + \li Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. \endlist @@ -126,9 +126,9 @@ Currently, the Big5-HKSCS tables are generated from the following sources, and with the Euro character added: \list 1 - \o \l{http://www.microsoft.com/typography/unicode/950.txt} - \o \l{http://www.info.gov.hk/digital21/chi/hkscs/download/big5-iso.txt} - \o \l{http://www.info.gov.hk/digital21/chi/hkscs/download/big5cmp.txt} + \li \l{http://www.microsoft.com/typography/unicode/950.txt} + \li \l{http://www.info.gov.hk/digital21/chi/hkscs/download/big5-iso.txt} + \li \l{http://www.info.gov.hk/digital21/chi/hkscs/download/big5cmp.txt} \endlist There may be more fine-tuning to the QBig5hkscsCodec to maximize its @@ -147,9 +147,9 @@ are met: \list 1 - \o Redistributions of source code must retain the above copyright + \li Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. - \o Redistributions in binary form must reproduce the above copyright + \li Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. \endlist @@ -195,9 +195,9 @@ are met: \list 1 - \o Redistributions of source code must retain the above copyright + \li Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. - \o Redistributions in binary form must reproduce the above copyright + \li Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. \endlist @@ -238,9 +238,9 @@ are met: \list 1 - \o Redistributions of source code must retain the above copyright + \li Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. - \o Redistributions in binary form must reproduce the above copyright + \li Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. \endlist @@ -282,9 +282,9 @@ Some must-read documents are: \list - \o \l{ftp://ftp.oreilly.com/pub/examples/nutshell/cjkv/pdf/GB18030_Summary.pdf} - \o \l{http://oss.software.ibm.com/cvs/icu/~checkout~/charset/source/gb18030/gb18030.html} - \o \l{http://oss.software.ibm.com/cvs/icu/~checkout~/charset/data/xml/gb-18030-2000.xml} + \li \l{ftp://ftp.oreilly.com/pub/examples/nutshell/cjkv/pdf/GB18030_Summary.pdf} + \li \l{http://oss.software.ibm.com/cvs/icu/~checkout~/charset/source/gb18030/gb18030.html} + \li \l{http://oss.software.ibm.com/cvs/icu/~checkout~/charset/data/xml/gb-18030-2000.xml} \endlist The GBK codec was contributed to Qt by @@ -316,9 +316,9 @@ are met: \list 1 - \o Redistributions of source code must retain the above copyright + \li Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. - \o Redistributions in binary form must reproduce the above copyright + \li Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. \endlist @@ -354,30 +354,30 @@ \list - \o "unicode-0.9" or "unicode-0201" for Unicode style. This assumes + \li "unicode-0.9" or "unicode-0201" for Unicode style. This assumes JISX0201 for 0x00-0x7f. (0.9 is a table version of jisx02xx mapping used for Unicode 1.1.) - \o "unicode-ascii" This assumes US-ASCII for 0x00-0x7f; some + \li "unicode-ascii" This assumes US-ASCII for 0x00-0x7f; some chars (JISX0208 0x2140 and JISX0212 0x2237) are different from Unicode 1.1 to avoid conflict. - \o "open-19970715-0201" ("open-0201" for convenience) or + \li "open-19970715-0201" ("open-0201" for convenience) or "jisx0221-1995" for JISX0221-JISX0201 style. JIS X 0221 is JIS version of Unicode, but a few chars (0x5c, 0x7e, 0x2140, 0x216f, 0x2131) are different from Unicode 1.1. This is used when 0x5c is treated as YEN SIGN. - \o "open-19970715-ascii" ("open-ascii" for convenience) for + \li "open-19970715-ascii" ("open-ascii" for convenience) for JISX0221-ASCII style. This is used when 0x5c is treated as REVERSE SOLIDUS. - \o "open-19970715-ms" ("open-ms" for convenience) or "cp932" for + \li "open-19970715-ms" ("open-ms" for convenience) or "cp932" for Microsoft Windows style. Windows Code Page 932. Some chars (0x2140, 0x2141, 0x2142, 0x215d, 0x2171, 0x2172) are different from Unicode 1.1. - \o "jdk1.1.7" for Sun's JDK style. Same as Unicode 1.1, except that + \li "jdk1.1.7" for Sun's JDK style. Same as Unicode 1.1, except that JIS 0x2140 is mapped to UFF3C. Either ASCII or JISX0201 can be used for 0x00-0x7f. @@ -405,9 +405,9 @@ are met: \list 1 - \o Redistributions of source code must retain the above copyright + \li Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. - \o Redistributions in binary form must reproduce the above copyright + \li Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. \endlist @@ -454,9 +454,9 @@ are met: \list 1 - \o Redistributions of source code must retain the above copyright + \li Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. - \o Redistributions in binary form must reproduce the above copyright + \li Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. \endlist @@ -510,9 +510,9 @@ are met: \list 1 - \o Redistributions of source code must retain the above copyright + \li Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. - \o Redistributions in binary form must reproduce the above copyright + \li Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. \endlist diff --git a/src/corelib/codecs/qtextcodec.cpp b/src/corelib/codecs/qtextcodec.cpp index 68866b9000..4cfdfe5966 100644 --- a/src/corelib/codecs/qtextcodec.cpp +++ b/src/corelib/codecs/qtextcodec.cpp @@ -789,38 +789,38 @@ QTextCodec::ConverterState::~ConverterState() The supported encodings are: \list - \o Apple Roman - \o \l{Big5 Text Codec}{Big5} - \o \l{Big5-HKSCS Text Codec}{Big5-HKSCS} - \o CP949 - \o \l{EUC-JP Text Codec}{EUC-JP} - \o \l{EUC-KR Text Codec}{EUC-KR} - \o \l{GBK Text Codec}{GB18030-0} - \o IBM 850 - \o IBM 866 - \o IBM 874 - \o \l{ISO 2022-JP (JIS) Text Codec}{ISO 2022-JP} - \o ISO 8859-1 to 10 - \o ISO 8859-13 to 16 - \o Iscii-Bng, Dev, Gjr, Knd, Mlm, Ori, Pnj, Tlg, and Tml - \o JIS X 0201 - \o JIS X 0208 - \o KOI8-R - \o KOI8-U - \o MuleLao-1 - \o ROMAN8 - \o \l{Shift-JIS Text Codec}{Shift-JIS} - \o TIS-620 - \o \l{TSCII Text Codec}{TSCII} - \o UTF-8 - \o UTF-16 - \o UTF-16BE - \o UTF-16LE - \o UTF-32 - \o UTF-32BE - \o UTF-32LE - \o Windows-1250 to 1258 - \o WINSAMI2 + \li Apple Roman + \li \l{Big5 Text Codec}{Big5} + \li \l{Big5-HKSCS Text Codec}{Big5-HKSCS} + \li CP949 + \li \l{EUC-JP Text Codec}{EUC-JP} + \li \l{EUC-KR Text Codec}{EUC-KR} + \li \l{GBK Text Codec}{GB18030-0} + \li IBM 850 + \li IBM 866 + \li IBM 874 + \li \l{ISO 2022-JP (JIS) Text Codec}{ISO 2022-JP} + \li ISO 8859-1 to 10 + \li ISO 8859-13 to 16 + \li Iscii-Bng, Dev, Gjr, Knd, Mlm, Ori, Pnj, Tlg, and Tml + \li JIS X 0201 + \li JIS X 0208 + \li KOI8-R + \li KOI8-U + \li MuleLao-1 + \li ROMAN8 + \li \l{Shift-JIS Text Codec}{Shift-JIS} + \li TIS-620 + \li \l{TSCII Text Codec}{TSCII} + \li UTF-8 + \li UTF-16 + \li UTF-16BE + \li UTF-16LE + \li UTF-32 + \li UTF-32BE + \li UTF-32LE + \li Windows-1250 to 1258 + \li WINSAMI2 \endlist QTextCodecs can be used as follows to convert some locally encoded @@ -871,29 +871,29 @@ QTextCodec::ConverterState::~ConverterState() QTextCodec and implement the functions listed in the table below. \table - \header \o Function \o Description + \header \li Function \li Description - \row \o name() - \o Returns the official name for the encoding. If the + \row \li name() + \li Returns the official name for the encoding. If the encoding is listed in the \l{IANA character-sets encoding file}, the name should be the preferred MIME name for the encoding. - \row \o aliases() - \o Returns a list of alternative names for the encoding. + \row \li aliases() + \li Returns a list of alternative names for the encoding. QTextCodec provides a default implementation that returns an empty list. For example, "ISO-8859-1" has "latin1", "CP819", "IBM819", and "iso-ir-100" as aliases. - \row \o mibEnum() - \o Return the MIB enum for the encoding if it is listed in + \row \li mibEnum() + \li Return the MIB enum for the encoding if it is listed in the \l{IANA character-sets encoding file}. - \row \o convertToUnicode() - \o Converts an 8-bit character string to Unicode. + \row \li convertToUnicode() + \li Converts an 8-bit character string to Unicode. - \row \o convertFromUnicode() - \o Converts a Unicode string to an 8-bit character string. + \row \li convertFromUnicode() + \li Converts a Unicode string to an 8-bit character string. \endtable \sa QTextStream, QTextDecoder, QTextEncoder, {Codecs Example} diff --git a/src/corelib/global/qglobal.cpp b/src/corelib/global/qglobal.cpp index 6257376b62..a30250df81 100644 --- a/src/corelib/global/qglobal.cpp +++ b/src/corelib/global/qglobal.cpp @@ -892,13 +892,13 @@ bool qSharedBuild() \brief The QSysInfo class provides information about the system. \list - \o \l WordSize specifies the size of a pointer for the platform + \li \l WordSize specifies the size of a pointer for the platform on which the application is compiled. - \o \l ByteOrder specifies whether the platform is big-endian or + \li \l ByteOrder specifies whether the platform is big-endian or little-endian. - \o \l WindowsVersion specifies the version of the Windows operating + \li \l WindowsVersion specifies the version of the Windows operating system on which the application is run (Windows only) - \o \l MacintoshVersion specifies the version of the Macintosh + \li \l MacintoshVersion specifies the version of the Macintosh operating system on which the application is run (Mac only). \endlist @@ -2462,12 +2462,12 @@ int qrand() \a Flags can be one of the following: \list - \o \c Q_PRIMITIVE_TYPE specifies that \a Type is a POD (plain old + \li \c Q_PRIMITIVE_TYPE specifies that \a Type is a POD (plain old data) type with no constructor or destructor. - \o \c Q_MOVABLE_TYPE specifies that \a Type has a constructor + \li \c Q_MOVABLE_TYPE specifies that \a Type has a constructor and/or a destructor but can be moved in memory using \c memcpy(). - \o \c Q_COMPLEX_TYPE (the default) specifies that \a Type has + \li \c Q_COMPLEX_TYPE (the default) specifies that \a Type has constructors and/or a destructor and that it may not be moved in memory. \endlist diff --git a/src/corelib/global/qlogging.cpp b/src/corelib/global/qlogging.cpp index badccc947d..8cbd4528dc 100644 --- a/src/corelib/global/qlogging.cpp +++ b/src/corelib/global/qlogging.cpp @@ -309,7 +309,7 @@ QDebug QMessageLogger::critical() message handler has been installed, the message is printed to stderr. Under Windows, the message is sent to the debugger. - If you are using the \bold{default message handler} this function will + If you are using the \b{default message handler} this function will abort on Unix systems to create a core dump. On Windows, for debug builds, this function will report a _CRT_ERROR enabling you to connect a debugger to the application. diff --git a/src/corelib/global/qnamespace.qdoc b/src/corelib/global/qnamespace.qdoc index 895feb7f53..7d5eec4271 100644 --- a/src/corelib/global/qnamespace.qdoc +++ b/src/corelib/global/qnamespace.qdoc @@ -266,7 +266,7 @@ This enum provides shorter names for the keyboard modifier keys supported by Qt. - \bold{Note:} On Mac OS X, the \c CTRL value corresponds to + \b{Note:} On Mac OS X, the \c CTRL value corresponds to the Command keys on the Macintosh keyboard, and the \c META value corresponds to the Control keys. @@ -319,21 +319,21 @@ \table \row - \o \inlineimage qpen-solid.png - \o \inlineimage qpen-dash.png - \o \inlineimage qpen-dot.png + \li \inlineimage qpen-solid.png + \li \inlineimage qpen-dash.png + \li \inlineimage qpen-dot.png \row - \o Qt::SolidLine - \o Qt::DashLine - \o Qt::DotLine + \li Qt::SolidLine + \li Qt::DashLine + \li Qt::DotLine \row - \o \inlineimage qpen-dashdot.png - \o \inlineimage qpen-dashdotdot.png - \o \inlineimage qpen-custom.png + \li \inlineimage qpen-dashdot.png + \li \inlineimage qpen-dashdotdot.png + \li \inlineimage qpen-custom.png \row - \o Qt::DashDotLine - \o Qt::DashDotDotLine - \o Qt::CustomDashLine + \li Qt::DashDotLine + \li Qt::DashDotDotLine + \li Qt::CustomDashLine \endtable \value NoPen no line at all. For example, QPainter::drawRect() @@ -360,13 +360,13 @@ \table \row - \o \inlineimage qpen-square.png - \o \inlineimage qpen-flat.png - \o \inlineimage qpen-roundcap.png + \li \inlineimage qpen-square.png + \li \inlineimage qpen-flat.png + \li \inlineimage qpen-roundcap.png \row - \o Qt::SquareCap - \o Qt::FlatCap - \o Qt::RoundCap + \li Qt::SquareCap + \li Qt::FlatCap + \li Qt::RoundCap \endtable \value FlatCap a square line end that does not cover the end @@ -388,13 +388,13 @@ \table \row - \o \inlineimage qpen-bevel.png - \o \inlineimage qpen-miter.png - \o \inlineimage qpen-roundjoin.png + \li \inlineimage qpen-bevel.png + \li \inlineimage qpen-miter.png + \li \inlineimage qpen-roundjoin.png \row - \o Qt::BevelJoin - \o Qt::MiterJoin - \o Qt::RoundJoin + \li Qt::BevelJoin + \li Qt::MiterJoin + \li Qt::RoundJoin \endtable \value MiterJoin The outer edges of the lines are extended to @@ -968,7 +968,7 @@ \value WA_NoSystemBackground Indicates that the widget has no background, i.e. when the widget receives paint events, the background is not automatically repainted. \note Unlike WA_OpaquePaintEvent, newly exposed - areas are \bold never filled with the background (e.g., after showing a + areas are \b never filled with the background (e.g., after showing a window for the first time the user can see "through" it until the application processes the paint events). This flag is set or cleared by the widget's author. diff --git a/src/corelib/io/qdatastream.cpp b/src/corelib/io/qdatastream.cpp index f3fe91427a..1fe2a793a6 100644 --- a/src/corelib/io/qdatastream.cpp +++ b/src/corelib/io/qdatastream.cpp @@ -184,7 +184,7 @@ QT_BEGIN_NAMESPACE \endcode To see if your favorite Qt class has similar stream operators - defined, check the \bold {Related Non-Members} section of the + defined, check the \b {Related Non-Members} section of the class's documentation page. \sa QTextStream QVariant @@ -571,19 +571,19 @@ void QDataStream::setByteOrder(ByteOrder bo) serialization format used by QDataStream. \table - \header \i Qt Version \i QDataStream Version - \row \i Qt 4.6 \i 12 - \row \i Qt 4.5 \i 11 - \row \i Qt 4.4 \i 10 - \row \i Qt 4.3 \i 9 - \row \i Qt 4.2 \i 8 - \row \i Qt 4.0, 4.1 \i 7 - \row \i Qt 3.3 \i 6 - \row \i Qt 3.1, 3.2 \i 5 - \row \i Qt 3.0 \i 4 - \row \i Qt 2.1, 2.2, 2.3 \i 3 - \row \i Qt 2.0 \i 2 - \row \i Qt 1.x \i 1 + \header \li Qt Version \li QDataStream Version + \row \li Qt 4.6 \li 12 + \row \li Qt 4.5 \li 11 + \row \li Qt 4.4 \li 10 + \row \li Qt 4.3 \li 9 + \row \li Qt 4.2 \li 8 + \row \li Qt 4.0, 4.1 \li 7 + \row \li Qt 3.3 \li 6 + \row \li Qt 3.1, 3.2 \li 5 + \row \li Qt 3.0 \li 4 + \row \li Qt 2.1, 2.2, 2.3 \li 3 + \row \li Qt 2.0 \li 2 + \row \li Qt 1.x \li 1 \endtable The \l Version enum provides symbolic constants for the different diff --git a/src/corelib/io/qdir.cpp b/src/corelib/io/qdir.cpp index afd402d019..1dedc7c5c8 100644 --- a/src/corelib/io/qdir.cpp +++ b/src/corelib/io/qdir.cpp @@ -451,11 +451,11 @@ inline void QDirPrivate::initFileEngine() for these that return strings: \table - \header \o QDir \o QString \o Return Value - \row \o current() \o currentPath() \o The application's working directory - \row \o home() \o homePath() \o The user's home directory - \row \o root() \o rootPath() \o The root directory - \row \o temp() \o tempPath() \o The system's temporary directory + \header \li QDir \li QString \li Return Value + \row \li current() \li currentPath() \li The application's working directory + \row \li home() \li homePath() \li The user's home directory + \row \li root() \li rootPath() \li The root directory + \row \li temp() \li tempPath() \li The system's temporary directory \endtable The setCurrent() static function can also be used to set the application's @@ -1878,13 +1878,13 @@ QString QDir::currentPath() the given order) until an existing and available path is found: \list 1 - \o The path specified by the \c USERPROFILE environment variable. - \o The path formed by concatenating the \c HOMEDRIVE and \c HOMEPATH + \li The path specified by the \c USERPROFILE environment variable. + \li The path formed by concatenating the \c HOMEDRIVE and \c HOMEPATH environment variables. - \o The path specified by the \c HOME environment variable. - \o The path returned by the rootPath() function (which uses the \c SystemDrive + \li The path specified by the \c HOME environment variable. + \li The path returned by the rootPath() function (which uses the \c SystemDrive environment variable) - \o The \c{C:/} directory. + \li The \c{C:/} directory. \endlist Under non-Windows operating systems the \c HOME environment diff --git a/src/corelib/io/qfile.cpp b/src/corelib/io/qfile.cpp index fc0c90cf69..6640dca70b 100644 --- a/src/corelib/io/qfile.cpp +++ b/src/corelib/io/qfile.cpp @@ -1034,13 +1034,13 @@ bool QFile::open(OpenMode mode) then calling close() closes the adopted handle. Otherwise, close() does not actually close the file, but only flushes it. - \bold{Warning:} + \b{Warning:} \list 1 - \o If \a fh does not refer to a regular file, e.g., it is \c stdin, + \li If \a fh does not refer to a regular file, e.g., it is \c stdin, \c stdout, or \c stderr, you may not be able to seek(). size() returns \c 0 in those cases. See QIODevice::isSequential() for more information. - \o Since this function opens the file without specifying the file name, + \li Since this function opens the file without specifying the file name, you cannot use this QFile with a QFileInfo. \endlist @@ -1048,7 +1048,7 @@ bool QFile::open(OpenMode mode) \sa close(), {qmake Variable Reference#CONFIG}{qmake Variable Reference} - \bold{Note for the Windows Platform} + \b{Note for the Windows Platform} \a fh must be opened in binary mode (i.e., the mode string must contain 'b', as in "rb" or "wb") when accessing files and other random-access diff --git a/src/corelib/io/qfileinfo.cpp b/src/corelib/io/qfileinfo.cpp index a7fb0fb6c7..044c71d00a 100644 --- a/src/corelib/io/qfileinfo.cpp +++ b/src/corelib/io/qfileinfo.cpp @@ -812,7 +812,7 @@ QString QFileInfo::suffix() const /*! Returns the path of the object's parent directory as a QDir object. - \bold{Note:} The QDir returned always corresponds to the object's + \b{Note:} The QDir returned always corresponds to the object's parent directory, even if the QFileInfo represents a directory. For each of the following, dir() returns a QDir for @@ -901,7 +901,7 @@ bool QFileInfo::isExecutable() const /*! Returns true if this is a `hidden' file; otherwise returns false. - \bold{Note:} This function returns true for the special entries + \b{Note:} This function returns true for the special entries "." and ".." on Unix, even though QDir::entryList threats them as shown. */ bool QFileInfo::isHidden() const @@ -923,7 +923,7 @@ bool QFileInfo::isHidden() const Returns false if the file is otherwise supported by a virtual file system inside Qt, such as \l{the Qt Resource System}. - \bold{Note:} Native paths may still require conversion of path separators + \b{Note:} Native paths may still require conversion of path separators and character encoding, depending on platform and input requirements of the native API. diff --git a/src/corelib/io/qiodevice.cpp b/src/corelib/io/qiodevice.cpp index 3d9391ebaa..1cdfc61627 100644 --- a/src/corelib/io/qiodevice.cpp +++ b/src/corelib/io/qiodevice.cpp @@ -163,12 +163,12 @@ QIODevicePrivate::~QIODevicePrivate() random-access devices and sequential devices. \list - \o Random-access devices support seeking to arbitrary + \li Random-access devices support seeking to arbitrary positions using seek(). The current position in the file is available by calling pos(). QFile and QBuffer are examples of random-access devices. - \o Sequential devices don't support seeking to arbitrary + \li Sequential devices don't support seeking to arbitrary positions. The data must be read in one pass. The functions pos() and size() don't work for sequential devices. QTcpSocket and QProcess are examples of sequential devices. @@ -199,14 +199,14 @@ QIODevicePrivate::~QIODevicePrivate() a separate thread: \list - \o waitForReadyRead() - This function suspends operation in the + \li waitForReadyRead() - This function suspends operation in the calling thread until new data is available for reading. - \o waitForBytesWritten() - This function suspends operation in the + \li waitForBytesWritten() - This function suspends operation in the calling thread until one payload of data has been written to the device. - \o waitFor....() - Subclasses of QIODevice implement blocking + \li waitFor....() - Subclasses of QIODevice implement blocking functions for device-specific operations. For example, QProcess has a function called waitForStarted() which suspends operation in the calling thread until the process has started. @@ -1038,9 +1038,9 @@ QByteArray QIODevice::readAll() Data is read until either of the following conditions are met: \list - \o The first '\n' character is read. - \o \a maxSize - 1 bytes are read. - \o The end of the device data is detected. + \li The first '\n' character is read. + \li \a maxSize - 1 bytes are read. + \li The end of the device data is detected. \endlist For example, the following code reads a line of characters from a diff --git a/src/corelib/io/qprocess.cpp b/src/corelib/io/qprocess.cpp index 7a81313fa0..640704ec86 100644 --- a/src/corelib/io/qprocess.cpp +++ b/src/corelib/io/qprocess.cpp @@ -532,15 +532,15 @@ void QProcessPrivate::Channel::clear() certain signals are emitted: \list - \o waitForStarted() blocks until the process has started. + \li waitForStarted() blocks until the process has started. - \o waitForReadyRead() blocks until new data is + \li waitForReadyRead() blocks until new data is available for reading on the current read channel. - \o waitForBytesWritten() blocks until one payload of + \li waitForBytesWritten() blocks until one payload of data has been written to the process. - \o waitForFinished() blocks until the process has finished. + \li waitForFinished() blocks until the process has finished. \endlist Calling these functions from the main thread (the thread that @@ -1910,7 +1910,7 @@ QByteArray QProcess::readAllStandardError() \note No further splitting of the arguments is performed. - \bold{Windows:} Arguments that contain spaces are wrapped in quotes. + \b{Windows:} Arguments that contain spaces are wrapped in quotes. \sa pid(), started(), waitForStarted() */ @@ -2149,10 +2149,10 @@ int QProcess::execute(const QString &program) Note that arguments that contain spaces are not passed to the process as separate arguments. - \bold{Unix:} The started process will run in its own session and act + \b{Unix:} The started process will run in its own session and act like a daemon. - \bold{Windows:} Arguments that contain spaces are wrapped in quotes. + \b{Windows:} Arguments that contain spaces are wrapped in quotes. The started process will run as a regular standalone process. The process will be started in the directory \a workingDirectory. @@ -2183,10 +2183,10 @@ bool QProcess::startDetached(const QString &program, \note Arguments that contain spaces are not passed to the process as separate arguments. - \bold{Unix:} The started process will run in its own session and act + \b{Unix:} The started process will run in its own session and act like a daemon. - \bold{Windows:} Arguments that contain spaces are wrapped in quotes. + \b{Windows:} Arguments that contain spaces are wrapped in quotes. The started process will run as a regular standalone process. */ bool QProcess::startDetached(const QString &program, diff --git a/src/corelib/io/qsettings.cpp b/src/corelib/io/qsettings.cpp index 2021c42c4d..e4d90e000a 100644 --- a/src/corelib/io/qsettings.cpp +++ b/src/corelib/io/qsettings.cpp @@ -2112,15 +2112,15 @@ void QConfFileSettingsPrivate::ensureSectionParsed(QConfFile *confFile, avoid portability problems, follow these simple rules: \list 1 - \o Always refer to the same key using the same case. For example, + \li Always refer to the same key using the same case. For example, if you refer to a key as "text fonts" in one place in your code, don't refer to it as "Text Fonts" somewhere else. - \o Avoid key names that are identical except for the case. For + \li Avoid key names that are identical except for the case. For example, if you have a key called "MainWindow", don't try to save another key as "mainwindow". - \o Do not use slashes ('/' and '\\') in section or key names; the + \li Do not use slashes ('/' and '\\') in section or key names; the backslash character is used to separate sub keys (see below). On windows '\\' are converted by QSettings to '/', which makes them identical. @@ -2156,10 +2156,10 @@ void QConfFileSettingsPrivate::ensureSectionParsed(QConfFile *confFile, that order: \list 1 - \o a user-specific location for the Star Runner application - \o a user-specific location for all applications by MySoft - \o a system-wide location for the Star Runner application - \o a system-wide location for all applications by MySoft + \li a user-specific location for the Star Runner application + \li a user-specific location for all applications by MySoft + \li a system-wide location for the Star Runner application + \li a system-wide location for all applications by MySoft \endlist (See \l{Platform-Specific Notes} below for information on what @@ -2184,17 +2184,17 @@ void QConfFileSettingsPrivate::ensureSectionParsed(QConfFile *confFile, \snippet doc/src/snippets/settings/settings.cpp 14 The table below summarizes which QSettings objects access - which location. "\bold{X}" means that the location is the main + which location. "\b{X}" means that the location is the main location associated to the QSettings object and is used both for reading and for writing; "o" means that the location is used as a fallback when reading. \table - \header \o Locations \o \c{obj1} \o \c{obj2} \o \c{obj3} \o \c{obj4} - \row \o 1. User, Application \o \bold{X} \o \o \o - \row \o 2. User, Organization \o o \o \bold{X} \o \o - \row \o 3. System, Application \o o \o \o \bold{X} \o - \row \o 4. System, Organization \o o \o o \o o \o \bold{X} + \header \li Locations \li \c{obj1} \li \c{obj2} \li \c{obj3} \li \c{obj4} + \row \li 1. User, Application \li \b{X} \li \li \li + \row \li 2. User, Organization \li o \li \b{X} \li \li + \row \li 3. System, Application \li o \li \li \b{X} \li + \row \li 4. System, Organization \li o \li o \li o \li \b{X} \endtable The beauty of this mechanism is that it works on all platforms @@ -2276,30 +2276,30 @@ void QConfFileSettingsPrivate::ensureSectionParsed(QConfFile *confFile, following files are used by default: \list 1 - \o \c{$HOME/.config/MySoft/Star Runner.conf} (Qt for Embedded Linux: \c{$HOME/Settings/MySoft/Star Runner.conf}) - \o \c{$HOME/.config/MySoft.conf} (Qt for Embedded Linux: \c{$HOME/Settings/MySoft.conf}) - \o \c{/etc/xdg/MySoft/Star Runner.conf} - \o \c{/etc/xdg/MySoft.conf} + \li \c{$HOME/.config/MySoft/Star Runner.conf} (Qt for Embedded Linux: \c{$HOME/Settings/MySoft/Star Runner.conf}) + \li \c{$HOME/.config/MySoft.conf} (Qt for Embedded Linux: \c{$HOME/Settings/MySoft.conf}) + \li \c{/etc/xdg/MySoft/Star Runner.conf} + \li \c{/etc/xdg/MySoft.conf} \endlist On Mac OS X versions 10.2 and 10.3, these files are used by default: \list 1 - \o \c{$HOME/Library/Preferences/com.MySoft.Star Runner.plist} - \o \c{$HOME/Library/Preferences/com.MySoft.plist} - \o \c{/Library/Preferences/com.MySoft.Star Runner.plist} - \o \c{/Library/Preferences/com.MySoft.plist} + \li \c{$HOME/Library/Preferences/com.MySoft.Star Runner.plist} + \li \c{$HOME/Library/Preferences/com.MySoft.plist} + \li \c{/Library/Preferences/com.MySoft.Star Runner.plist} + \li \c{/Library/Preferences/com.MySoft.plist} \endlist On Windows, NativeFormat settings are stored in the following registry paths: \list 1 - \o \c{HKEY_CURRENT_USER\Software\MySoft\Star Runner} - \o \c{HKEY_CURRENT_USER\Software\MySoft} - \o \c{HKEY_LOCAL_MACHINE\Software\MySoft\Star Runner} - \o \c{HKEY_LOCAL_MACHINE\Software\MySoft} + \li \c{HKEY_CURRENT_USER\Software\MySoft\Star Runner} + \li \c{HKEY_CURRENT_USER\Software\MySoft} + \li \c{HKEY_LOCAL_MACHINE\Software\MySoft\Star Runner} + \li \c{HKEY_LOCAL_MACHINE\Software\MySoft} \endlist \note On Windows, for 32-bit programs running in WOW64 mode, settings are @@ -2310,19 +2310,19 @@ void QConfFileSettingsPrivate::ensureSectionParsed(QConfFile *confFile, used on Unix and Mac OS X: \list 1 - \o \c{$HOME/.config/MySoft/Star Runner.ini} (Qt for Embedded Linux: \c{$HOME/Settings/MySoft/Star Runner.ini}) - \o \c{$HOME/.config/MySoft.ini} (Qt for Embedded Linux: \c{$HOME/Settings/MySoft.ini}) - \o \c{/etc/xdg/MySoft/Star Runner.ini} - \o \c{/etc/xdg/MySoft.ini} + \li \c{$HOME/.config/MySoft/Star Runner.ini} (Qt for Embedded Linux: \c{$HOME/Settings/MySoft/Star Runner.ini}) + \li \c{$HOME/.config/MySoft.ini} (Qt for Embedded Linux: \c{$HOME/Settings/MySoft.ini}) + \li \c{/etc/xdg/MySoft/Star Runner.ini} + \li \c{/etc/xdg/MySoft.ini} \endlist On Windows, the following files are used: \list 1 - \o \c{%APPDATA%\MySoft\Star Runner.ini} - \o \c{%APPDATA%\MySoft.ini} - \o \c{%COMMON_APPDATA%\MySoft\Star Runner.ini} - \o \c{%COMMON_APPDATA%\MySoft.ini} + \li \c{%APPDATA%\MySoft\Star Runner.ini} + \li \c{%APPDATA%\MySoft.ini} + \li \c{%COMMON_APPDATA%\MySoft\Star Runner.ini} + \li \c{%COMMON_APPDATA%\MySoft.ini} \endlist The \c %APPDATA% path is usually \tt{C:\\Documents and @@ -2395,20 +2395,20 @@ void QConfFileSettingsPrivate::ensureSectionParsed(QConfFile *confFile, application: \list - \o The Windows system registry has the following limitations: A + \li The Windows system registry has the following limitations: A subkey may not exceed 255 characters, an entry's value may not exceed 16,383 characters, and all the values of a key may not exceed 65,535 characters. One way to work around these limitations is to store the settings using the IniFormat instead of the NativeFormat. - \o On Mac OS X, allKeys() will return some extra keys for global + \li On Mac OS X, allKeys() will return some extra keys for global settings that apply to all applications. These keys can be read using value() but cannot be changed, only shadowed. Calling setFallbacksEnabled(false) will hide these global settings. - \o On Mac OS X, the CFPreferences API used by QSettings expects + \li On Mac OS X, the CFPreferences API used by QSettings expects Internet domain names rather than organization names. To provide a uniform API, QSettings derives a fake domain name from the organization name (unless the organization name @@ -2425,7 +2425,7 @@ void QConfFileSettingsPrivate::ensureSectionParsed(QConfFile *confFile, \snippet doc/src/snippets/code/src_corelib_io_qsettings.cpp 7 - \o On Unix and Mac OS X systems, the advisory file locking is disabled + \li On Unix and Mac OS X systems, the advisory file locking is disabled if NFS (or AutoFS or CacheFS) is detected to work around a bug in the NFS fcntl() implementation, which hangs forever if statd or lockd aren't running. Also, the locking isn't performed when accessing \c .plist @@ -2485,7 +2485,7 @@ void QConfFileSettingsPrivate::ensureSectionParsed(QConfFile *confFile, follow what Microsoft does, with the following exceptions: \list - \o If you store types that QVariant can't convert to QString + \li If you store types that QVariant can't convert to QString (e.g., QPoint, QRect, and QSize), Qt uses an \c{@}-based syntax to encode the type. For example: @@ -2496,7 +2496,7 @@ void QConfFileSettingsPrivate::ensureSectionParsed(QConfFile *confFile, followed by a Qt type (\c Point, \c Rect, \c Size, etc.) is treated as a normal character. - \o Although backslash is a special character in INI files, most + \li Although backslash is a special character in INI files, most Windows applications don't escape backslashes (\c{\}) in file paths: @@ -2505,7 +2505,7 @@ void QConfFileSettingsPrivate::ensureSectionParsed(QConfFile *confFile, QSettings always treats backslash as a special character and provides no API for reading or writing such entries. - \o The INI file format has severe restrictions on the syntax of + \li The INI file format has severe restrictions on the syntax of a key. Qt works around this by using \c % as an escape character in keys. In addition, if you save a top-level setting (a key with no slashes in it, e.g., "someKey"), it @@ -2514,7 +2514,7 @@ void QConfFileSettingsPrivate::ensureSectionParsed(QConfFile *confFile, such as "General/someKey", the key will be located in the "%General" section, \e not in the "General" section. - \o Following the philosophy that we should be liberal in what + \li Following the philosophy that we should be liberal in what we accept and conservative in what we generate, QSettings will accept Latin-1 encoded INI files, but generate pure ASCII files, where non-ASCII values are encoded using standard @@ -2632,10 +2632,10 @@ QSettings::QSettings(Format format, Scope scope, const QString &organization, be aware of the following limitations: \list - \o QSettings provides no way of reading INI "path" entries, i.e., entries + \li QSettings provides no way of reading INI "path" entries, i.e., entries with unescaped slash characters. (This is because these entries are ambiguous and cannot be resolved automatically.) - \o In INI files, QSettings uses the \c @ character as a metacharacter in some + \li In INI files, QSettings uses the \c @ character as a metacharacter in some contexts, to encode Qt-specific data types (e.g., \c @Rect), and might therefore misinterpret it when it occurs in pure INI files. \endlist @@ -2933,9 +2933,9 @@ QSettings::Status QSettings::status() const This will set the value of three settings: \list - \o \c mainwindow/size - \o \c mainwindow/fullScreen - \o \c outputpanel/visible + \li \c mainwindow/size + \li \c mainwindow/fullScreen + \li \c outputpanel/visible \endlist Call endGroup() to reset the current group to what it was before @@ -3021,14 +3021,14 @@ int QSettings::beginReadArray(const QString &prefix) The generated keys will have the form \list - \o \c logins/size - \o \c logins/1/userName - \o \c logins/1/password - \o \c logins/2/userName - \o \c logins/2/password - \o \c logins/3/userName - \o \c logins/3/password - \o ... + \li \c logins/size + \li \c logins/1/userName + \li \c logins/1/password + \li \c logins/2/userName + \li \c logins/2/password + \li \c logins/3/userName + \li \c logins/3/password + \li ... \endlist To read back an array, use beginReadArray(). @@ -3412,15 +3412,15 @@ void QSettings::setUserIniPath(const QString &dir) The table below summarizes the default values: \table - \header \o Platform \o Format \o Scope \o Path - \row \o{1,2} Windows \o{1,2} IniFormat \o UserScope \o \c %APPDATA% - \row \o SystemScope \o \c %COMMON_APPDATA% - \row \o{1,2} Unix \o{1,2} NativeFormat, IniFormat \o UserScope \o \c $HOME/.config - \row \o SystemScope \o \c /etc/xdg - \row \o{1,2} Qt for Embedded Linux \o{1,2} NativeFormat, IniFormat \o UserScope \o \c $HOME/Settings - \row \o SystemScope \o \c /etc/xdg - \row \o{1,2} Mac OS X \o{1,2} IniFormat \o UserScope \o \c $HOME/.config - \row \o SystemScope \o \c /etc/xdg + \header \li Platform \li Format \li Scope \li Path + \row \li{1,2} Windows \li{1,2} IniFormat \li UserScope \li \c %APPDATA% + \row \li SystemScope \li \c %COMMON_APPDATA% + \row \li{1,2} Unix \li{1,2} NativeFormat, IniFormat \li UserScope \li \c $HOME/.config + \row \li SystemScope \li \c /etc/xdg + \row \li{1,2} Qt for Embedded Linux \li{1,2} NativeFormat, IniFormat \li UserScope \li \c $HOME/Settings + \row \li SystemScope \li \c /etc/xdg + \row \li{1,2} Mac OS X \li{1,2} IniFormat \li UserScope \li \c $HOME/.config + \row \li SystemScope \li \c /etc/xdg \endtable The default UserScope paths on Unix and Mac OS X (\c diff --git a/src/corelib/io/qtextstream.cpp b/src/corelib/io/qtextstream.cpp index dd0ab85119..cb703df8c6 100644 --- a/src/corelib/io/qtextstream.cpp +++ b/src/corelib/io/qtextstream.cpp @@ -90,13 +90,13 @@ static const int QTEXTSTREAM_BUFFERSIZE = 16384; \list - \o Chunk by chunk, by calling readLine() or readAll(). + \li Chunk by chunk, by calling readLine() or readAll(). - \o Word by word. QTextStream supports streaming into QStrings, + \li Word by word. QTextStream supports streaming into QStrings, QByteArrays and char* buffers. Words are delimited by space, and leading white space is automatically skipped. - \o Character by character, by streaming into QChar or char types. + \li Character by character, by streaming into QChar or char types. This method is often used for convenient input handling when parsing files, independent of character encoding and end-of-line semantics. To skip white space, call skipWhiteSpace(). @@ -134,31 +134,31 @@ static const int QTEXTSTREAM_BUFFERSIZE = 16384; defines several global manipulator functions: \table - \header \o Manipulator \o Description - \row \o \c bin \o Same as setIntegerBase(2). - \row \o \c oct \o Same as setIntegerBase(8). - \row \o \c dec \o Same as setIntegerBase(10). - \row \o \c hex \o Same as setIntegerBase(16). - \row \o \c showbase \o Same as setNumberFlags(numberFlags() | ShowBase). - \row \o \c forcesign \o Same as setNumberFlags(numberFlags() | ForceSign). - \row \o \c forcepoint \o Same as setNumberFlags(numberFlags() | ForcePoint). - \row \o \c noshowbase \o Same as setNumberFlags(numberFlags() & ~ShowBase). - \row \o \c noforcesign \o Same as setNumberFlags(numberFlags() & ~ForceSign). - \row \o \c noforcepoint \o Same as setNumberFlags(numberFlags() & ~ForcePoint). - \row \o \c uppercasebase \o Same as setNumberFlags(numberFlags() | UppercaseBase). - \row \o \c uppercasedigits \o Same as setNumberFlags(numberFlags() | UppercaseDigits). - \row \o \c lowercasebase \o Same as setNumberFlags(numberFlags() & ~UppercaseBase). - \row \o \c lowercasedigits \o Same as setNumberFlags(numberFlags() & ~UppercaseDigits). - \row \o \c fixed \o Same as setRealNumberNotation(FixedNotation). - \row \o \c scientific \o Same as setRealNumberNotation(ScientificNotation). - \row \o \c left \o Same as setFieldAlignment(AlignLeft). - \row \o \c right \o Same as setFieldAlignment(AlignRight). - \row \o \c center \o Same as setFieldAlignment(AlignCenter). - \row \o \c endl \o Same as operator<<('\n') and flush(). - \row \o \c flush \o Same as flush(). - \row \o \c reset \o Same as reset(). - \row \o \c ws \o Same as skipWhiteSpace(). - \row \o \c bom \o Same as setGenerateByteOrderMark(true). + \header \li Manipulator \li Description + \row \li \c bin \li Same as setIntegerBase(2). + \row \li \c oct \li Same as setIntegerBase(8). + \row \li \c dec \li Same as setIntegerBase(10). + \row \li \c hex \li Same as setIntegerBase(16). + \row \li \c showbase \li Same as setNumberFlags(numberFlags() | ShowBase). + \row \li \c forcesign \li Same as setNumberFlags(numberFlags() | ForceSign). + \row \li \c forcepoint \li Same as setNumberFlags(numberFlags() | ForcePoint). + \row \li \c noshowbase \li Same as setNumberFlags(numberFlags() & ~ShowBase). + \row \li \c noforcesign \li Same as setNumberFlags(numberFlags() & ~ForceSign). + \row \li \c noforcepoint \li Same as setNumberFlags(numberFlags() & ~ForcePoint). + \row \li \c uppercasebase \li Same as setNumberFlags(numberFlags() | UppercaseBase). + \row \li \c uppercasedigits \li Same as setNumberFlags(numberFlags() | UppercaseDigits). + \row \li \c lowercasebase \li Same as setNumberFlags(numberFlags() & ~UppercaseBase). + \row \li \c lowercasedigits \li Same as setNumberFlags(numberFlags() & ~UppercaseDigits). + \row \li \c fixed \li Same as setRealNumberNotation(FixedNotation). + \row \li \c scientific \li Same as setRealNumberNotation(ScientificNotation). + \row \li \c left \li Same as setFieldAlignment(AlignLeft). + \row \li \c right \li Same as setFieldAlignment(AlignRight). + \row \li \c center \li Same as setFieldAlignment(AlignCenter). + \row \li \c endl \li Same as operator<<('\n') and flush(). + \row \li \c flush \li Same as flush(). + \row \li \c reset \li Same as reset(). + \row \li \c ws \li Same as skipWhiteSpace(). + \row \li \c bom \li Same as setGenerateByteOrderMark(true). \endtable In addition, Qt provides three global manipulators that take a @@ -2065,12 +2065,12 @@ QTextStream &QTextStream::operator>>(char &c) number using the following rules: \table - \header \o Prefix \o Base - \row \o "0b" or "0B" \o 2 (binary) - \row \o "0" followed by "0-7" \o 8 (octal) - \row \o "0" otherwise \o 10 (decimal) - \row \o "0x" or "0X" \o 16 (hexadecimal) - \row \o "1" to "9" \o 10 (decimal) + \header \li Prefix \li Base + \row \li "0b" or "0B" \li 2 (binary) + \row \li "0" followed by "0-7" \li 8 (octal) + \row \li "0" otherwise \li 10 (decimal) + \row \li "0x" or "0X" \li 16 (hexadecimal) + \row \li "1" to "9" \li 10 (decimal) \endtable By calling setIntegerBase(), you can specify the integer base diff --git a/src/corelib/io/qurl.cpp b/src/corelib/io/qurl.cpp index eeeca1bf77..0659053937 100644 --- a/src/corelib/io/qurl.cpp +++ b/src/corelib/io/qurl.cpp @@ -112,7 +112,7 @@ dealing with URLs and strings: \list - \o When creating an QString to contain a URL from a QByteArray or a + \li When creating an QString to contain a URL from a QByteArray or a char*, always use QString::fromUtf8(). \endlist @@ -135,15 +135,15 @@ \list - \o Spaces and "%20": If an encoded URL contains a space, this will be + \li Spaces and "%20": If an encoded URL contains a space, this will be replaced with "%20". If a decoded URL contains "%20", this will be replaced with a single space before the URL is parsed. - \o Single "%" characters: Any occurrences of a percent character "%" not + \li Single "%" characters: Any occurrences of a percent character "%" not followed by exactly two hexadecimal characters (e.g., "13% coverage.html") will be replaced by "%25". - \o Reserved and unreserved characters: An encoded URL should only + \li Reserved and unreserved characters: An encoded URL should only contain a few characters as literals; all other characters should be percent-encoded. In TolerantMode, these characters will be automatically percent-encoded where they are not allowed: @@ -6335,10 +6335,10 @@ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. \section1 Examples: \list - \o qt.nokia.com becomes http://qt.nokia.com - \o ftp.qt.nokia.com becomes ftp://ftp.qt.nokia.com - \o hostname becomes http://hostname - \o /home/user/test.html becomes file:///home/user/test.html + \li qt.nokia.com becomes http://qt.nokia.com + \li ftp.qt.nokia.com becomes ftp://ftp.qt.nokia.com + \li hostname becomes http://hostname + \li /home/user/test.html becomes file:///home/user/test.html \endlist */ QUrl QUrl::fromUserInput(const QString &userInput) diff --git a/src/corelib/itemmodels/qabstractitemmodel.cpp b/src/corelib/itemmodels/qabstractitemmodel.cpp index a8c3921f45..7a1357959e 100644 --- a/src/corelib/itemmodels/qabstractitemmodel.cpp +++ b/src/corelib/itemmodels/qabstractitemmodel.cpp @@ -1161,16 +1161,16 @@ void QAbstractItemModelPrivate::columnsRemoved(const QModelIndex &parent, \e before and \e after they occur: \list - \o An insertRows() implementation must call beginInsertRows() \e before + \li An insertRows() implementation must call beginInsertRows() \e before inserting new rows into the data structure, and endInsertRows() \e{immediately afterwards}. - \o An insertColumns() implementation must call beginInsertColumns() + \li An insertColumns() implementation must call beginInsertColumns() \e before inserting new columns into the data structure, and endInsertColumns() \e{immediately afterwards}. - \o A removeRows() implementation must call beginRemoveRows() \e before + \li A removeRows() implementation must call beginRemoveRows() \e before the rows are removed from the data structure, and endRemoveRows() \e{immediately afterwards}. - \o A removeColumns() implementation must call beginRemoveColumns() + \li A removeColumns() implementation must call beginRemoveColumns() \e before the columns are removed from the data structure, and endRemoveColumns() \e{immediately afterwards}. \endlist @@ -1179,7 +1179,7 @@ void QAbstractItemModelPrivate::columnsRemoved(const QModelIndex &parent, the chance to take action before any data becomes unavailable. The encapsulation of the insert and remove operations with these begin and end functions also enables the model to manage \l{QPersistentModelIndex} - {persistent model indexes} correctly. \bold{If you want selections to be + {persistent model indexes} correctly. \b{If you want selections to be handled properly, you must ensure that you call these functions.} If you insert or remove an item with children, you do not need to call these functions for the child items. In other words, the parent item will take @@ -1338,11 +1338,11 @@ void QAbstractItemModelPrivate::columnsRemoved(const QModelIndex &parent, layoutChanged(). In other words, when the structure changes: \list - \o emit layoutAboutToBeChanged - \o Remember the QModelIndex that will change - \o Update your internal data - \o Call changePersistentIndex() - \o emit layoutChanged + \li emit layoutAboutToBeChanged + \li Remember the QModelIndex that will change + \li Update your internal data + \li Call changePersistentIndex() + \li emit layoutChanged \endlist \sa layoutAboutToBeChanged(), dataChanged(), headerDataChanged(), modelReset(), @@ -1500,7 +1500,7 @@ QAbstractItemModel::~QAbstractItemModel() inclusive, under the given \a sourceParent item have been moved to \a destinationParent starting at the row \a destinationRow. - \bold{Note:} Components connected to this signal use it to adapt to changes + \b{Note:} Components connected to this signal use it to adapt to changes in the model's dimensions. It can only be emitted by the QAbstractItemModel implementation, and cannot be explicitly emitted in subclass code. @@ -1516,7 +1516,7 @@ QAbstractItemModel::~QAbstractItemModel() inclusive, under the given \a sourceParent item. They will be moved to \a destinationParent starting at the row \a destinationRow. - \bold{Note:} Components connected to this signal use it to adapt to changes + \b{Note:} Components connected to this signal use it to adapt to changes in the model's dimensions. It can only be emitted by the QAbstractItemModel implementation, and cannot be explicitly emitted in subclass code. @@ -1532,7 +1532,7 @@ QAbstractItemModel::~QAbstractItemModel() inclusive, under the given \a sourceParent item have been moved to \a destinationParent starting at the column \a destinationColumn. - \bold{Note:} Components connected to this signal use it to adapt to changes + \b{Note:} Components connected to this signal use it to adapt to changes in the model's dimensions. It can only be emitted by the QAbstractItemModel implementation, and cannot be explicitly emitted in subclass code. @@ -1548,7 +1548,7 @@ QAbstractItemModel::~QAbstractItemModel() inclusive, under the given \a sourceParent item. They will be moved to \a destinationParent starting at the column \a destinationColumn. - \bold{Note:} Components connected to this signal use it to adapt to changes + \b{Note:} Components connected to this signal use it to adapt to changes in the model's dimensions. It can only be emitted by the QAbstractItemModel implementation, and cannot be explicitly emitted in subclass code. @@ -1683,7 +1683,7 @@ bool QAbstractItemModel::setData(const QModelIndex &index, const QVariant &value Returns the data stored under the given \a role for the item referred to by the \a index. - \note If you do not have a value to return, return an \bold invalid + \note If you do not have a value to return, return an \b invalid QVariant instead of returning 0. \sa Qt::ItemDataRole, setData(), headerData() @@ -2437,8 +2437,8 @@ bool QAbstractItemModel::decodeData(int row, int column, const QModelIndex &pare \table 80% \row - \o \inlineimage modelview-begin-insert-rows.png Inserting rows - \o Specify the first and last row numbers for the span of rows you + \li \inlineimage modelview-begin-insert-rows.png Inserting rows + \li Specify the first and last row numbers for the span of rows you want to insert into an item in a model. For example, as shown in the diagram, we insert three rows before @@ -2448,8 +2448,8 @@ bool QAbstractItemModel::decodeData(int row, int column, const QModelIndex &pare This inserts the three new rows as rows 2, 3, and 4. \row - \o \inlineimage modelview-begin-append-rows.png Appending rows - \o To append rows, insert them after the last row. + \li \inlineimage modelview-begin-append-rows.png Appending rows + \li To append rows, insert them after the last row. For example, as shown in the diagram, we append two rows to a collection of 4 existing rows (ending in row 3), so \a first is 4 @@ -2503,8 +2503,8 @@ void QAbstractItemModel::endInsertRows() \table 80% \row - \o \inlineimage modelview-begin-remove-rows.png Removing rows - \o Specify the first and last row numbers for the span of rows you + \li \inlineimage modelview-begin-remove-rows.png Removing rows + \li Specify the first and last row numbers for the span of rows you want to remove from an item in a model. For example, as shown in the diagram, we remove the two rows from @@ -2616,8 +2616,8 @@ bool QAbstractItemModelPrivate::allowMove(const QModelIndex &srcParent, int star \table 80% \row - \o \inlineimage modelview-move-rows-1.png Moving rows to another parent - \o Specify the first and last row numbers for the span of rows in + \li \inlineimage modelview-move-rows-1.png Moving rows to another parent + \li Specify the first and last row numbers for the span of rows in the source parent you want to move in the model. Also specify the row in the destination parent to move the span to. @@ -2630,8 +2630,8 @@ bool QAbstractItemModelPrivate::allowMove(const QModelIndex &srcParent, int star This moves the three rows rows 2, 3, and 4 in the source to become 2, 3 and 4 in the destination. Other affected siblings are displaced accordingly. \row - \o \inlineimage modelview-move-rows-2.png Moving rows to append to another parent - \o To append rows to another parent, move them to after the last row. + \li \inlineimage modelview-move-rows-2.png Moving rows to append to another parent + \li To append rows to another parent, move them to after the last row. For example, as shown in the diagram, we move three rows to a collection of 6 existing rows (ending in row 5), so \a destinationChild is 6: @@ -2640,8 +2640,8 @@ bool QAbstractItemModelPrivate::allowMove(const QModelIndex &srcParent, int star This moves the target rows to the end of the target parent as 6, 7 and 8. \row - \o \inlineimage modelview-move-rows-3.png Moving rows in the same parent up - \o To move rows within the same parent, specify the row to move them to. + \li \inlineimage modelview-move-rows-3.png Moving rows in the same parent up + \li To move rows within the same parent, specify the row to move them to. For example, as shown in the diagram, we move one item from row 2 to row 0, so \a sourceFirst and \a sourceLast are 2 and \a destinationChild is 0. @@ -2655,8 +2655,8 @@ bool QAbstractItemModelPrivate::allowMove(const QModelIndex &srcParent, int star it is already) \row - \o \inlineimage modelview-move-rows-4.png Moving rows in the same parent down - \o To move rows within the same parent, specify the row to move them to. + \li \inlineimage modelview-move-rows-4.png Moving rows in the same parent down + \li To move rows within the same parent, specify the row to move them to. For example, as shown in the diagram, we move one item from row 2 to row 4, so \a sourceFirst and \a sourceLast are 2 and \a destinationChild is 4. @@ -2737,8 +2737,8 @@ void QAbstractItemModel::endMoveRows() \table 80% \row - \o \inlineimage modelview-begin-insert-columns.png Inserting columns - \o Specify the first and last column numbers for the span of columns + \li \inlineimage modelview-begin-insert-columns.png Inserting columns + \li Specify the first and last column numbers for the span of columns you want to insert into an item in a model. For example, as shown in the diagram, we insert three columns @@ -2748,8 +2748,8 @@ void QAbstractItemModel::endMoveRows() This inserts the three new columns as columns 4, 5, and 6. \row - \o \inlineimage modelview-begin-append-columns.png Appending columns - \o To append columns, insert them after the last column. + \li \inlineimage modelview-begin-append-columns.png Appending columns + \li To append columns, insert them after the last column. For example, as shown in the diagram, we append three columns to a collection of six existing columns (ending in column 5), so @@ -2805,8 +2805,8 @@ void QAbstractItemModel::endInsertColumns() \table 80% \row - \o \inlineimage modelview-begin-remove-columns.png Removing columns - \o Specify the first and last column numbers for the span of columns + \li \inlineimage modelview-begin-remove-columns.png Removing columns + \li Specify the first and last column numbers for the span of columns you want to remove from an item in a model. For example, as shown in the diagram, we remove the three columns @@ -3135,16 +3135,16 @@ QModelIndexList QAbstractItemModel::persistentIndexList() const are aware of any changes: \list - \o An insertRows() implementation must call beginInsertRows() + \li An insertRows() implementation must call beginInsertRows() \e before inserting new rows into the data structure, and it must call endInsertRows() \e{immediately afterwards}. - \o An insertColumns() implementation must call beginInsertColumns() + \li An insertColumns() implementation must call beginInsertColumns() \e before inserting new columns into the data structure, and it must call endInsertColumns() \e{immediately afterwards}. - \o A removeRows() implementation must call beginRemoveRows() + \li A removeRows() implementation must call beginRemoveRows() \e before the rows are removed from the data structure, and it must call endRemoveRows() \e{immediately afterwards}. - \o A removeColumns() implementation must call beginRemoveColumns() + \li A removeColumns() implementation must call beginRemoveColumns() \e before the columns are removed from the data structure, and it must call endRemoveColumns() \e{immediately afterwards}. \endlist @@ -3271,10 +3271,10 @@ bool QAbstractTableModel::hasChildren(const QModelIndex &parent) const functions so that all connected views are aware of any changes: \list - \o An insertRows() implementation must call beginInsertRows() + \li An insertRows() implementation must call beginInsertRows() \e before inserting new rows into the data structure, and it must call endInsertRows() \e{immediately afterwards}. - \o A removeRows() implementation must call beginRemoveRows() + \li A removeRows() implementation must call beginRemoveRows() \e before the rows are removed from the data structure, and it must call endRemoveRows() \e{immediately afterwards}. \endlist diff --git a/src/corelib/itemmodels/qsortfilterproxymodel.cpp b/src/corelib/itemmodels/qsortfilterproxymodel.cpp index b7ef69423f..ae9affb862 100644 --- a/src/corelib/itemmodels/qsortfilterproxymodel.cpp +++ b/src/corelib/itemmodels/qsortfilterproxymodel.cpp @@ -2531,16 +2531,16 @@ void QSortFilterProxyModel::invalidateFilter() the following QVariant types: \list - \o QVariant::Int - \o QVariant::UInt - \o QVariant::LongLong - \o QVariant::ULongLong - \o QVariant::Double - \o QVariant::Char - \o QVariant::Date - \o QVariant::Time - \o QVariant::DateTime - \o QVariant::String + \li QVariant::Int + \li QVariant::UInt + \li QVariant::LongLong + \li QVariant::ULongLong + \li QVariant::Double + \li QVariant::Char + \li QVariant::Date + \li QVariant::Time + \li QVariant::DateTime + \li QVariant::String \endlist Any other type will be converted to a QString using diff --git a/src/corelib/json/qjsonarray.cpp b/src/corelib/json/qjsonarray.cpp index 0eb1974147..cdf9192b27 100644 --- a/src/corelib/json/qjsonarray.cpp +++ b/src/corelib/json/qjsonarray.cpp @@ -559,7 +559,7 @@ bool QJsonArray::operator!=(const QJsonArray &other) const /*! \typedef QJsonArray::iterator::iterator_category - A synonym for \i {std::random_access_iterator_tag} indicating + A synonym for \e {std::random_access_iterator_tag} indicating this iterator is a random access iterator. */ @@ -793,7 +793,7 @@ bool QJsonArray::operator!=(const QJsonArray &other) const /*! \typedef QJsonArray::const_iterator::iterator_category - A synonym for \i {std::random_access_iterator_tag} indicating + A synonym for \e {std::random_access_iterator_tag} indicating this iterator is a random access iterator. */ diff --git a/src/corelib/json/qjsonobject.cpp b/src/corelib/json/qjsonobject.cpp index b7af8c22cf..a854f73c7e 100644 --- a/src/corelib/json/qjsonobject.cpp +++ b/src/corelib/json/qjsonobject.cpp @@ -568,7 +568,7 @@ QJsonObject::const_iterator QJsonObject::constFind(const QString &key) const /*! \typedef QJsonObject::iterator::iterator_category - A synonym for \i {std::bidirectional_iterator_tag} indicating + A synonym for \e {std::bidirectional_iterator_tag} indicating this iterator is a bidirectional iterator. */ @@ -757,7 +757,7 @@ QJsonObject::const_iterator QJsonObject::constFind(const QString &key) const /*! \typedef QJsonObject::const_iterator::iterator_category - A synonym for \i {std::bidirectional_iterator_tag} indicating + A synonym for \e {std::bidirectional_iterator_tag} indicating this iterator is a bidirectional iterator. */ diff --git a/src/corelib/json/qjsonvalue.cpp b/src/corelib/json/qjsonvalue.cpp index 603cba8897..b4a689da60 100644 --- a/src/corelib/json/qjsonvalue.cpp +++ b/src/corelib/json/qjsonvalue.cpp @@ -64,12 +64,12 @@ QT_BEGIN_NAMESPACE JSON is a format to store structured data. It has 6 basic data types: \list - \o bool QJsonValue::Bool - \o double QJsonValue::Double - \o string QJsonValue::String - \o array QJsonValue::Array - \o object QJsonValue::Object - \o null QJsonValue::Null + \li bool QJsonValue::Bool + \li double QJsonValue::Double + \li string QJsonValue::String + \li array QJsonValue::Array + \li object QJsonValue::Object + \li null QJsonValue::Null \endlist A value can represent any of the above data types. In addition, QJsonValue has one special @@ -260,16 +260,16 @@ QJsonValue &QJsonValue::operator =(const QJsonValue &other) The conversion will convert QVariant types as follows: \list - \o QVariant::Bool to Bool - \o QVariant::Int - \o QVariant::Double - \o QVariant::LongLong - \o QVariant::ULongLong - \o QVariant::UInt to Double - \o QVariant::String to String - \o QVariant::StringList - \o QVariant::VariantList to Array - \o QVariant::VariantMap to Object + \li QVariant::Bool to Bool + \li QVariant::Int + \li QVariant::Double + \li QVariant::LongLong + \li QVariant::ULongLong + \li QVariant::UInt to Double + \li QVariant::String to String + \li QVariant::StringList + \li QVariant::VariantList to Array + \li QVariant::VariantMap to Object \endlist For all other QVariant types a conversion to a QString will be attempted. If the returned string diff --git a/src/corelib/kernel/qabstracteventdispatcher.cpp b/src/corelib/kernel/qabstracteventdispatcher.cpp index 3075eab753..b98f3f4a30 100644 --- a/src/corelib/kernel/qabstracteventdispatcher.cpp +++ b/src/corelib/kernel/qabstracteventdispatcher.cpp @@ -167,7 +167,7 @@ QAbstractEventDispatcher::~QAbstractEventDispatcher() event dispatcher exists for the specified thread, this function returns 0. - \bold{Note:} If Qt is built without thread support, the \a thread + \b{Note:} If Qt is built without thread support, the \a thread argument is ignored. */ QAbstractEventDispatcher *QAbstractEventDispatcher::instance(QThread *thread) @@ -192,10 +192,10 @@ QAbstractEventDispatcher *QAbstractEventDispatcher::instance(QThread *thread) \list - \i If events are available, this function returns after processing + \li If events are available, this function returns after processing them. - \i If no events are available, this function will wait until more + \li If no events are available, this function will wait until more are available and return after processing newly available events. \endlist @@ -204,7 +204,7 @@ QAbstractEventDispatcher *QAbstractEventDispatcher::instance(QThread *thread) and no events are available, this function will return immediately. - \bold{Note:} This function does not process events continuously; it + \b{Note:} This function does not process events continuously; it returns after all available events are processed. \sa hasPendingEvents() @@ -349,17 +349,17 @@ void QAbstractEventDispatcher::closingDown() \table \header - \o Platform - \o type + \li Platform + \li type \row - \o Windows - \o MSG + \li Windows + \li MSG \row - \o X11 - \o XEvent + \li X11 + \li XEvent \row - \o Mac - \o NSEvent + \li Mac + \li NSEvent \endtable diff --git a/src/corelib/kernel/qcoreapplication.cpp b/src/corelib/kernel/qcoreapplication.cpp index 2d49b271ce..515732bc68 100644 --- a/src/corelib/kernel/qcoreapplication.cpp +++ b/src/corelib/kernel/qcoreapplication.cpp @@ -715,13 +715,13 @@ bool QCoreApplication::notifyInternal(QObject *receiver, QEvent *event) reimplementing this virtual function is just one of them. All five approaches are listed below: \list 1 - \i Reimplementing paintEvent(), mousePressEvent() and so + \li Reimplementing paintEvent(), mousePressEvent() and so on. This is the commonest, easiest and least powerful way. - \i Reimplementing this function. This is very powerful, providing + \li Reimplementing this function. This is very powerful, providing complete control; but only one subclass can be active at a time. - \i Installing an event filter on QCoreApplication::instance(). Such + \li Installing an event filter on QCoreApplication::instance(). Such an event filter is able to process all events for all widgets, so it's just as powerful as reimplementing notify(); furthermore, it's possible to have more than one application-global event filter. @@ -730,11 +730,11 @@ bool QCoreApplication::notifyInternal(QObject *receiver, QEvent *event) event filters are only called for objects that live in the main thread. - \i Reimplementing QObject::event() (as QWidget does). If you do + \li Reimplementing QObject::event() (as QWidget does). If you do this you get Tab key presses, and you get to see the events before any widget-specific event filters. - \i Installing an event filter on the object. Such an event filter gets all + \li Installing an event filter on the object. Such an event filter gets all the events, including Tab and Shift+Tab key press events, as long as they do not change the focus widget. \endlist diff --git a/src/corelib/kernel/qeventloop.cpp b/src/corelib/kernel/qeventloop.cpp index dfdd178c35..58e2c5cd2f 100644 --- a/src/corelib/kernel/qeventloop.cpp +++ b/src/corelib/kernel/qeventloop.cpp @@ -222,11 +222,11 @@ int QEventLoop::exec(ProcessEventsFlags flags) operation and want to show its progress without allowing user input, i.e. by using the \l ExcludeUserInputEvents flag. - \bold{Notes:} + \b{Notes:} \list - \o This function does not process events continuously; it + \li This function does not process events continuously; it returns after all available events are processed. - \o Specifying the \l WaitForMoreEvents flag makes no sense + \li Specifying the \l WaitForMoreEvents flag makes no sense and will be ignored. \endlist */ diff --git a/src/corelib/kernel/qmetaobject.cpp b/src/corelib/kernel/qmetaobject.cpp index d53ba707f7..f962fb7831 100644 --- a/src/corelib/kernel/qmetaobject.cpp +++ b/src/corelib/kernel/qmetaobject.cpp @@ -86,16 +86,16 @@ QT_BEGIN_NAMESPACE The functions you are most likely to find useful are these: \list - \o className() returns the name of a class. - \o superClass() returns the superclass's meta-object. - \o method() and methodCount() provide information + \li className() returns the name of a class. + \li superClass() returns the superclass's meta-object. + \li method() and methodCount() provide information about a class's meta-methods (signals, slots and other \l{Q_INVOKABLE}{invokable} member functions). - \o enumerator() and enumeratorCount() and provide information about + \li enumerator() and enumeratorCount() and provide information about a class's enumerators. - \o propertyCount() and property() provide information about a + \li propertyCount() and property() provide information about a class's properties. - \o constructor() and constructorCount() provide information + \li constructor() and constructorCount() provide information about a class's meta-constructors. \endlist @@ -1051,18 +1051,18 @@ enum { MaximumParamCount = 11 }; // up to 10 arguments + 1 return value depending on \a type: \list - \o If \a type is Qt::DirectConnection, the member will be invoked immediately. + \li If \a type is Qt::DirectConnection, the member will be invoked immediately. - \o If \a type is Qt::QueuedConnection, + \li If \a type is Qt::QueuedConnection, a QEvent will be sent and the member is invoked as soon as the application enters the main event loop. - \o If \a type is Qt::BlockingQueuedConnection, the method will be invoked in + \li If \a type is Qt::BlockingQueuedConnection, the method will be invoked in the same way as for Qt::QueuedConnection, except that the current thread will block until the event is delivered. Using this connection type to communicate between objects in the same thread will lead to deadlocks. - \o If \a type is Qt::AutoConnection, the member is invoked + \li If \a type is Qt::AutoConnection, the member is invoked synchronously if \a obj lives in the same thread as the caller; otherwise it will invoke the member asynchronously. \endlist @@ -1456,13 +1456,13 @@ QMetaMethod::MethodType QMetaMethod::methodType() const \a connectionType: \list - \o If \a connectionType is Qt::DirectConnection, the member will be invoked immediately. + \li If \a connectionType is Qt::DirectConnection, the member will be invoked immediately. - \o If \a connectionType is Qt::QueuedConnection, + \li If \a connectionType is Qt::QueuedConnection, a QEvent will be posted and the member is invoked as soon as the application enters the main event loop. - \o If \a connectionType is Qt::AutoConnection, the member is invoked + \li If \a connectionType is Qt::AutoConnection, the member is invoked synchronously if \a object lives in the same thread as the caller; otherwise it will invoke the member asynchronously. \endlist diff --git a/src/corelib/kernel/qmimedata.cpp b/src/corelib/kernel/qmimedata.cpp index cfe985da26..3a3464e43e 100644 --- a/src/corelib/kernel/qmimedata.cpp +++ b/src/corelib/kernel/qmimedata.cpp @@ -246,12 +246,12 @@ QVariant QMimeDataPrivate::retrieveTypedData(const QString &format, QVariant::Ty functions to access the data: \table - \header \o Tester \o Getter \o Setter \o MIME Types - \row \o hasText() \o text() \o setText() \o \c text/plain - \row \o hasHtml() \o html() \o setHtml() \o \c text/html - \row \o hasUrls() \o urls() \o setUrls() \o \c text/uri-list - \row \o hasImage() \o imageData() \o setImageData() \o \c image/ * - \row \o hasColor() \o colorData() \o setColorData() \o \c application/x-color + \header \li Tester \li Getter \li Setter \li MIME Types + \row \li hasText() \li text() \li setText() \li \c text/plain + \row \li hasHtml() \li html() \li setHtml() \li \c text/html + \row \li hasUrls() \li urls() \li setUrls() \li \c text/uri-list + \row \li hasImage() \li imageData() \li setImageData() \li \c image/ * + \row \li hasColor() \li colorData() \li setColorData() \li \c application/x-color \endtable For example, if your write a widget that accepts URL drags, you @@ -263,15 +263,15 @@ QVariant QMimeDataPrivate::retrieveTypedData(const QString &format, QVariant::Ty object: \list 1 - \o Custom data can be stored directly in a QMimeData object as a + \li Custom data can be stored directly in a QMimeData object as a QByteArray using setData(). For example: \snippet doc/src/snippets/code/src_corelib_kernel_qmimedata.cpp 1 - \o We can subclass QMimeData and reimplement hasFormat(), + \li We can subclass QMimeData and reimplement hasFormat(), formats(), and retrieveData(). - \o If the drag and drop operation occurs within a single + \li If the drag and drop operation occurs within a single application, we can subclass QMimeData and add extra data in it, and use a qobject_cast() in the receiver's drop event handler. For example: diff --git a/src/corelib/kernel/qobject.cpp b/src/corelib/kernel/qobject.cpp index 8fa5dcdcff..530ddb3f13 100644 --- a/src/corelib/kernel/qobject.cpp +++ b/src/corelib/kernel/qobject.cpp @@ -1805,7 +1805,7 @@ void QObject::removeEventFilter(QObject *obj) deleted, the control must return to the event loop from which deleteLater() was called. - \bold{Note:} It is safe to call this function more than once; when the + \b{Note:} It is safe to call this function more than once; when the first deferred deletion event is delivered, any pending events for the object are removed from the event queue. @@ -2123,9 +2123,9 @@ int QObject::receivers(const char *signal) const member in the specified class. \list - \o If member.mobj is 0 then both signalIndex and methodIndex are set to -1. + \li If member.mobj is 0 then both signalIndex and methodIndex are set to -1. - \o If specified member is not a member of obj instance class (or one of + \li If specified member is not a member of obj instance class (or one of its parent classes) then both signalIndex and methodIndex are set to -1. \endlist @@ -2505,7 +2505,7 @@ QMetaObject::Connection QObject::connect(const QObject *sender, const QMetaMetho disconnect() is typically used in three ways, as the following examples demonstrate. \list 1 - \i Disconnect everything connected to an object's signals: + \li Disconnect everything connected to an object's signals: \snippet doc/src/snippets/code/src_corelib_kernel_qobject.cpp 26 @@ -2513,7 +2513,7 @@ QMetaObject::Connection QObject::connect(const QObject *sender, const QMetaMetho \snippet doc/src/snippets/code/src_corelib_kernel_qobject.cpp 27 - \i Disconnect everything connected to a specific signal: + \li Disconnect everything connected to a specific signal: \snippet doc/src/snippets/code/src_corelib_kernel_qobject.cpp 28 @@ -2521,7 +2521,7 @@ QMetaObject::Connection QObject::connect(const QObject *sender, const QMetaMetho \snippet doc/src/snippets/code/src_corelib_kernel_qobject.cpp 29 - \i Disconnect a specific receiver: + \li Disconnect a specific receiver: \snippet doc/src/snippets/code/src_corelib_kernel_qobject.cpp 30 @@ -2663,11 +2663,11 @@ bool QObject::disconnect(const QObject *sender, const char *signal, if: \list 1 - \i \a signal is not a member of sender class or one of its parent classes. + \li \a signal is not a member of sender class or one of its parent classes. - \i \a method is not a member of receiver class or one of its parent classes. + \li \a method is not a member of receiver class or one of its parent classes. - \i \a signal instance represents not a signal. + \li \a signal instance represents not a signal. \endlist @@ -3339,7 +3339,7 @@ int QObjectPrivate::signalIndex(const char *signalName) const Changing the value of a dynamic property causes a QDynamicPropertyChangeEvent to be sent to the object. - \bold{Note:} Dynamic properties starting with "_q_" are reserved for internal + \b{Note:} Dynamic properties starting with "_q_" are reserved for internal purposes. \sa property(), metaObject(), dynamicPropertyNames() @@ -4091,19 +4091,19 @@ bool QObject::disconnect(const QMetaObject::Connection &connection) disconnect() is typically used in three ways, as the following examples demonstrate. \list 1 - \i Disconnect everything connected to an object's signals: + \li Disconnect everything connected to an object's signals: \snippet doc/src/snippets/code/src_corelib_kernel_qobject.cpp 26 - \i Disconnect everything connected to a specific signal: + \li Disconnect everything connected to a specific signal: \snippet doc/src/snippets/code/src_corelib_kernel_qobject.cpp 47 - \i Disconnect a specific receiver: + \li Disconnect a specific receiver: \snippet doc/src/snippets/code/src_corelib_kernel_qobject.cpp 30 - \i Disconnect a connection from one specific signal to a specific slot: + \li Disconnect a connection from one specific signal to a specific slot: \snippet doc/src/snippets/code/src_corelib_kernel_qobject.cpp 48 diff --git a/src/corelib/kernel/qpointer.cpp b/src/corelib/kernel/qpointer.cpp index 936a933d2d..b983bef5fe 100644 --- a/src/corelib/kernel/qpointer.cpp +++ b/src/corelib/kernel/qpointer.cpp @@ -61,13 +61,13 @@ \list - \i When using QPointer on a QWidget (or a subclass of QWidget), previously + \li When using QPointer on a QWidget (or a subclass of QWidget), previously the QPointer would be cleared by the QWidget destructor. Now, the QPointer is cleared by the QObject destructor (since this is when QWeakPointers are cleared). Any QPointers tracking a widget will \b NOT be cleared before the QWidget destructor destroys the children for the widget being tracked. - \i When constructing a QSharedPointer to take ownership of an object after a + \li When constructing a QSharedPointer to take ownership of an object after a QPointer is already tracking the object. Previously, the shared pointer construction would not be affected by the QPointer, but now that QPointer is implemented using QWeakPoiner, constructing the QSharedPointer will diff --git a/src/corelib/kernel/qsharedmemory.cpp b/src/corelib/kernel/qsharedmemory.cpp index 640dfc0f94..d8578a8059 100644 --- a/src/corelib/kernel/qsharedmemory.cpp +++ b/src/corelib/kernel/qsharedmemory.cpp @@ -100,13 +100,13 @@ QSharedMemoryPrivate::makePlatformSafeKey(const QString &key, \list - \o Windows: QSharedMemory does not "own" the shared memory segment. + \li Windows: QSharedMemory does not "own" the shared memory segment. When all threads or processes that have an instance of QSharedMemory attached to a particular shared memory segment have either destroyed their instance of QSharedMemory or exited, the Windows kernel releases the shared memory segment automatically. - \o Unix: QSharedMemory "owns" the shared memory segment. When the + \li Unix: QSharedMemory "owns" the shared memory segment. When the last thread or process that has an instance of QSharedMemory attached to a particular shared memory segment detaches from the segment by destroying its instance of QSharedMemory, the Unix kernel @@ -114,7 +114,7 @@ QSharedMemoryPrivate::makePlatformSafeKey(const QString &key, process crashes without running the QSharedMemory destructor, the shared memory segment survives the crash. - \o HP-UX: Only one attach to a shared memory segment is allowed per + \li HP-UX: Only one attach to a shared memory segment is allowed per process. This means that QSharedMemory should not be used across multiple threads in the same process in HP-UX. diff --git a/src/corelib/kernel/qsocketnotifier.cpp b/src/corelib/kernel/qsocketnotifier.cpp index d7689bb7b1..0a2a66b6b2 100644 --- a/src/corelib/kernel/qsocketnotifier.cpp +++ b/src/corelib/kernel/qsocketnotifier.cpp @@ -111,9 +111,9 @@ QT_BEGIN_NAMESPACE follow these steps when you receive a notification: \list 1 - \o Disable the notifier. - \o Read data from the socket. - \o Re-enable the notifier if you are interested in more data (such as after + \li Disable the notifier. + \li Read data from the socket. + \li Re-enable the notifier if you are interested in more data (such as after having written a new command to a remote server). \endlist @@ -121,12 +121,12 @@ QT_BEGIN_NAMESPACE follow these steps when you receive a notification: \list 1 - \o Disable the notifier. - \o Write as much data as you can (before \c EWOULDBLOCK is returned). - \o Re-enable notifier if you have more data to write. + \li Disable the notifier. + \li Write as much data as you can (before \c EWOULDBLOCK is returned). + \li Re-enable notifier if you have more data to write. \endlist - \bold{Further information:} + \b{Further information:} On Windows, Qt always disables the notifier after getting a notification, and only re-enables it if more data is expected. For example, if data is read from the socket and it can be used to read more, or if reading or @@ -162,7 +162,7 @@ QT_BEGIN_NAMESPACE It is generally advisable to explicitly enable or disable the socket notifier, especially for write notifiers. - \bold{Note for Windows users:} The socket passed to QSocketNotifier + \b{Note for Windows users:} The socket passed to QSocketNotifier will become non-blocking, even if it was created as a blocking socket. \sa setEnabled(), isEnabled() diff --git a/src/corelib/kernel/qsystemsemaphore.cpp b/src/corelib/kernel/qsystemsemaphore.cpp index d0a67834dd..0558f3cb59 100644 --- a/src/corelib/kernel/qsystemsemaphore.cpp +++ b/src/corelib/kernel/qsystemsemaphore.cpp @@ -90,16 +90,16 @@ QT_BEGIN_NAMESPACE When using this class, be aware of the following platform differences: - \bold{Windows:} QSystemSemaphore does not own its underlying system + \b{Windows:} QSystemSemaphore does not own its underlying system semaphore. Windows owns it. This means that when all instances of QSystemSemaphore for a particular key have been destroyed, either by having their destructors called, or because one or more processes crash, Windows removes the underlying system semaphore. - \bold{Unix:} + \b{Unix:} \list - \o QSystemSemaphore owns the underlying system semaphore + \li QSystemSemaphore owns the underlying system semaphore in Unix systems. This means that the last process having an instance of QSystemSemaphore for a particular key must remove the underlying system semaphore in its destructor. If the last process crashes @@ -117,7 +117,7 @@ QT_BEGIN_NAMESPACE {QSystemSemaphore::} {Create}, which will force Unix to reset the resource count in the underlying system semaphore. - \o When a process using QSystemSemaphore terminates for + \li When a process using QSystemSemaphore terminates for any reason, Unix automatically reverses the effect of all acquire operations that were not released. Thus if the process acquires a resource and then exits without releasing it, Unix will release that diff --git a/src/corelib/kernel/qtranslator.cpp b/src/corelib/kernel/qtranslator.cpp index a11bcb26c9..dad3318870 100644 --- a/src/corelib/kernel/qtranslator.cpp +++ b/src/corelib/kernel/qtranslator.cpp @@ -279,9 +279,9 @@ public: up to three parameters: \list - \o The \e context - usually the class name for the tr() caller. - \o The \e {source text} - usually the argument to tr(). - \o The \e disambiguation - an optional string that helps disambiguate + \li The \e context - usually the class name for the tr() caller. + \li The \e {source text} - usually the argument to tr(). + \li The \e disambiguation - an optional string that helps disambiguate different uses of the same text in the same context. \endlist @@ -361,12 +361,12 @@ QTranslator::~QTranslator() in the following order: \list 1 - \o File name without \a suffix appended. - \o File name with text after a character in \a search_delimiters + \li File name without \a suffix appended. + \li File name with text after a character in \a search_delimiters stripped ("_." is the default for \a search_delimiters if it is an empty string) and \a suffix. - \o File name stripped without \a suffix appended. - \o File name stripped further, etc. + \li File name stripped without \a suffix appended. + \li File name stripped further, etc. \endlist For example, an application running in the fr_CA locale @@ -375,12 +375,12 @@ QTranslator::~QTranslator() readable file from this list: \list 1 - \o \c /opt/foolib/foo.fr_ca.qm - \o \c /opt/foolib/foo.fr_ca - \o \c /opt/foolib/foo.fr.qm - \o \c /opt/foolib/foo.fr - \o \c /opt/foolib/foo.qm - \o \c /opt/foolib/foo + \li \c /opt/foolib/foo.fr_ca.qm + \li \c /opt/foolib/foo.fr_ca + \li \c /opt/foolib/foo.fr.qm + \li \c /opt/foolib/foo.fr + \li \c /opt/foolib/foo.qm + \li \c /opt/foolib/foo \endlist */ @@ -599,10 +599,10 @@ static QString find_translation(const QLocale & locale, in the following order: \list 1 - \o File name without \a suffix appended. - \o File name with ui language part after a "_" character stripped and \a suffix. - \o File name with ui language part stripped without \a suffix appended. - \o File name with ui language part stripped further, etc. + \li File name without \a suffix appended. + \li File name with ui language part after a "_" character stripped and \a suffix. + \li File name with ui language part stripped without \a suffix appended. + \li File name with ui language part stripped further, etc. \endlist For example, an application running in the locale with the following @@ -612,17 +612,17 @@ static QString find_translation(const QLocale & locale, open the first existing readable file from this list: \list 1 - \o \c /opt/foolib/foo.es.qm - \o \c /opt/foolib/foo.es - \o \c /opt/foolib/foo.fr_CA.qm - \o \c /opt/foolib/foo.fr_CA - \o \c /opt/foolib/foo.de.qm - \o \c /opt/foolib/foo.de - \o \c /opt/foolib/foo.fr.qm - \o \c /opt/foolib/foo.fr - \o \c /opt/foolib/foo.qm - \o \c /opt/foolib/foo. - \o \c /opt/foolib/foo + \li \c /opt/foolib/foo.es.qm + \li \c /opt/foolib/foo.es + \li \c /opt/foolib/foo.fr_CA.qm + \li \c /opt/foolib/foo.fr_CA + \li \c /opt/foolib/foo.de.qm + \li \c /opt/foolib/foo.de + \li \c /opt/foolib/foo.fr.qm + \li \c /opt/foolib/foo.fr + \li \c /opt/foolib/foo.qm + \li \c /opt/foolib/foo. + \li \c /opt/foolib/foo \endlist On operating systems where file system is case sensitive, QTranslator also diff --git a/src/corelib/kernel/qvariant.cpp b/src/corelib/kernel/qvariant.cpp index 1c18883fde..4f3e4f8b4e 100644 --- a/src/corelib/kernel/qvariant.cpp +++ b/src/corelib/kernel/qvariant.cpp @@ -2174,7 +2174,7 @@ inline T qNumVariantToHelper(const QVariant::Private &d, If \a ok is non-null: \c{*}\a{ok} is set to true if the value could be converted to an int; otherwise \c{*}\a{ok} is set to false. - \bold{Warning:} If the value is convertible to a \l LongLong but is too + \b{Warning:} If the value is convertible to a \l LongLong but is too large to be represented in an int, the resulting arithmetic overflow will not be reflected in \a ok. A simple workaround is to use QString::toInt(). Fixing this bug has been postponed to Qt 5 in order to avoid breaking existing code. @@ -2194,7 +2194,7 @@ int QVariant::toInt(bool *ok) const If \a ok is non-null: \c{*}\a{ok} is set to true if the value could be converted to an unsigned int; otherwise \c{*}\a{ok} is set to false. - \bold{Warning:} If the value is convertible to a \l ULongLong but is too + \b{Warning:} If the value is convertible to a \l ULongLong but is too large to be represented in an unsigned int, the resulting arithmetic overflow will not be reflected in \a ok. A simple workaround is to use QString::toUInt(). Fixing this bug has been postponed to Qt 5 in order to avoid breaking existing code. @@ -2411,28 +2411,28 @@ static const quint32 qCanConvertMatrix[QVariant::LastCoreType + 1] = The following casts are done automatically: \table - \header \o Type \o Automatically Cast To - \row \o \l Bool \o \l Char, \l Double, \l Int, \l LongLong, \l String, \l UInt, \l ULongLong - \row \o \l ByteArray \o \l Double, \l Int, \l LongLong, \l String, \l UInt, \l ULongLong - \row \o \l Char \o \l Bool, \l Int, \l UInt, \l LongLong, \l ULongLong - \row \o \l Color \o \l String - \row \o \l Date \o \l DateTime, \l String - \row \o \l DateTime \o \l Date, \l String, \l Time - \row \o \l Double \o \l Bool, \l Int, \l LongLong, \l String, \l UInt, \l ULongLong - \row \o \l Font \o \l String - \row \o \l Int \o \l Bool, \l Char, \l Double, \l LongLong, \l String, \l UInt, \l ULongLong - \row \o \l KeySequence \o \l Int, \l String - \row \o \l List \o \l StringList (if the list's items can be converted to strings) - \row \o \l LongLong \o \l Bool, \l ByteArray, \l Char, \l Double, \l Int, \l String, \l UInt, \l ULongLong - \row \o \l Point \o PointF - \row \o \l Rect \o RectF - \row \o \l String \o \l Bool, \l ByteArray, \l Char, \l Color, \l Date, \l DateTime, \l Double, + \header \li Type \li Automatically Cast To + \row \li \l Bool \li \l Char, \l Double, \l Int, \l LongLong, \l String, \l UInt, \l ULongLong + \row \li \l ByteArray \li \l Double, \l Int, \l LongLong, \l String, \l UInt, \l ULongLong + \row \li \l Char \li \l Bool, \l Int, \l UInt, \l LongLong, \l ULongLong + \row \li \l Color \li \l String + \row \li \l Date \li \l DateTime, \l String + \row \li \l DateTime \li \l Date, \l String, \l Time + \row \li \l Double \li \l Bool, \l Int, \l LongLong, \l String, \l UInt, \l ULongLong + \row \li \l Font \li \l String + \row \li \l Int \li \l Bool, \l Char, \l Double, \l LongLong, \l String, \l UInt, \l ULongLong + \row \li \l KeySequence \li \l Int, \l String + \row \li \l List \li \l StringList (if the list's items can be converted to strings) + \row \li \l LongLong \li \l Bool, \l ByteArray, \l Char, \l Double, \l Int, \l String, \l UInt, \l ULongLong + \row \li \l Point \li PointF + \row \li \l Rect \li RectF + \row \li \l String \li \l Bool, \l ByteArray, \l Char, \l Color, \l Date, \l DateTime, \l Double, \l Font, \l Int, \l KeySequence, \l LongLong, \l StringList, \l Time, \l UInt, \l ULongLong - \row \o \l StringList \o \l List, \l String (if the list contains exactly one item) - \row \o \l Time \o \l String - \row \o \l UInt \o \l Bool, \l Char, \l Double, \l Int, \l LongLong, \l String, \l ULongLong - \row \o \l ULongLong \o \l Bool, \l Char, \l Double, \l Int, \l LongLong, \l String, \l UInt + \row \li \l StringList \li \l List, \l String (if the list contains exactly one item) + \row \li \l Time \li \l String + \row \li \l UInt \li \l Bool, \l Char, \l Double, \l Int, \l LongLong, \l String, \l ULongLong + \row \li \l ULongLong \li \l Bool, \l Char, \l Double, \l Int, \l LongLong, \l String, \l UInt \endtable \sa convert() diff --git a/src/corelib/kernel/qwineventnotifier.cpp b/src/corelib/kernel/qwineventnotifier.cpp index 11a2dc83f5..58ca046d9d 100644 --- a/src/corelib/kernel/qwineventnotifier.cpp +++ b/src/corelib/kernel/qwineventnotifier.cpp @@ -75,7 +75,7 @@ QT_BEGIN_NAMESPACE Finally, you can use the setHandle() function to register a new event object, and the handle() function to retrieve the event handle. - \bold{Further information:} + \b{Further information:} Although the class is called QWinEventNotifier, it can be used for certain other objects which are so-called synchronization objects, such as Processes, Threads, Waitable timers. @@ -140,7 +140,7 @@ QWinEventNotifier::~QWinEventNotifier() Register the HANDLE \a hEvent. The old HANDLE will be automatically unregistered. - \bold Note: The notifier will be disabled as a side effect and needs + \b Note: The notifier will be disabled as a side effect and needs to be re-enabled. \sa handle(), setEnabled() diff --git a/src/corelib/plugin/qlibrary.cpp b/src/corelib/plugin/qlibrary.cpp index b171577184..216e6e1e7c 100644 --- a/src/corelib/plugin/qlibrary.cpp +++ b/src/corelib/plugin/qlibrary.cpp @@ -596,12 +596,12 @@ bool QLibraryPrivate::loadPlugin() library; otherwise returns false. \table - \header \i Platform \i Valid suffixes - \row \i Windows \i \c .dll, \c .DLL - \row \i Unix/Linux \i \c .so - \row \i AIX \i \c .a - \row \i HP-UX \i \c .sl, \c .so (HP-UXi) - \row \i Mac OS X \i \c .dylib, \c .bundle, \c .so + \header \li Platform \li Valid suffixes + \row \li Windows \li \c .dll, \c .DLL + \row \li Unix/Linux \li \c .so + \row \li AIX \li \c .a + \row \li HP-UX \li \c .sl, \c .so (HP-UXi) + \row \li Mac OS X \li \c .dylib, \c .bundle, \c .so \endtable Trailing versioning numbers on Unix are ignored. diff --git a/src/corelib/plugin/qpluginloader.cpp b/src/corelib/plugin/qpluginloader.cpp index d652b251f1..f198f108da 100644 --- a/src/corelib/plugin/qpluginloader.cpp +++ b/src/corelib/plugin/qpluginloader.cpp @@ -66,9 +66,9 @@ QT_BEGIN_NAMESPACE using QLibrary: \list - \o QPluginLoader checks that a plugin is linked against the same + \li QPluginLoader checks that a plugin is linked against the same version of Qt as the application. - \o QPluginLoader provides direct access to a root component object + \li QPluginLoader provides direct access to a root component object (instance()), instead of forcing you to resolve a C function manually. \endlist diff --git a/src/corelib/plugin/quuid.cpp b/src/corelib/plugin/quuid.cpp index 3d7988a8fc..26032323e0 100644 --- a/src/corelib/plugin/quuid.cpp +++ b/src/corelib/plugin/quuid.cpp @@ -190,34 +190,34 @@ static QUuid createFromName(const QUuid &ns, const QByteArray &baseData, QCrypto \table \header - \o msb0 - \o msb1 - \o msb2 - \o Variant + \li msb0 + \li msb1 + \li msb2 + \li Variant \row - \o 0 - \o x - \o x - \o NCS (Network Computing System) + \li 0 + \li x + \li x + \li NCS (Network Computing System) \row - \o 1 - \o 0 - \o x - \o DCE (Distributed Computing Environment) + \li 1 + \li 0 + \li x + \li DCE (Distributed Computing Environment) \row - \o 1 - \o 1 - \o 0 - \o Microsoft (GUID) + \li 1 + \li 1 + \li 0 + \li Microsoft (GUID) \row - \o 1 - \o 1 - \o 1 - \o Reserved for future expansion + \li 1 + \li 1 + \li 1 + \li Reserved for future expansion \endtable @@ -234,46 +234,46 @@ static QUuid createFromName(const QUuid &ns, const QByteArray &baseData, QCrypto \table \header - \o msb0 - \o msb1 - \o msb2 - \o msb3 - \o Version + \li msb0 + \li msb1 + \li msb2 + \li msb3 + \li Version \row - \o 0 - \o 0 - \o 0 - \o 1 - \o Time + \li 0 + \li 0 + \li 0 + \li 1 + \li Time \row - \o 0 - \o 0 - \o 1 - \o 0 - \o Embedded POSIX + \li 0 + \li 0 + \li 1 + \li 0 + \li Embedded POSIX \row - \o 0 - \o 0 - \o 1 - \o 1 - \o Md5(Name) + \li 0 + \li 0 + \li 1 + \li 1 + \li Md5(Name) \row - \o 0 - \o 1 - \o 0 - \o 0 - \o Random + \li 0 + \li 1 + \li 0 + \li 0 + \li Random \row - \o 0 - \o 1 - \o 0 - \o 1 - \o Sha1 + \li 0 + \li 1 + \li 0 + \li 1 + \li Sha1 \endtable @@ -516,28 +516,28 @@ QUuid QUuid::fromRfc4122(const QByteArray &bytes) \table \header - \o Field # - \o Source + \li Field # + \li Source \row - \o 1 - \o data1 + \li 1 + \li data1 \row - \o 2 - \o data2 + \li 2 + \li data2 \row - \o 3 - \o data3 + \li 3 + \li data3 \row - \o 4 - \o data4[0] .. data4[1] + \li 4 + \li data4[0] .. data4[1] \row - \o 5 - \o data4[2] .. data4[7] + \li 5 + \li data4[2] .. data4[7] \endtable */ @@ -560,28 +560,28 @@ QString QUuid::toString() const \table \header - \o Field # - \o Source + \li Field # + \li Source \row - \o 1 - \o data1 + \li 1 + \li data1 \row - \o 2 - \o data2 + \li 2 + \li data2 \row - \o 3 - \o data3 + \li 3 + \li data3 \row - \o 4 - \o data4[0] .. data4[1] + \li 4 + \li data4[0] .. data4[1] \row - \o 5 - \o data4[2] .. data4[7] + \li 5 + \li data4[2] .. data4[7] \endtable @@ -607,24 +607,24 @@ QByteArray QUuid::toByteArray() const \table \header - \o Field # - \o Source + \li Field # + \li Source \row - \o 1 - \o data1 + \li 1 + \li data1 \row - \o 2 - \o data2 + \li 2 + \li data2 \row - \o 3 - \o data3 + \li 3 + \li data3 \row - \o 4 - \o data4[0] .. data4[7] + \li 4 + \li data4[0] .. data4[7] \endtable diff --git a/src/corelib/thread/qatomic.cpp b/src/corelib/thread/qatomic.cpp index 5443d6e1b6..2e3029f3fa 100644 --- a/src/corelib/thread/qatomic.cpp +++ b/src/corelib/thread/qatomic.cpp @@ -83,16 +83,16 @@ \list - \o Relaxed - memory ordering is unspecified, leaving the compiler + \li Relaxed - memory ordering is unspecified, leaving the compiler and processor to freely reorder memory accesses. - \o Acquire - memory access following the atomic operation (in + \li Acquire - memory access following the atomic operation (in program order) may not be re-ordered before the atomic operation. - \o Release - memory access before the atomic operation (in program + \li Release - memory access before the atomic operation (in program order) may not be re-ordered after the atomic operation. - \o Ordered - the same Acquire and Release semantics combined. + \li Ordered - the same Acquire and Release semantics combined. \endlist @@ -180,25 +180,25 @@ \list - \o Q_ATOMIC_INT_REFERENCE_COUNTING_IS_ALWAYS_NATIVE - \o Q_ATOMIC_INT_REFERENCE_COUNTING_IS_SOMETIMES_NATIVE - \o Q_ATOMIC_INT_REFERENCE_COUNTING_IS_NOT_NATIVE - \o Q_ATOMIC_INT_REFERENCE_COUNTING_IS_WAIT_FREE + \li Q_ATOMIC_INT_REFERENCE_COUNTING_IS_ALWAYS_NATIVE + \li Q_ATOMIC_INT_REFERENCE_COUNTING_IS_SOMETIMES_NATIVE + \li Q_ATOMIC_INT_REFERENCE_COUNTING_IS_NOT_NATIVE + \li Q_ATOMIC_INT_REFERENCE_COUNTING_IS_WAIT_FREE - \o Q_ATOMIC_INT_TEST_AND_SET_IS_ALWAYS_NATIVE - \o Q_ATOMIC_INT_TEST_AND_SET_IS_SOMETIMES_NATIVE - \o Q_ATOMIC_INT_TEST_AND_SET_IS_NOT_NATIVE - \o Q_ATOMIC_INT_TEST_AND_SET_IS_WAIT_FREE + \li Q_ATOMIC_INT_TEST_AND_SET_IS_ALWAYS_NATIVE + \li Q_ATOMIC_INT_TEST_AND_SET_IS_SOMETIMES_NATIVE + \li Q_ATOMIC_INT_TEST_AND_SET_IS_NOT_NATIVE + \li Q_ATOMIC_INT_TEST_AND_SET_IS_WAIT_FREE - \o Q_ATOMIC_INT_FETCH_AND_STORE_IS_ALWAYS_NATIVE - \o Q_ATOMIC_INT_FETCH_AND_STORE_IS_SOMETIMES_NATIVE - \o Q_ATOMIC_INT_FETCH_AND_STORE_IS_NOT_NATIVE - \o Q_ATOMIC_INT_FETCH_AND_STORE_IS_WAIT_FREE + \li Q_ATOMIC_INT_FETCH_AND_STORE_IS_ALWAYS_NATIVE + \li Q_ATOMIC_INT_FETCH_AND_STORE_IS_SOMETIMES_NATIVE + \li Q_ATOMIC_INT_FETCH_AND_STORE_IS_NOT_NATIVE + \li Q_ATOMIC_INT_FETCH_AND_STORE_IS_WAIT_FREE - \o Q_ATOMIC_INT_FETCH_AND_ADD_IS_ALWAYS_NATIVE - \o Q_ATOMIC_INT_FETCH_AND_ADD_IS_SOMETIMES_NATIVE - \o Q_ATOMIC_INT_FETCH_AND_ADD_IS_NOT_NATIVE - \o Q_ATOMIC_INT_FETCH_AND_ADD_IS_WAIT_FREE + \li Q_ATOMIC_INT_FETCH_AND_ADD_IS_ALWAYS_NATIVE + \li Q_ATOMIC_INT_FETCH_AND_ADD_IS_SOMETIMES_NATIVE + \li Q_ATOMIC_INT_FETCH_AND_ADD_IS_NOT_NATIVE + \li Q_ATOMIC_INT_FETCH_AND_ADD_IS_WAIT_FREE \endlist @@ -658,16 +658,16 @@ \list - \o Relaxed - memory ordering is unspecified, leaving the compiler + \li Relaxed - memory ordering is unspecified, leaving the compiler and processor to freely reorder memory accesses. - \o Acquire - memory access following the atomic operation (in + \li Acquire - memory access following the atomic operation (in program order) may not be re-ordered before the atomic operation. - \o Release - memory access before the atomic operation (in program + \li Release - memory access before the atomic operation (in program order) may not be re-ordered after the atomic operation. - \o Ordered - the same Acquire and Release semantics combined. + \li Ordered - the same Acquire and Release semantics combined. \endlist @@ -753,20 +753,20 @@ \list - \o Q_ATOMIC_POINTER_TEST_AND_SET_IS_ALWAYS_NATIVE - \o Q_ATOMIC_POINTER_TEST_AND_SET_IS_SOMETIMES_NATIVE - \o Q_ATOMIC_POINTER_TEST_AND_SET_IS_NOT_NATIVE - \o Q_ATOMIC_POINTER_TEST_AND_SET_IS_WAIT_FREE + \li Q_ATOMIC_POINTER_TEST_AND_SET_IS_ALWAYS_NATIVE + \li Q_ATOMIC_POINTER_TEST_AND_SET_IS_SOMETIMES_NATIVE + \li Q_ATOMIC_POINTER_TEST_AND_SET_IS_NOT_NATIVE + \li Q_ATOMIC_POINTER_TEST_AND_SET_IS_WAIT_FREE - \o Q_ATOMIC_POINTER_FETCH_AND_STORE_IS_ALWAYS_NATIVE - \o Q_ATOMIC_POINTER_FETCH_AND_STORE_IS_SOMETIMES_NATIVE - \o Q_ATOMIC_POINTER_FETCH_AND_STORE_IS_NOT_NATIVE - \o Q_ATOMIC_POINTER_FETCH_AND_STORE_IS_WAIT_FREE + \li Q_ATOMIC_POINTER_FETCH_AND_STORE_IS_ALWAYS_NATIVE + \li Q_ATOMIC_POINTER_FETCH_AND_STORE_IS_SOMETIMES_NATIVE + \li Q_ATOMIC_POINTER_FETCH_AND_STORE_IS_NOT_NATIVE + \li Q_ATOMIC_POINTER_FETCH_AND_STORE_IS_WAIT_FREE - \o Q_ATOMIC_POINTER_FETCH_AND_ADD_IS_ALWAYS_NATIVE - \o Q_ATOMIC_POINTER_FETCH_AND_ADD_IS_SOMETIMES_NATIVE - \o Q_ATOMIC_POINTER_FETCH_AND_ADD_IS_NOT_NATIVE - \o Q_ATOMIC_POINTER_FETCH_AND_ADD_IS_WAIT_FREE + \li Q_ATOMIC_POINTER_FETCH_AND_ADD_IS_ALWAYS_NATIVE + \li Q_ATOMIC_POINTER_FETCH_AND_ADD_IS_SOMETIMES_NATIVE + \li Q_ATOMIC_POINTER_FETCH_AND_ADD_IS_NOT_NATIVE + \li Q_ATOMIC_POINTER_FETCH_AND_ADD_IS_WAIT_FREE \endlist diff --git a/src/corelib/thread/qsemaphore.cpp b/src/corelib/thread/qsemaphore.cpp index 52f5a1d699..08952eeaa3 100644 --- a/src/corelib/thread/qsemaphore.cpp +++ b/src/corelib/thread/qsemaphore.cpp @@ -66,10 +66,10 @@ QT_BEGIN_NAMESPACE release(): \list - \o acquire(\e{n}) tries to acquire \e n resources. If there aren't + \li acquire(\e{n}) tries to acquire \e n resources. If there aren't that many resources available, the call will block until this is the case. - \o release(\e{n}) releases \e n resources. + \li release(\e{n}) releases \e n resources. \endlist There's also a tryAcquire() function that returns immediately if diff --git a/src/corelib/thread/qthread.cpp b/src/corelib/thread/qthread.cpp index a071463178..64fd8776ce 100644 --- a/src/corelib/thread/qthread.cpp +++ b/src/corelib/thread/qthread.cpp @@ -658,11 +658,11 @@ QThread::Priority QThread::priority() const Blocks the thread until either of these conditions is met: \list - \o The thread associated with this QThread object has finished + \li The thread associated with this QThread object has finished execution (i.e. when it returns from \l{run()}). This function will return true if the thread has finished. It also returns true if the thread has not been started yet. - \o \a time milliseconds has elapsed. If \a time is ULONG_MAX (the + \li \a time milliseconds has elapsed. If \a time is ULONG_MAX (the default), then the wait will never timeout (the thread must return from \l{run()}). This function will return false if the wait timed out. diff --git a/src/corelib/thread/qthreadstorage.cpp b/src/corelib/thread/qthreadstorage.cpp index 1dfa3305bc..68db8fe261 100644 --- a/src/corelib/thread/qthreadstorage.cpp +++ b/src/corelib/thread/qthreadstorage.cpp @@ -246,11 +246,11 @@ void QThreadStorageData::finish(void **p) \list - \o The QThreadStorage destructor does not delete per-thread data. + \li The QThreadStorage destructor does not delete per-thread data. QThreadStorage only deletes per-thread data when the thread exits or when setLocalData() is called multiple times. - \o QThreadStorage can be used to store data for the \c main() + \li QThreadStorage can be used to store data for the \c main() thread. QThreadStorage deletes all data set for the \c main() thread when QApplication is destroyed, regardless of whether or not the \c main() thread has actually finished. diff --git a/src/corelib/thread/qwaitcondition.qdoc b/src/corelib/thread/qwaitcondition.qdoc index 7b861f8f7a..8c93bd167d 100644 --- a/src/corelib/thread/qwaitcondition.qdoc +++ b/src/corelib/thread/qwaitcondition.qdoc @@ -129,9 +129,9 @@ calling thread will block until either of these conditions is met: \list - \o Another thread signals it using wakeOne() or wakeAll(). This + \li Another thread signals it using wakeOne() or wakeAll(). This function will return true in this case. - \o \a time milliseconds has elapsed. If \a time is \c ULONG_MAX + \li \a time milliseconds has elapsed. If \a time is \c ULONG_MAX (the default), then the wait will never timeout (the event must be signalled). This function will return false if the wait timed out. @@ -157,9 +157,9 @@ calling thread will block until either of these conditions is met: \list - \o Another thread signals it using wakeOne() or wakeAll(). This + \li Another thread signals it using wakeOne() or wakeAll(). This function will return true in this case. - \o \a time milliseconds has elapsed. If \a time is \c ULONG_MAX + \li \a time milliseconds has elapsed. If \a time is \c ULONG_MAX (the default), then the wait will never timeout (the event must be signalled). This function will return false if the wait timed out. diff --git a/src/corelib/tools/qalgorithms.qdoc b/src/corelib/tools/qalgorithms.qdoc index a16ed8b3dc..5a4a278ad0 100644 --- a/src/corelib/tools/qalgorithms.qdoc +++ b/src/corelib/tools/qalgorithms.qdoc @@ -159,14 +159,14 @@ bidirectional iterator, and supports the following operations: \table - \row \i \c{i += n} \i advances iterator \c i by \c n positions - \row \i \c{i -= n} \i moves iterator \c i back by \c n positions - \row \i \c{i + n} or \c{n + i} \i returns the iterator for the item \c + \row \li \c{i += n} \li advances iterator \c i by \c n positions + \row \li \c{i -= n} \li moves iterator \c i back by \c n positions + \row \li \c{i + n} or \c{n + i} \li returns the iterator for the item \c n positions ahead of iterator \c i - \row \i \c{i - n} \i returns the iterator for the item \c n positions behind of iterator \c i - \row \i \c{i - j} \i returns the number of items between iterators \c i and \c j - \row \i \c{i[n]} \i same as \c{*(i + n)} - \row \i \c{i < j} \i returns true if iterator \c j comes after iterator \c i + \row \li \c{i - n} \li returns the iterator for the item \c n positions behind of iterator \c i + \row \li \c{i - j} \li returns the number of items between iterators \c i and \c j + \row \li \c{i[n]} \li same as \c{*(i + n)} + \row \li \c{i < j} \li returns true if iterator \c j comes after iterator \c i \endtable QList and QVector's non-const iterator types are random access iterators. diff --git a/src/corelib/tools/qbytearray.cpp b/src/corelib/tools/qbytearray.cpp index c74c61999d..445fe5cd81 100644 --- a/src/corelib/tools/qbytearray.cpp +++ b/src/corelib/tools/qbytearray.cpp @@ -505,7 +505,7 @@ QByteArray qCompress(const uchar* data, int nbytes, int compressionLevel) from this and any earlier Qt version, back to Qt 3.1 when this feature was added. - \bold{Note:} If you want to use this function to uncompress external + \b{Note:} If you want to use this function to uncompress external data that was compressed using zlib, you first need to prepend a four byte header to the byte array containing the data. The header must contain the expected length (in bytes) of the uncompressed data, @@ -3687,12 +3687,12 @@ QByteArray &QByteArray::setNum(qulonglong n, int base) The format \a f can be any of the following: \table - \header \i Format \i Meaning - \row \i \c e \i format as [-]9.9e[+|-]999 - \row \i \c E \i format as [-]9.9E[+|-]999 - \row \i \c f \i format as [-]9.9 - \row \i \c g \i use \c e or \c f format, whichever is the most concise - \row \i \c G \i use \c E or \c f format, whichever is the most concise + \header \li Format \li Meaning + \row \li \c e \li format as [-]9.9e[+|-]999 + \row \li \c E \li format as [-]9.9E[+|-]999 + \row \li \c f \li format as [-]9.9 + \row \li \c g \li use \c e or \c f format, whichever is the most concise + \row \li \c G \li use \c E or \c f format, whichever is the most concise \endtable With 'e', 'E', and 'f', \a prec is the number of digits after the @@ -3816,12 +3816,12 @@ QByteArray QByteArray::number(qulonglong n, int base) which is \c g by default, and can be any of the following: \table - \header \i Format \i Meaning - \row \i \c e \i format as [-]9.9e[+|-]999 - \row \i \c E \i format as [-]9.9E[+|-]999 - \row \i \c f \i format as [-]9.9 - \row \i \c g \i use \c e or \c f format, whichever is the most concise - \row \i \c G \i use \c E or \c f format, whichever is the most concise + \header \li Format \li Meaning + \row \li \c e \li format as [-]9.9e[+|-]999 + \row \li \c E \li format as [-]9.9E[+|-]999 + \row \li \c f \li format as [-]9.9 + \row \li \c g \li use \c e or \c f format, whichever is the most concise + \row \li \c G \li use \c E or \c f format, whichever is the most concise \endtable With 'e', 'E', and 'f', \a prec is the number of digits after the diff --git a/src/corelib/tools/qdatetime.cpp b/src/corelib/tools/qdatetime.cpp index 70efb5db22..64ad3121d0 100644 --- a/src/corelib/tools/qdatetime.cpp +++ b/src/corelib/tools/qdatetime.cpp @@ -306,18 +306,18 @@ int QDate::year() const the following convention: \list - \i 1 = "January" - \i 2 = "February" - \i 3 = "March" - \i 4 = "April" - \i 5 = "May" - \i 6 = "June" - \i 7 = "July" - \i 8 = "August" - \i 9 = "September" - \i 10 = "October" - \i 11 = "November" - \i 12 = "December" + \li 1 = "January" + \li 2 = "February" + \li 3 = "March" + \li 4 = "April" + \li 5 = "May" + \li 6 = "June" + \li 7 = "July" + \li 8 = "August" + \li 9 = "September" + \li 10 = "October" + \li 11 = "November" + \li 12 = "December" \endlist Returns 0 if the date is invalid. @@ -521,18 +521,18 @@ int QDate::weekNumber(int *yearNumber) const The months are enumerated using the following convention: \list - \i 1 = "Jan" - \i 2 = "Feb" - \i 3 = "Mar" - \i 4 = "Apr" - \i 5 = "May" - \i 6 = "Jun" - \i 7 = "Jul" - \i 8 = "Aug" - \i 9 = "Sep" - \i 10 = "Oct" - \i 11 = "Nov" - \i 12 = "Dec" + \li 1 = "Jan" + \li 2 = "Feb" + \li 3 = "Mar" + \li 4 = "Apr" + \li 5 = "May" + \li 6 = "Jun" + \li 7 = "Jul" + \li 8 = "Aug" + \li 9 = "Sep" + \li 10 = "Oct" + \li 11 = "Nov" + \li 12 = "Dec" \endlist The month names will be localized according to the system's locale @@ -568,18 +568,18 @@ QString QDate::shortMonthName(int month, QDate::MonthNameType type) The months are enumerated using the following convention: \list - \i 1 = "January" - \i 2 = "February" - \i 3 = "March" - \i 4 = "April" - \i 5 = "May" - \i 6 = "June" - \i 7 = "July" - \i 8 = "August" - \i 9 = "September" - \i 10 = "October" - \i 11 = "November" - \i 12 = "December" + \li 1 = "January" + \li 2 = "February" + \li 3 = "March" + \li 4 = "April" + \li 5 = "May" + \li 6 = "June" + \li 7 = "July" + \li 8 = "August" + \li 9 = "September" + \li 10 = "October" + \li 11 = "November" + \li 12 = "December" \endlist The month names will be localized according to the system's locale @@ -615,13 +615,13 @@ QString QDate::longMonthName(int month, MonthNameType type) The days are enumerated using the following convention: \list - \i 1 = "Mon" - \i 2 = "Tue" - \i 3 = "Wed" - \i 4 = "Thu" - \i 5 = "Fri" - \i 6 = "Sat" - \i 7 = "Sun" + \li 1 = "Mon" + \li 2 = "Tue" + \li 3 = "Wed" + \li 4 = "Thu" + \li 5 = "Fri" + \li 6 = "Sat" + \li 7 = "Sun" \endlist The day names will be localized according to the system's locale @@ -657,13 +657,13 @@ QString QDate::shortDayName(int weekday, MonthNameType type) The days are enumerated using the following convention: \list - \i 1 = "Monday" - \i 2 = "Tuesday" - \i 3 = "Wednesday" - \i 4 = "Thursday" - \i 5 = "Friday" - \i 6 = "Saturday" - \i 7 = "Sunday" + \li 1 = "Monday" + \li 2 = "Tuesday" + \li 3 = "Wednesday" + \li 4 = "Thursday" + \li 5 = "Friday" + \li 6 = "Saturday" + \li 7 = "Sunday" \endlist The day names will be localized according to the system's locale @@ -781,25 +781,25 @@ QString QDate::toString(Qt::DateFormat f) const These expressions may be used: \table - \header \i Expression \i Output - \row \i d \i the day as number without a leading zero (1 to 31) - \row \i dd \i the day as number with a leading zero (01 to 31) - \row \i ddd - \i the abbreviated localized day name (e.g. 'Mon' to 'Sun'). + \header \li Expression \li Output + \row \li d \li the day as number without a leading zero (1 to 31) + \row \li dd \li the day as number with a leading zero (01 to 31) + \row \li ddd + \li the abbreviated localized day name (e.g. 'Mon' to 'Sun'). Uses QDate::shortDayName(). - \row \i dddd - \i the long localized day name (e.g. 'Monday' to 'Sunday'). + \row \li dddd + \li the long localized day name (e.g. 'Monday' to 'Sunday'). Uses QDate::longDayName(). - \row \i M \i the month as number without a leading zero (1 to 12) - \row \i MM \i the month as number with a leading zero (01 to 12) - \row \i MMM - \i the abbreviated localized month name (e.g. 'Jan' to 'Dec'). + \row \li M \li the month as number without a leading zero (1 to 12) + \row \li MM \li the month as number with a leading zero (01 to 12) + \row \li MMM + \li the abbreviated localized month name (e.g. 'Jan' to 'Dec'). Uses QDate::shortMonthName(). - \row \i MMMM - \i the long localized month name (e.g. 'January' to 'December'). + \row \li MMMM + \li the long localized month name (e.g. 'January' to 'December'). Uses QDate::longMonthName(). - \row \i yy \i the year as two digit number (00 to 99) - \row \i yyyy \i the year as four digit number. If the year is negative, + \row \li yy \li the year as two digit number (00 to 99) + \row \li yyyy \li the year as four digit number. If the year is negative, a minus sign is prepended in addition. \endtable @@ -812,10 +812,10 @@ QString QDate::toString(Qt::DateFormat f) const 1969): \table - \header \o Format \o Result - \row \o dd.MM.yyyy \o 20.07.1969 - \row \o ddd MMMM d yy \o Sun July 20 69 - \row \o 'The day is' dddd \o The day is Sunday + \header \li Format \li Result + \row \li dd.MM.yyyy \li 20.07.1969 + \row \li ddd MMMM d yy \li Sun July 20 69 + \row \li 'The day is' dddd \li The day is Sunday \endtable If the datetime is invalid, an empty string will be returned. @@ -1191,25 +1191,25 @@ QDate QDate::fromString(const QString& s, Qt::DateFormat f) These expressions may be used for the format: \table - \header \i Expression \i Output - \row \i d \i The day as a number without a leading zero (1 to 31) - \row \i dd \i The day as a number with a leading zero (01 to 31) - \row \i ddd - \i The abbreviated localized day name (e.g. 'Mon' to 'Sun'). + \header \li Expression \li Output + \row \li d \li The day as a number without a leading zero (1 to 31) + \row \li dd \li The day as a number with a leading zero (01 to 31) + \row \li ddd + \li The abbreviated localized day name (e.g. 'Mon' to 'Sun'). Uses QDate::shortDayName(). - \row \i dddd - \i The long localized day name (e.g. 'Monday' to 'Sunday'). + \row \li dddd + \li The long localized day name (e.g. 'Monday' to 'Sunday'). Uses QDate::longDayName(). - \row \i M \i The month as a number without a leading zero (1 to 12) - \row \i MM \i The month as a number with a leading zero (01 to 12) - \row \i MMM - \i The abbreviated localized month name (e.g. 'Jan' to 'Dec'). + \row \li M \li The month as a number without a leading zero (1 to 12) + \row \li MM \li The month as a number with a leading zero (01 to 12) + \row \li MMM + \li The abbreviated localized month name (e.g. 'Jan' to 'Dec'). Uses QDate::shortMonthName(). - \row \i MMMM - \i The long localized month name (e.g. 'January' to 'December'). + \row \li MMMM + \li The long localized month name (e.g. 'January' to 'December'). Uses QDate::longMonthName(). - \row \i yy \i The year as two digit number (00 to 99) - \row \i yyyy \i The year as four digit number. If the year is negative, + \row \li yy \li The year as two digit number (00 to 99) + \row \li yyyy \li The year as four digit number. If the year is negative, a minus sign is prepended in addition. \endtable @@ -1233,10 +1233,10 @@ QDate QDate::fromString(const QString& s, Qt::DateFormat f) defaults are used: \table - \header \i Field \i Default value - \row \i Year \i 1900 - \row \i Month \i 1 - \row \i Day \i 1 + \header \li Field \li Default value + \row \li Year \li 1900 + \row \li Month \li 1 + \row \li Day \li 1 \endtable The following examples demonstrate the default values: @@ -1543,26 +1543,26 @@ QString QTime::toString(Qt::DateFormat format) const These expressions may be used: \table - \header \i Expression \i Output - \row \i h - \i the hour without a leading zero (0 to 23 or 1 to 12 if AM/PM display) - \row \i hh - \i the hour with a leading zero (00 to 23 or 01 to 12 if AM/PM display) - \row \i H - \i the hour without a leading zero (0 to 23, even with AM/PM display) - \row \i HH - \i the hour with a leading zero (00 to 23, even with AM/PM display) - \row \i m \i the minute without a leading zero (0 to 59) - \row \i mm \i the minute with a leading zero (00 to 59) - \row \i s \i the second without a leading zero (0 to 59) - \row \i ss \i the second with a leading zero (00 to 59) - \row \i z \i the milliseconds without leading zeroes (0 to 999) - \row \i zzz \i the milliseconds with leading zeroes (000 to 999) - \row \i AP or A - \i use AM/PM display. \e AP will be replaced by either "AM" or "PM". - \row \i ap or a - \i use am/pm display. \e ap will be replaced by either "am" or "pm". - \row \i t \i the timezone (for example "CEST") + \header \li Expression \li Output + \row \li h + \li the hour without a leading zero (0 to 23 or 1 to 12 if AM/PM display) + \row \li hh + \li the hour with a leading zero (00 to 23 or 01 to 12 if AM/PM display) + \row \li H + \li the hour without a leading zero (0 to 23, even with AM/PM display) + \row \li HH + \li the hour with a leading zero (00 to 23, even with AM/PM display) + \row \li m \li the minute without a leading zero (0 to 59) + \row \li mm \li the minute with a leading zero (00 to 59) + \row \li s \li the second without a leading zero (0 to 59) + \row \li ss \li the second with a leading zero (00 to 59) + \row \li z \li the milliseconds without leading zeroes (0 to 999) + \row \li zzz \li the milliseconds with leading zeroes (000 to 999) + \row \li AP or A + \li use AM/PM display. \e AP will be replaced by either "AM" or "PM". + \row \li ap or a + \li use am/pm display. \e ap will be replaced by either "am" or "pm". + \row \li t \li the timezone (for example "CEST") \endtable All other input characters will be ignored. Any sequence of characters that @@ -1573,10 +1573,10 @@ QString QTime::toString(Qt::DateFormat format) const Example format strings (assuming that the QTime is 14:13:09.042) \table - \header \i Format \i Result - \row \i hh:mm:ss.zzz \i 14:13:09.042 - \row \i h:m:s ap \i 2:13:9 pm - \row \i H:m:s a \i 14:13:9 pm + \header \li Format \li Result + \row \li hh:mm:ss.zzz \li 14:13:09.042 + \row \li h:m:s ap \li 2:13:9 pm + \row \li H:m:s a \li 14:13:9 pm \endtable If the datetime is invalid, an empty string will be returned. @@ -1824,21 +1824,21 @@ QTime QTime::fromString(const QString& s, Qt::DateFormat f) These expressions may be used for the format: \table - \header \i Expression \i Output - \row \i h - \i the hour without a leading zero (0 to 23 or 1 to 12 if AM/PM display) - \row \i hh - \i the hour with a leading zero (00 to 23 or 01 to 12 if AM/PM display) - \row \i m \i the minute without a leading zero (0 to 59) - \row \i mm \i the minute with a leading zero (00 to 59) - \row \i s \i the second without a leading zero (0 to 59) - \row \i ss \i the second with a leading zero (00 to 59) - \row \i z \i the milliseconds without leading zeroes (0 to 999) - \row \i zzz \i the milliseconds with leading zeroes (000 to 999) - \row \i AP - \i interpret as an AM/PM time. \e AP must be either "AM" or "PM". - \row \i ap - \i Interpret as an AM/PM time. \e ap must be either "am" or "pm". + \header \li Expression \li Output + \row \li h + \li the hour without a leading zero (0 to 23 or 1 to 12 if AM/PM display) + \row \li hh + \li the hour with a leading zero (00 to 23 or 01 to 12 if AM/PM display) + \row \li m \li the minute without a leading zero (0 to 59) + \row \li mm \li the minute with a leading zero (00 to 59) + \row \li s \li the second without a leading zero (0 to 59) + \row \li ss \li the second with a leading zero (00 to 59) + \row \li z \li the milliseconds without leading zeroes (0 to 999) + \row \li zzz \li the milliseconds with leading zeroes (000 to 999) + \row \li AP + \li interpret as an AM/PM time. \e AP must be either "AM" or "PM". + \row \li ap + \li Interpret as an AM/PM time. \e ap must be either "am" or "pm". \endtable All other input characters will be treated as text. Any sequence @@ -2515,45 +2515,45 @@ QString QDateTime::toString(Qt::DateFormat f) const These expressions may be used for the date: \table - \header \i Expression \i Output - \row \i d \i the day as number without a leading zero (1 to 31) - \row \i dd \i the day as number with a leading zero (01 to 31) - \row \i ddd - \i the abbreviated localized day name (e.g. 'Mon' to 'Sun'). + \header \li Expression \li Output + \row \li d \li the day as number without a leading zero (1 to 31) + \row \li dd \li the day as number with a leading zero (01 to 31) + \row \li ddd + \li the abbreviated localized day name (e.g. 'Mon' to 'Sun'). Uses QDate::shortDayName(). - \row \i dddd - \i the long localized day name (e.g. 'Monday' to 'Qt::Sunday'). + \row \li dddd + \li the long localized day name (e.g. 'Monday' to 'Qt::Sunday'). Uses QDate::longDayName(). - \row \i M \i the month as number without a leading zero (1-12) - \row \i MM \i the month as number with a leading zero (01-12) - \row \i MMM - \i the abbreviated localized month name (e.g. 'Jan' to 'Dec'). + \row \li M \li the month as number without a leading zero (1-12) + \row \li MM \li the month as number with a leading zero (01-12) + \row \li MMM + \li the abbreviated localized month name (e.g. 'Jan' to 'Dec'). Uses QDate::shortMonthName(). - \row \i MMMM - \i the long localized month name (e.g. 'January' to 'December'). + \row \li MMMM + \li the long localized month name (e.g. 'January' to 'December'). Uses QDate::longMonthName(). - \row \i yy \i the year as two digit number (00-99) - \row \i yyyy \i the year as four digit number + \row \li yy \li the year as two digit number (00-99) + \row \li yyyy \li the year as four digit number \endtable These expressions may be used for the time: \table - \header \i Expression \i Output - \row \i h - \i the hour without a leading zero (0 to 23 or 1 to 12 if AM/PM display) - \row \i hh - \i the hour with a leading zero (00 to 23 or 01 to 12 if AM/PM display) - \row \i m \i the minute without a leading zero (0 to 59) - \row \i mm \i the minute with a leading zero (00 to 59) - \row \i s \i the second without a leading zero (0 to 59) - \row \i ss \i the second with a leading zero (00 to 59) - \row \i z \i the milliseconds without leading zeroes (0 to 999) - \row \i zzz \i the milliseconds with leading zeroes (000 to 999) - \row \i AP - \i use AM/PM display. \e AP will be replaced by either "AM" or "PM". - \row \i ap - \i use am/pm display. \e ap will be replaced by either "am" or "pm". + \header \li Expression \li Output + \row \li h + \li the hour without a leading zero (0 to 23 or 1 to 12 if AM/PM display) + \row \li hh + \li the hour with a leading zero (00 to 23 or 01 to 12 if AM/PM display) + \row \li m \li the minute without a leading zero (0 to 59) + \row \li mm \li the minute with a leading zero (00 to 59) + \row \li s \li the second without a leading zero (0 to 59) + \row \li ss \li the second with a leading zero (00 to 59) + \row \li z \li the milliseconds without leading zeroes (0 to 999) + \row \li zzz \li the milliseconds with leading zeroes (000 to 999) + \row \li AP + \li use AM/PM display. \e AP will be replaced by either "AM" or "PM". + \row \li ap + \li use am/pm display. \e ap will be replaced by either "am" or "pm". \endtable All other input characters will be ignored. Any sequence of characters that @@ -2565,11 +2565,11 @@ QString QDateTime::toString(Qt::DateFormat f) const 14:13:09): \table - \header \i Format \i Result - \row \i dd.MM.yyyy \i 21.05.2001 - \row \i ddd MMMM d yy \i Tue May 21 01 - \row \i hh:mm:ss.zzz \i 14:13:09.042 - \row \i h:m:s ap \i 2:13:9 pm + \header \li Format \li Result + \row \li dd.MM.yyyy \li 21.05.2001 + \row \li ddd MMMM d yy \li Tue May 21 01 + \row \li hh:mm:ss.zzz \li 14:13:09.042 + \row \li h:m:s ap \li 2:13:9 pm \endtable If the datetime is invalid, an empty string will be returned. @@ -3367,25 +3367,25 @@ QDateTime QDateTime::fromString(const QString& s, Qt::DateFormat f) These expressions may be used for the date part of the format string: \table - \header \i Expression \i Output - \row \i d \i the day as number without a leading zero (1 to 31) - \row \i dd \i the day as number with a leading zero (01 to 31) - \row \i ddd - \i the abbreviated localized day name (e.g. 'Mon' to 'Sun'). + \header \li Expression \li Output + \row \li d \li the day as number without a leading zero (1 to 31) + \row \li dd \li the day as number with a leading zero (01 to 31) + \row \li ddd + \li the abbreviated localized day name (e.g. 'Mon' to 'Sun'). Uses QDate::shortDayName(). - \row \i dddd - \i the long localized day name (e.g. 'Monday' to 'Sunday'). + \row \li dddd + \li the long localized day name (e.g. 'Monday' to 'Sunday'). Uses QDate::longDayName(). - \row \i M \i the month as number without a leading zero (1-12) - \row \i MM \i the month as number with a leading zero (01-12) - \row \i MMM - \i the abbreviated localized month name (e.g. 'Jan' to 'Dec'). + \row \li M \li the month as number without a leading zero (1-12) + \row \li MM \li the month as number with a leading zero (01-12) + \row \li MMM + \li the abbreviated localized month name (e.g. 'Jan' to 'Dec'). Uses QDate::shortMonthName(). - \row \i MMMM - \i the long localized month name (e.g. 'January' to 'December'). + \row \li MMMM + \li the long localized month name (e.g. 'January' to 'December'). Uses QDate::longMonthName(). - \row \i yy \i the year as two digit number (00-99) - \row \i yyyy \i the year as four digit number + \row \li yy \li the year as two digit number (00-99) + \row \li yyyy \li the year as four digit number \endtable \note Unlike the other version of this function, day and month names must @@ -3395,25 +3395,25 @@ QDateTime QDateTime::fromString(const QString& s, Qt::DateFormat f) These expressions may be used for the time part of the format string: \table - \header \i Expression \i Output - \row \i h - \i the hour without a leading zero (0 to 23 or 1 to 12 if AM/PM display) - \row \i hh - \i the hour with a leading zero (00 to 23 or 01 to 12 if AM/PM display) - \row \i H - \i the hour without a leading zero (0 to 23, even with AM/PM display) - \row \i HH - \i the hour with a leading zero (00 to 23, even with AM/PM display) - \row \i m \i the minute without a leading zero (0 to 59) - \row \i mm \i the minute with a leading zero (00 to 59) - \row \i s \i the second without a leading zero (0 to 59) - \row \i ss \i the second with a leading zero (00 to 59) - \row \i z \i the milliseconds without leading zeroes (0 to 999) - \row \i zzz \i the milliseconds with leading zeroes (000 to 999) - \row \i AP or A - \i interpret as an AM/PM time. \e AP must be either "AM" or "PM". - \row \i ap or a - \i Interpret as an AM/PM time. \e ap must be either "am" or "pm". + \header \li Expression \li Output + \row \li h + \li the hour without a leading zero (0 to 23 or 1 to 12 if AM/PM display) + \row \li hh + \li the hour with a leading zero (00 to 23 or 01 to 12 if AM/PM display) + \row \li H + \li the hour without a leading zero (0 to 23, even with AM/PM display) + \row \li HH + \li the hour with a leading zero (00 to 23, even with AM/PM display) + \row \li m \li the minute without a leading zero (0 to 59) + \row \li mm \li the minute with a leading zero (00 to 59) + \row \li s \li the second without a leading zero (0 to 59) + \row \li ss \li the second with a leading zero (00 to 59) + \row \li z \li the milliseconds without leading zeroes (0 to 999) + \row \li zzz \li the milliseconds with leading zeroes (000 to 999) + \row \li AP or A + \li interpret as an AM/PM time. \e AP must be either "AM" or "PM". + \row \li ap or a + \li Interpret as an AM/PM time. \e ap must be either "am" or "pm". \endtable All other input characters will be treated as text. Any sequence @@ -3437,13 +3437,13 @@ QDateTime QDateTime::fromString(const QString& s, Qt::DateFormat f) defaults are used: \table - \header \i Field \i Default value - \row \i Year \i 1900 - \row \i Month \i 1 (January) - \row \i Day \i 1 - \row \i Hour \i 0 - \row \i Minute \i 0 - \row \i Second \i 0 + \header \li Field \li Default value + \row \li Year \li 1900 + \row \li Month \li 1 (January) + \row \li Day \li 1 + \row \li Hour \li 0 + \row \li Minute \li 0 + \row \li Second \li 0 \endtable For example: diff --git a/src/corelib/tools/qhash.cpp b/src/corelib/tools/qhash.cpp index 36497c59ff..d5703e8b2a 100644 --- a/src/corelib/tools/qhash.cpp +++ b/src/corelib/tools/qhash.cpp @@ -547,11 +547,11 @@ void QHashData::checkSanity() differences are: \list - \i QHash provides faster lookups than QMap. (See \l{Algorithmic + \li QHash provides faster lookups than QMap. (See \l{Algorithmic Complexity} for details.) - \i When iterating over a QMap, the items are always sorted by + \li When iterating over a QMap, the items are always sorted by key. With QHash, the items are arbitrarily ordered. - \i The key type of a QMap must provide operator<(). The key + \li The key type of a QMap must provide operator<(). The key type of a QHash must provide operator==() and a global hash function called qHash() (see the related non-member functions). diff --git a/src/corelib/tools/qline.cpp b/src/corelib/tools/qline.cpp index 78f1c44263..39ec0ed97c 100644 --- a/src/corelib/tools/qline.cpp +++ b/src/corelib/tools/qline.cpp @@ -61,8 +61,8 @@ QT_BEGIN_NAMESPACE \table \row - \o \inlineimage qline-point.png - \o \inlineimage qline-coordinates.png + \li \inlineimage qline-point.png + \li \inlineimage qline-coordinates.png \endtable The positions of the line's start and end points can be retrieved @@ -322,8 +322,8 @@ QDataStream &operator>>(QDataStream &stream, QLine &line) \table \row - \o \inlineimage qline-point.png - \o \inlineimage qline-coordinates.png + \li \inlineimage qline-point.png + \li \inlineimage qline-coordinates.png \endtable The positions of the line's start and end points can be retrieved @@ -360,11 +360,11 @@ QDataStream &operator>>(QDataStream &stream, QLine &line) \table \row - \o \inlineimage qlinef-unbounded.png - \o \inlineimage qlinef-bounded.png + \li \inlineimage qlinef-unbounded.png + \li \inlineimage qlinef-bounded.png \row - \o QLineF::UnboundedIntersection - \o QLineF::BoundedIntersection + \li QLineF::UnboundedIntersection + \li QLineF::BoundedIntersection \endtable \value NoIntersection Indicates that the lines do not intersect; @@ -795,8 +795,8 @@ qreal QLineF::angleTo(const QLineF &l) const \table \row - \o \inlineimage qlinef-angle-identicaldirection.png - \o \inlineimage qlinef-angle-oppositedirection.png + \li \inlineimage qlinef-angle-identicaldirection.png + \li \inlineimage qlinef-angle-oppositedirection.png \endtable When the lines are parallel, this function returns 0 if they have diff --git a/src/corelib/tools/qlinkedlist.cpp b/src/corelib/tools/qlinkedlist.cpp index e2efaa3639..b31ef3e5e9 100644 --- a/src/corelib/tools/qlinkedlist.cpp +++ b/src/corelib/tools/qlinkedlist.cpp @@ -65,16 +65,16 @@ const QLinkedListData QLinkedListData::shared_null = { functionality. Here's an overview: \list - \i For most purposes, QList is the right class to use. Its + \li For most purposes, QList is the right class to use. Its index-based API is more convenient than QLinkedList's iterator-based API, and it is usually faster than QVector because of the way it stores its items in memory (see \l{Algorithmic Complexity} for details). It also expands to less code in your executable. - \i If you need a real linked list, with guarantees of \l{constant + \li If you need a real linked list, with guarantees of \l{constant time} insertions in the middle of the list and iterators to items rather than indexes, use QLinkedList. - \i If you want the items to occupy adjacent memory positions, + \li If you want the items to occupy adjacent memory positions, use QVector. \endlist diff --git a/src/corelib/tools/qlist.cpp b/src/corelib/tools/qlist.cpp index b8c938e216..263045a25d 100644 --- a/src/corelib/tools/qlist.cpp +++ b/src/corelib/tools/qlist.cpp @@ -340,15 +340,15 @@ void **QListData::erase(void **xi) functionality. Here's an overview: \list - \i For most purposes, QList is the right class to use. Its + \li For most purposes, QList is the right class to use. Its index-based API is more convenient than QLinkedList's iterator-based API, and it is usually faster than QVector because of the way it stores its items in memory. It also expands to less code in your executable. - \i If you need a real linked list, with guarantees of \l{constant + \li If you need a real linked list, with guarantees of \l{constant time} insertions in the middle of the list and iterators to items rather than indexes, use QLinkedList. - \i If you want the items to occupy adjacent memory positions, + \li If you want the items to occupy adjacent memory positions, use QVector. \endlist diff --git a/src/corelib/tools/qlocale.cpp b/src/corelib/tools/qlocale.cpp index 31f776dc2e..086ca7bd38 100644 --- a/src/corelib/tools/qlocale.cpp +++ b/src/corelib/tools/qlocale.cpp @@ -621,10 +621,10 @@ static quint16 localePrivateIndex(const QLocalePrivate *p) "language[_script][_country][.codeset][@modifier]" or "C", where: \list - \i language is a lowercase, two-letter, ISO 639 language code, - \i script is a titlecase, four-letter, ISO 15924 script code, - \i country is an uppercase, two- or three-letter, ISO 3166 country code (also "419" as defined by United Nations), - \i and codeset and modifier are ignored. + \li language is a lowercase, two-letter, ISO 639 language code, + \li script is a titlecase, four-letter, ISO 15924 script code, + \li country is an uppercase, two- or three-letter, ISO 3166 country code (also "419" as defined by United Nations), + \li and codeset and modifier are ignored. \endlist The separator can be either underscore or a minus sign. @@ -671,11 +671,11 @@ QLocale::QLocale() country. \list - \i If the language/country pair is found in the database, it is used. - \i If the language is found but the country is not, or if the country + \li If the language/country pair is found in the database, it is used. + \li If the language is found but the country is not, or if the country is \c AnyCountry, the language is used with the most appropriate available country (for example, Germany for German), - \i If neither the language nor the country are found, QLocale + \li If neither the language nor the country are found, QLocale defaults to the default locale (see setDefault()). \endlist @@ -707,14 +707,14 @@ QLocale::QLocale(Language language, Country country) \a country. \list - \i If the language/script/country is found in the database, it is used. - \i If both \a script is AnyScript and \a country is AnyCountry, the + \li If the language/script/country is found in the database, it is used. + \li If both \a script is AnyScript and \a country is AnyCountry, the language is used with the most appropriate available script and country (for example, Germany for German), - \i If either \a script is AnyScript or \a country is AnyCountry, the + \li If either \a script is AnyScript or \a country is AnyCountry, the language is used with the first locale that matches the given \a script and \a country. - \i If neither the language nor the country are found, QLocale + \li If neither the language nor the country are found, QLocale defaults to the default locale (see setDefault()). \endlist diff --git a/src/corelib/tools/qlocale.qdoc b/src/corelib/tools/qlocale.qdoc index 3a386c17d6..8e90d7d94e 100644 --- a/src/corelib/tools/qlocale.qdoc +++ b/src/corelib/tools/qlocale.qdoc @@ -51,12 +51,12 @@ following effects: \list - \i If a QLocale object is constructed with the default constructor, + \li If a QLocale object is constructed with the default constructor, it will use the default locale's settings. - \i QString::toInt(), QString::toDouble(), etc., interpret the + \li QString::toInt(), QString::toDouble(), etc., interpret the string according to the default locale. If this fails, it falls back on the "C" locale. - \i QString::arg() uses the default locale to format a number when + \li QString::arg() uses the default locale to format a number when its position specifier in the format string contains an 'L', e.g. "%L1". \endlist @@ -69,11 +69,11 @@ of three things can happen: \list - \i If the language/country pair is found in the database, it is used. - \i If the language is found but the country is not, or if the country + \li If the language/country pair is found in the database, it is used. + \li If the language is found but the country is not, or if the country is \c AnyCountry, the language is used with the most appropriate available country (for example, Germany for German), - \i If neither the language nor the country are found, QLocale + \li If neither the language nor the country are found, QLocale defaults to the default locale (see setDefault()). \endlist diff --git a/src/corelib/tools/qmap.cpp b/src/corelib/tools/qmap.cpp index 37d705b3e0..103d074941 100644 --- a/src/corelib/tools/qmap.cpp +++ b/src/corelib/tools/qmap.cpp @@ -232,11 +232,11 @@ void QMapData::dump() differences are: \list - \i QHash provides faster lookups than QMap. (See \l{Algorithmic + \li QHash provides faster lookups than QMap. (See \l{Algorithmic Complexity} for details.) - \i When iterating over a QHash, the items are arbitrarily ordered. + \li When iterating over a QHash, the items are arbitrarily ordered. With QMap, the items are always sorted by key. - \i The key type of a QHash must provide operator==() and a global + \li The key type of a QHash must provide operator==() and a global qHash(Key) function. The key type of a QMap must provide operator<() specifying a total order. \endlist diff --git a/src/corelib/tools/qrect.cpp b/src/corelib/tools/qrect.cpp index 7ff883a99a..aeab97803d 100644 --- a/src/corelib/tools/qrect.cpp +++ b/src/corelib/tools/qrect.cpp @@ -99,11 +99,11 @@ QT_BEGIN_NAMESPACE \table \row - \o \inlineimage qrect-intersect.png - \o \inlineimage qrect-unite.png + \li \inlineimage qrect-intersect.png + \li \inlineimage qrect-unite.png \row - \o intersected() - \o united() + \li intersected() + \li united() \endtable The isEmpty() function returns true if left() > right() or top() > @@ -139,17 +139,17 @@ QT_BEGIN_NAMESPACE \table \row - \o \inlineimage qrect-diagram-zero.png - \o \inlineimage qrect-diagram-one.png + \li \inlineimage qrect-diagram-zero.png + \li \inlineimage qrect-diagram-one.png \row - \o Logical representation - \o One pixel wide pen + \li Logical representation + \li One pixel wide pen \row - \o \inlineimage qrect-diagram-two.png - \o \inlineimage qrect-diagram-three.png + \li \inlineimage qrect-diagram-two.png + \li \inlineimage qrect-diagram-three.png \row - \o Two pixel wide pen - \o Three pixel wide pen + \li Two pixel wide pen + \li Three pixel wide pen \endtable \section1 Coordinates @@ -1278,11 +1278,11 @@ QDebug operator<<(QDebug dbg, const QRect &r) { \table \row - \o \inlineimage qrect-intersect.png - \o \inlineimage qrect-unite.png + \li \inlineimage qrect-intersect.png + \li \inlineimage qrect-unite.png \row - \o intersected() - \o united() + \li intersected() + \li united() \endtable The isEmpty() function returns true if the rectangle's width or @@ -1318,17 +1318,17 @@ QDebug operator<<(QDebug dbg, const QRect &r) { \table \row - \o \inlineimage qrect-diagram-zero.png - \o \inlineimage qrectf-diagram-one.png + \li \inlineimage qrect-diagram-zero.png + \li \inlineimage qrectf-diagram-one.png \row - \o Logical representation - \o One pixel wide pen + \li Logical representation + \li One pixel wide pen \row - \o \inlineimage qrectf-diagram-two.png - \o \inlineimage qrectf-diagram-three.png + \li \inlineimage qrectf-diagram-two.png + \li \inlineimage qrectf-diagram-three.png \row - \o Two pixel wide pen - \o Three pixel wide pen + \li Two pixel wide pen + \li Three pixel wide pen \endtable \section1 Coordinates diff --git a/src/corelib/tools/qregexp.cpp b/src/corelib/tools/qregexp.cpp index e55144ec4c..29b3424315 100644 --- a/src/corelib/tools/qregexp.cpp +++ b/src/corelib/tools/qregexp.cpp @@ -90,21 +90,21 @@ int qFindString(const QChar *haystack, int haystackLen, int from, substrings in a text. This is useful in many contexts, e.g., \table - \row \i Validation - \i A regexp can test whether a substring meets some criteria, + \row \li Validation + \li A regexp can test whether a substring meets some criteria, e.g. is an integer or contains no whitespace. - \row \i Searching - \i A regexp provides more powerful pattern matching than + \row \li Searching + \li A regexp provides more powerful pattern matching than simple substring matching, e.g., match one of the words \e{mail}, \e{letter} or \e{correspondence}, but none of the words \e{email}, \e{mailman}, \e{mailer}, \e{letterbox}, etc. - \row \i Search and Replace - \i A regexp can replace all occurrences of a substring with a + \row \li Search and Replace + \li A regexp can replace all occurrences of a substring with a different substring, e.g., replace all occurrences of \e{&} with \e{\&} except where the \e{&} is already followed by an \e{amp;}. - \row \i String Splitting - \i A regexp can be used to identify where a string should be + \row \li String Splitting + \li A regexp can be used to identify where a string should be split apart, e.g. splitting tab-delimited strings. \endtable @@ -127,18 +127,18 @@ int qFindString(const QChar *haystack, int haystackLen, int from, \section1 Introduction Regexps are built up from expressions, quantifiers, and - assertions. The simplest expression is a character, e.g. \bold{x} - or \bold{5}. An expression can also be a set of characters - enclosed in square brackets. \bold{[ABCD]} will match an \bold{A} - or a \bold{B} or a \bold{C} or a \bold{D}. We can write this same - expression as \bold{[A-D]}, and an experession to match any + assertions. The simplest expression is a character, e.g. \b{x} + or \b{5}. An expression can also be a set of characters + enclosed in square brackets. \b{[ABCD]} will match an \b{A} + or a \b{B} or a \b{C} or a \b{D}. We can write this same + expression as \b{[A-D]}, and an experession to match any captital letter in the English alphabet is written as - \bold{[A-Z]}. + \b{[A-Z]}. A quantifier specifies the number of occurrences of an expression - that must be matched. \bold{x{1,1}} means match one and only one - \bold{x}. \bold{x{1,5}} means match a sequence of \bold{x} - characters that contains at least one \bold{x} but no more than + that must be matched. \b{x{1,1}} means match one and only one + \b{x}. \b{x{1,5}} means match a sequence of \b{x} + characters that contains at least one \b{x} but no more than five. Note that in general regexps cannot be used to check for balanced @@ -156,35 +156,35 @@ int qFindString(const QChar *haystack, int haystackLen, int from, Suppose we want a regexp to match integers in the range 0 to 99. At least one digit is required, so we start with the expression - \bold{[0-9]{1,1}}, which matches a single digit exactly once. This + \b{[0-9]{1,1}}, which matches a single digit exactly once. This regexp matches integers in the range 0 to 9. To match integers up to 99, increase the maximum number of occurrences to 2, so the - regexp becomes \bold{[0-9]{1,2}}. This regexp satisfies the + regexp becomes \b{[0-9]{1,2}}. This regexp satisfies the original requirement to match integers from 0 to 99, but it will also match integers that occur in the middle of strings. If we want the matched integer to be the whole string, we must use the - anchor assertions, \bold{^} (caret) and \bold{$} (dollar). When - \bold{^} is the first character in a regexp, it means the regexp - must match from the beginning of the string. When \bold{$} is the + anchor assertions, \b{^} (caret) and \b{$} (dollar). When + \b{^} is the first character in a regexp, it means the regexp + must match from the beginning of the string. When \b{$} is the last character of the regexp, it means the regexp must match to - the end of the string. The regexp becomes \bold{^[0-9]{1,2}$}. - Note that assertions, e.g. \bold{^} and \bold{$}, do not match + the end of the string. The regexp becomes \b{^[0-9]{1,2}$}. + Note that assertions, e.g. \b{^} and \b{$}, do not match characters but locations in the string. If you have seen regexps described elsewhere, they may have looked different from the ones shown here. This is because some sets of characters and some quantifiers are so common that they have been - given special symbols to represent them. \bold{[0-9]} can be - replaced with the symbol \bold{\\d}. The quantifier to match - exactly one occurrence, \bold{{1,1}}, can be replaced with the - expression itself, i.e. \bold{x{1,1}} is the same as \bold{x}. So - our 0 to 99 matcher could be written as \bold{^\\d{1,2}$}. It can - also be written \bold{^\\d\\d{0,1}$}, i.e. \e{From the start of + given special symbols to represent them. \b{[0-9]} can be + replaced with the symbol \b{\\d}. The quantifier to match + exactly one occurrence, \b{{1,1}}, can be replaced with the + expression itself, i.e. \b{x{1,1}} is the same as \b{x}. So + our 0 to 99 matcher could be written as \b{^\\d{1,2}$}. It can + also be written \b{^\\d\\d{0,1}$}, i.e. \e{From the start of the string, match a digit, followed immediately by 0 or 1 digits}. - In practice, it would be written as \bold{^\\d\\d?$}. The \bold{?} - is shorthand for the quantifier \bold{{0,1}}, i.e. 0 or 1 - occurrences. \bold{?} makes an expression optional. The regexp - \bold{^\\d\\d?$} means \e{From the beginning of the string, match + In practice, it would be written as \b{^\\d\\d?$}. The \b{?} + is shorthand for the quantifier \b{{0,1}}, i.e. 0 or 1 + occurrences. \b{?} makes an expression optional. The regexp + \b{^\\d\\d?$} means \e{From the beginning of the string, match one digit, followed immediately by 0 or 1 more digit, followed immediately by end of string}. @@ -192,45 +192,45 @@ int qFindString(const QChar *haystack, int haystackLen, int from, 'letter' \e or 'correspondence' but does not match words that contain these words, e.g., 'email', 'mailman', 'mailer', and 'letterbox', start with a regexp that matches 'mail'. Expressed - fully, the regexp is \bold{m{1,1}a{1,1}i{1,1}l{1,1}}, but because + fully, the regexp is \b{m{1,1}a{1,1}i{1,1}l{1,1}}, but because a character expression is automatically quantified by - \bold{{1,1}}, we can simplify the regexp to \bold{mail}, i.e., an + \b{{1,1}}, we can simplify the regexp to \b{mail}, i.e., an 'm' followed by an 'a' followed by an 'i' followed by an 'l'. Now - we can use the vertical bar \bold{|}, which means \bold{or}, to + we can use the vertical bar \b{|}, which means \b{or}, to include the other two words, so our regexp for matching any of the - three words becomes \bold{mail|letter|correspondence}. Match - 'mail' \bold{or} 'letter' \bold{or} 'correspondence'. While this + three words becomes \b{mail|letter|correspondence}. Match + 'mail' \b{or} 'letter' \b{or} 'correspondence'. While this regexp will match one of the three words we want to match, it will also match words we don't want to match, e.g., 'email'. To prevent the regexp from matching unwanted words, we must tell it to begin and end the match at word boundaries. First we enclose - our regexp in parentheses, \bold{(mail|letter|correspondence)}. + our regexp in parentheses, \b{(mail|letter|correspondence)}. Parentheses group expressions together, and they identify a part of the regexp that we wish to \l{capturing text}{capture}. Enclosing the expression in parentheses allows us to use it as a component in more complex regexps. It also allows us to examine which of the three words was actually matched. To force the match to begin and end on word boundaries, we enclose the regexp in - \bold{\\b} \e{word boundary} assertions: - \bold{\\b(mail|letter|correspondence)\\b}. Now the regexp means: + \b{\\b} \e{word boundary} assertions: + \b{\\b(mail|letter|correspondence)\\b}. Now the regexp means: \e{Match a word boundary, followed by the regexp in parentheses, - followed by a word boundary}. The \bold{\\b} assertion matches a + followed by a word boundary}. The \b{\\b} assertion matches a \e position in the regexp, not a \e character. A word boundary is any non-word character, e.g., a space, newline, or the beginning or ending of a string. If we want to replace ampersand characters with the HTML entity - \bold{\&}, the regexp to match is simply \bold{\&}. But this + \b{\&}, the regexp to match is simply \b{\&}. But this regexp will also match ampersands that have already been converted to HTML entities. We want to replace only ampersands that are not - already followed by \bold{amp;}. For this, we need the negative - lookahead assertion, \bold{(?!}__\bold{)}. The regexp can then be - written as \bold{\&(?!amp;)}, i.e. \e{Match an ampersand that is} - \bold{not} \e{followed by} \bold{amp;}. + already followed by \b{amp;}. For this, we need the negative + lookahead assertion, \b{(?!}__\b{)}. The regexp can then be + written as \b{\&(?!amp;)}, i.e. \e{Match an ampersand that is} + \b{not} \e{followed by} \b{amp;}. If we want to count all the occurrences of 'Eric' and 'Eirik' in a - string, two valid solutions are \bold{\\b(Eric|Eirik)\\b} and - \bold{\\bEi?ri[ck]\\b}. The word boundary assertion '\\b' is + string, two valid solutions are \b{\\b(Eric|Eirik)\\b} and + \b{\\bEi?ri[ck]\\b}. The word boundary assertion '\\b' is required to avoid matching words that contain either name, e.g. 'Ericsson'. Note that the second regexp matches more spellings than we want: 'Eric', 'Erik', 'Eiric' and 'Eirik'. @@ -242,52 +242,52 @@ int qFindString(const QChar *haystack, int haystackLen, int from, \section1 Characters and Abbreviations for Sets of Characters \table - \header \i Element \i Meaning - \row \i \bold{c} - \i A character represents itself unless it has a special - regexp meaning. e.g. \bold{c} matches the character \e c. - \row \i \bold{\\c} - \i A character that follows a backslash matches the character + \header \li Element \li Meaning + \row \li \b{c} + \li A character represents itself unless it has a special + regexp meaning. e.g. \b{c} matches the character \e c. + \row \li \b{\\c} + \li A character that follows a backslash matches the character itself, except as specified below. e.g., To match a literal - caret at the beginning of a string, write \bold{\\^}. - \row \i \bold{\\a} - \i Matches the ASCII bell (BEL, 0x07). - \row \i \bold{\\f} - \i Matches the ASCII form feed (FF, 0x0C). - \row \i \bold{\\n} - \i Matches the ASCII line feed (LF, 0x0A, Unix newline). - \row \i \bold{\\r} - \i Matches the ASCII carriage return (CR, 0x0D). - \row \i \bold{\\t} - \i Matches the ASCII horizontal tab (HT, 0x09). - \row \i \bold{\\v} - \i Matches the ASCII vertical tab (VT, 0x0B). - \row \i \bold{\\x\e{hhhh}} - \i Matches the Unicode character corresponding to the + caret at the beginning of a string, write \b{\\^}. + \row \li \b{\\a} + \li Matches the ASCII bell (BEL, 0x07). + \row \li \b{\\f} + \li Matches the ASCII form feed (FF, 0x0C). + \row \li \b{\\n} + \li Matches the ASCII line feed (LF, 0x0A, Unix newline). + \row \li \b{\\r} + \li Matches the ASCII carriage return (CR, 0x0D). + \row \li \b{\\t} + \li Matches the ASCII horizontal tab (HT, 0x09). + \row \li \b{\\v} + \li Matches the ASCII vertical tab (VT, 0x0B). + \row \li \b{\\x\e{hhhh}} + \li Matches the Unicode character corresponding to the hexadecimal number \e{hhhh} (between 0x0000 and 0xFFFF). - \row \i \bold{\\0\e{ooo}} (i.e., \\zero \e{ooo}) - \i matches the ASCII/Latin1 character for the octal number + \row \li \b{\\0\e{ooo}} (i.e., \\zero \e{ooo}) + \li matches the ASCII/Latin1 character for the octal number \e{ooo} (between 0 and 0377). - \row \i \bold{. (dot)} - \i Matches any character (including newline). - \row \i \bold{\\d} - \i Matches a digit (QChar::isDigit()). - \row \i \bold{\\D} - \i Matches a non-digit. - \row \i \bold{\\s} - \i Matches a whitespace character (QChar::isSpace()). - \row \i \bold{\\S} - \i Matches a non-whitespace character. - \row \i \bold{\\w} - \i Matches a word character (QChar::isLetterOrNumber(), QChar::isMark(), or '_'). - \row \i \bold{\\W} - \i Matches a non-word character. - \row \i \bold{\\\e{n}} - \i The \e{n}-th \l backreference, e.g. \\1, \\2, etc. + \row \li \b{. (dot)} + \li Matches any character (including newline). + \row \li \b{\\d} + \li Matches a digit (QChar::isDigit()). + \row \li \b{\\D} + \li Matches a non-digit. + \row \li \b{\\s} + \li Matches a whitespace character (QChar::isSpace()). + \row \li \b{\\S} + \li Matches a non-whitespace character. + \row \li \b{\\w} + \li Matches a word character (QChar::isLetterOrNumber(), QChar::isMark(), or '_'). + \row \li \b{\\W} + \li Matches a non-word character. + \row \li \b{\\\e{n}} + \li The \e{n}-th \l backreference, e.g. \\1, \\2, etc. \endtable - \bold{Note:} The C++ compiler transforms backslashes in strings. - To include a \bold{\\} in a regexp, enter it twice, i.e. \c{\\}. + \b{Note:} The C++ compiler transforms backslashes in strings. + To include a \b{\\} in a regexp, enter it twice, i.e. \c{\\}. To match the backslash character itself, enter it four times, i.e. \c{\\\\}. @@ -301,24 +301,24 @@ int qFindString(const QChar *haystack, int haystackLen, int from, characters do not have special meanings in square brackets. \table - \row \i \bold{^} + \row \li \b{^} - \i The caret negates the character set if it occurs as the + \li The caret negates the character set if it occurs as the first character (i.e. immediately after the opening square - bracket). \bold{[abc]} matches 'a' or 'b' or 'c', but - \bold{[^abc]} matches anything \e but 'a' or 'b' or 'c'. + bracket). \b{[abc]} matches 'a' or 'b' or 'c', but + \b{[^abc]} matches anything \e but 'a' or 'b' or 'c'. - \row \i \bold{-} + \row \li \b{-} - \i The dash indicates a range of characters. \bold{[W-Z]} + \li The dash indicates a range of characters. \b{[W-Z]} matches 'W' or 'X' or 'Y' or 'Z'. \endtable Using the predefined character set abbreviations is more portable than using character ranges across platforms and languages. For - example, \bold{[0-9]} matches a digit in Western alphabets but - \bold{\\d} matches a digit in \e any alphabet. + example, \b{[0-9]} matches a digit in Western alphabets but + \b{\\d} matches a digit in \e any alphabet. Note: In other regexp documentation, sets of characters are often called "character classes". @@ -327,64 +327,64 @@ int qFindString(const QChar *haystack, int haystackLen, int from, \section1 Quantifiers By default, an expression is automatically quantified by - \bold{{1,1}}, i.e. it should occur exactly once. In the following - list, \bold{\e {E}} stands for expression. An expression is a + \b{{1,1}}, i.e. it should occur exactly once. In the following + list, \b{\e {E}} stands for expression. An expression is a character, or an abbreviation for a set of characters, or a set of characters in square brackets, or an expression in parentheses. \table - \row \i \bold{\e {E}?} + \row \li \b{\e {E}?} - \i Matches zero or one occurrences of \e E. This quantifier + \li Matches zero or one occurrences of \e E. This quantifier means \e{The previous expression is optional}, because it - will match whether or not the expression is found. \bold{\e - {E}?} is the same as \bold{\e {E}{0,1}}. e.g., \bold{dents?} + will match whether or not the expression is found. \b{\e + {E}?} is the same as \b{\e {E}{0,1}}. e.g., \b{dents?} matches 'dent' or 'dents'. - \row \i \bold{\e {E}+} + \row \li \b{\e {E}+} - \i Matches one or more occurrences of \e E. \bold{\e {E}+} is - the same as \bold{\e {E}{1,}}. e.g., \bold{0+} matches '0', + \li Matches one or more occurrences of \e E. \b{\e {E}+} is + the same as \b{\e {E}{1,}}. e.g., \b{0+} matches '0', '00', '000', etc. - \row \i \bold{\e {E}*} + \row \li \b{\e {E}*} - \i Matches zero or more occurrences of \e E. It is the same - as \bold{\e {E}{0,}}. The \bold{*} quantifier is often used - in error where \bold{+} should be used. For example, if - \bold{\\s*$} is used in an expression to match strings that + \li Matches zero or more occurrences of \e E. It is the same + as \b{\e {E}{0,}}. The \b{*} quantifier is often used + in error where \b{+} should be used. For example, if + \b{\\s*$} is used in an expression to match strings that end in whitespace, it will match every string because - \bold{\\s*$} means \e{Match zero or more whitespaces followed + \b{\\s*$} means \e{Match zero or more whitespaces followed by end of string}. The correct regexp to match strings that have at least one trailing whitespace character is - \bold{\\s+$}. + \b{\\s+$}. - \row \i \bold{\e {E}{n}} + \row \li \b{\e {E}{n}} - \i Matches exactly \e n occurrences of \e E. \bold{\e {E}{n}} + \li Matches exactly \e n occurrences of \e E. \b{\e {E}{n}} is the same as repeating \e E \e n times. For example, - \bold{x{5}} is the same as \bold{xxxxx}. It is also the same - as \bold{\e {E}{n,n}}, e.g. \bold{x{5,5}}. + \b{x{5}} is the same as \b{xxxxx}. It is also the same + as \b{\e {E}{n,n}}, e.g. \b{x{5,5}}. - \row \i \bold{\e {E}{n,}} - \i Matches at least \e n occurrences of \e E. + \row \li \b{\e {E}{n,}} + \li Matches at least \e n occurrences of \e E. - \row \i \bold{\e {E}{,m}} - \i Matches at most \e m occurrences of \e E. \bold{\e {E}{,m}} - is the same as \bold{\e {E}{0,m}}. + \row \li \b{\e {E}{,m}} + \li Matches at most \e m occurrences of \e E. \b{\e {E}{,m}} + is the same as \b{\e {E}{0,m}}. - \row \i \bold{\e {E}{n,m}} - \i Matches at least \e n and at most \e m occurrences of \e E. + \row \li \b{\e {E}{n,m}} + \li Matches at least \e n and at most \e m occurrences of \e E. \endtable To apply a quantifier to more than just the preceding character, use parentheses to group characters together in an expression. For - example, \bold{tag+} matches a 't' followed by an 'a' followed by - at least one 'g', whereas \bold{(tag)+} matches at least one + example, \b{tag+} matches a 't' followed by an 'a' followed by + at least one 'g', whereas \b{(tag)+} matches at least one occurrence of 'tag'. Note: Quantifiers are normally "greedy". They always match as much - text as they can. For example, \bold{0+} matches the first zero it + text as they can. For example, \b{0+} matches the first zero it finds and all the consecutive zeros after the first zero. Applied to '20005', it matches'2\underline{000}5'. Quantifiers can be made non-greedy, see setMinimal(). @@ -395,10 +395,10 @@ int qFindString(const QChar *haystack, int haystackLen, int from, Parentheses allow us to group elements together so that we can quantify and capture them. For example if we have the expression - \bold{mail|letter|correspondence} that matches a string we know + \b{mail|letter|correspondence} that matches a string we know that \e one of the words matched but not which one. Using parentheses allows us to "capture" whatever is matched within - their bounds, so if we used \bold{(mail|letter|correspondence)} + their bounds, so if we used \b{(mail|letter|correspondence)} and matched this regexp against the string "I sent you some email" we can use the cap() or capturedTexts() functions to extract the matched characters, in this case 'mail'. @@ -406,14 +406,14 @@ int qFindString(const QChar *haystack, int haystackLen, int from, We can use captured text within the regexp itself. To refer to the captured text we use \e backreferences which are indexed from 1, the same as for cap(). For example we could search for duplicate - words in a string using \bold{\\b(\\w+)\\W+\\1\\b} which means match a + words in a string using \b{\\b(\\w+)\\W+\\1\\b} which means match a word boundary followed by one or more word characters followed by one or more non-word characters followed by the same text as the first parenthesized expression followed by a word boundary. If we want to use parentheses purely for grouping and not for capturing we can use the non-capturing syntax, e.g. - \bold{(?:green|blue)}. Non-capturing parentheses begin '(?:' and + \b{(?:green|blue)}. Non-capturing parentheses begin '(?:' and end ')'. In this example we match either 'green' or 'blue' but we do not capture the match so we only know whether or not we matched but not which color we actually found. Using non-capturing @@ -424,9 +424,9 @@ int qFindString(const QChar *haystack, int haystackLen, int from, \target greedy quantifiers - For historical reasons, quantifiers (e.g. \bold{*}) that apply to + For historical reasons, quantifiers (e.g. \b{*}) that apply to capturing parentheses are more "greedy" than other quantifiers. - For example, \bold{a*(a*)} will match "aaa" with cap(1) == "aaa". + For example, \b{a*(a*)} will match "aaa" with cap(1) == "aaa". This behavior is different from what other regexp engines do (notably, Perl). To obtain a more intuitive capturing behavior, specify QRegExp::RegExp2 to the QRegExp constructor or call @@ -444,54 +444,54 @@ int qFindString(const QChar *haystack, int haystackLen, int from, Assertions make some statement about the text at the point where they occur in the regexp but they do not match any characters. In - the following list \bold{\e {E}} stands for any expression. + the following list \b{\e {E}} stands for any expression. \table - \row \i \bold{^} - \i The caret signifies the beginning of the string. If you + \row \li \b{^} + \li The caret signifies the beginning of the string. If you wish to match a literal \c{^} you must escape it by - writing \c{\\^}. For example, \bold{^#include} will only + writing \c{\\^}. For example, \b{^#include} will only match strings which \e begin with the characters '#include'. (When the caret is the first character of a character set it has a special meaning, see \link #sets-of-characters Sets of Characters \endlink.) - \row \i \bold{$} - \i The dollar signifies the end of the string. For example - \bold{\\d\\s*$} will match strings which end with a digit + \row \li \b{$} + \li The dollar signifies the end of the string. For example + \b{\\d\\s*$} will match strings which end with a digit optionally followed by whitespace. If you wish to match a literal \c{$} you must escape it by writing \c{\\$}. - \row \i \bold{\\b} - \i A word boundary. For example the regexp - \bold{\\bOK\\b} means match immediately after a word + \row \li \b{\\b} + \li A word boundary. For example the regexp + \b{\\bOK\\b} means match immediately after a word boundary (e.g. start of string or whitespace) the letter 'O' then the letter 'K' immediately before another word boundary (e.g. end of string or whitespace). But note that the assertion does not actually match any whitespace so if we - write \bold{(\\bOK\\b)} and we have a match it will only + write \b{(\\bOK\\b)} and we have a match it will only contain 'OK' even if the string is "It's \underline{OK} now". - \row \i \bold{\\B} - \i A non-word boundary. This assertion is true wherever - \bold{\\b} is false. For example if we searched for - \bold{\\Bon\\B} in "Left on" the match would fail (space + \row \li \b{\\B} + \li A non-word boundary. This assertion is true wherever + \b{\\b} is false. For example if we searched for + \b{\\Bon\\B} in "Left on" the match would fail (space and end of string aren't non-word boundaries), but it would match in "t\underline{on}ne". - \row \i \bold{(?=\e E)} - \i Positive lookahead. This assertion is true if the + \row \li \b{(?=\e E)} + \li Positive lookahead. This assertion is true if the expression matches at this point in the regexp. For example, - \bold{const(?=\\s+char)} matches 'const' whenever it is + \b{const(?=\\s+char)} matches 'const' whenever it is followed by 'char', as in 'static \underline{const} char *'. - (Compare with \bold{const\\s+char}, which matches 'static + (Compare with \b{const\\s+char}, which matches 'static \underline{const char} *'.) - \row \i \bold{(?!\e E)} - \i Negative lookahead. This assertion is true if the + \row \li \b{(?!\e E)} + \li Negative lookahead. This assertion is true if the expression does not match at this point in the regexp. For - example, \bold{const(?!\\s+char)} matches 'const' \e except + example, \b{const(?!\\s+char)} matches 'const' \e except when it is followed by 'char'. \endtable @@ -505,17 +505,17 @@ int qFindString(const QChar *haystack, int haystackLen, int from, simpler than full regexps and has only four features: \table - \row \i \bold{c} - \i Any character represents itself apart from those mentioned - below. Thus \bold{c} matches the character \e c. - \row \i \bold{?} - \i Matches any single character. It is the same as - \bold{.} in full regexps. - \row \i \bold{*} - \i Matches zero or more of any characters. It is the - same as \bold{.*} in full regexps. - \row \i \bold{[...]} - \i Sets of characters can be represented in square brackets, + \row \li \b{c} + \li Any character represents itself apart from those mentioned + below. Thus \b{c} matches the character \e c. + \row \li \b{?} + \li Matches any single character. It is the same as + \b{.} in full regexps. + \row \li \b{*} + \li Matches zero or more of any characters. It is the + same as \b{.*} in full regexps. + \row \li \b{[...]} + \li Sets of characters can be represented in square brackets, similar to full regexps. Within the character class, like outside, backslash has no special meaning. \endtable @@ -525,7 +525,7 @@ int qFindString(const QChar *haystack, int haystackLen, int from, wildcard. For example if we are in wildcard mode and have strings which - contain filenames we could identify HTML files with \bold{*.html}. + contain filenames we could identify HTML files with \b{*.html}. This will match zero or more characters followed by a dot followed by 'h', 't', 'm' and 'l'. @@ -553,7 +553,7 @@ int qFindString(const QChar *haystack, int haystackLen, int from, (but see the \l{greedy quantifiers}{note above}). Non-greedy matching cannot be applied to individual quantifiers, but can be applied to all the quantifiers in the pattern. For example, to - match the Perl regexp \bold{ro+?m} requires: + match the Perl regexp \b{ro+?m} requires: \snippet doc/src/snippets/code/src_corelib_tools_qregexp.cpp 2 @@ -562,7 +562,7 @@ int qFindString(const QChar *haystack, int haystackLen, int from, Perl's \c{/g} option can be emulated using a \l{#cap_in_a_loop}{loop}. - In QRegExp \bold{.} matches any character, therefore all QRegExp + In QRegExp \b{.} matches any character, therefore all QRegExp regexps have the equivalent of Perl's \c{/s} option. QRegExp does not have an equivalent to Perl's \c{/m} option, but this can be emulated in various ways for example by splitting the input @@ -598,7 +598,7 @@ int qFindString(const QChar *haystack, int haystackLen, int from, to Perl's split and join functions. Note: because C++ transforms \\'s they must be written \e twice in - code, e.g. \bold{\\b} must be written \bold{\\\\b}. + code, e.g. \b{\\b} must be written \b{\\\\b}. \target code-examples \section1 Code Examples @@ -670,10 +670,10 @@ int qFindString(const QChar *haystack, int haystackLen, int from, Wildcard matching can be convenient because of its simplicity, but any wildcard regexp can be defined using full regexps, e.g. - \bold{.*\\.html$}. Notice that we can't match both \c .html and \c - .htm files with a wildcard unless we use \bold{*.htm*} which will + \b{.*\\.html$}. Notice that we can't match both \c .html and \c + .htm files with a wildcard unless we use \b{*.htm*} which will also match 'test.html.bak'. A full regexp gives us the precision - we need, \bold{.*\\.html?$}. + we need, \b{.*\\.html?$}. QRegExp can match case insensitively using setCaseSensitivity(), and can use non-greedy matching, see setMinimal(). By @@ -3898,7 +3898,7 @@ static void invalidateEngine(QRegExpPrivate *priv) \enum QRegExp::CaretMode The CaretMode enum defines the different meanings of the caret - (\bold{^}) in a regular expression. The possible values are: + (\b{^}) in a regular expression. The possible values are: \value CaretAtZero The caret corresponds to index 0 in the searched string. @@ -4065,11 +4065,11 @@ bool QRegExp::isEmpty() const Returns true if the regular expression is valid; otherwise returns false. An invalid regular expression never matches. - The pattern \bold{[a-z} is an example of an invalid pattern, since + The pattern \b{[a-z} is an example of an invalid pattern, since it lacks a closing square bracket. Note that the validity of a regexp may also depend on the setting - of the wildcard flag, for example \bold{*.html} is a valid + of the wildcard flag, for example \b{*.html} is a valid wildcard regexp but an invalid full regexp. \sa errorString() @@ -4124,7 +4124,7 @@ Qt::CaseSensitivity QRegExp::caseSensitivity() const /*! Sets case sensitive matching to \a cs. - If \a cs is Qt::CaseSensitive, \bold{\\.txt$} matches + If \a cs is Qt::CaseSensitive, \b{\\.txt$} matches \c{readme.txt} but not \c{README.TXT}. \sa setPatternSyntax(), setPattern(), setMinimal() @@ -4153,7 +4153,7 @@ QRegExp::PatternSyntax QRegExp::patternSyntax() const QRegExp::RegExp. Setting \a syntax to QRegExp::Wildcard enables simple shell-like - \l{wildcard matching}. For example, \bold{r*.txt} matches the + \l{wildcard matching}. For example, \b{r*.txt} matches the string \c{readme.txt} in wildcard mode, but does not match \c{readme}. @@ -4188,13 +4188,13 @@ bool QRegExp::isMinimal() const For example, suppose we have the input string "We must be <b>bold</b>, very <b>bold</b>!" and the pattern - \bold{<b>.*</b>}. With the default greedy (maximal) matching, + \b{<b>.*</b>}. With the default greedy (maximal) matching, the match is "We must be \underline{<b>bold</b>, very <b>bold</b>}!". But with minimal (non-greedy) matching, the first match is: "We must be \underline{<b>bold</b>}, very <b>bold</b>!" and the second match is "We must be <b>bold</b>, very \underline{<b>bold</b>}!". In practice we might use the pattern - \bold{<b>[^<]*\</b>} instead, although this will still fail for + \b{<b>[^<]*\</b>} instead, although this will still fail for nested tags. \sa setCaseSensitivity() @@ -4215,7 +4215,7 @@ void QRegExp::setMinimal(bool minimal) in the start of string and end of string anchors, except that it sets matchedLength() differently. - For example, if the regular expression is \bold{blue}, then + For example, if the regular expression is \b{blue}, then exactMatch() returns true only for input \c blue. For inputs \c bluebell, \c blutak and \c lightblue, exactMatch() returns false and matchedLength() will return 4, 3 and 0 respectively. @@ -4247,7 +4247,7 @@ bool QRegExp::exactMatch(const QString &str) const Returns the position of the first match, or -1 if there was no match. - The \a caretMode parameter can be used to instruct whether \bold{^} + The \a caretMode parameter can be used to instruct whether \b{^} should match at index 0 or at \a offset. You might prefer to use QString::indexOf(), QString::contains(), @@ -4286,7 +4286,7 @@ int QRegExp::indexIn(const QString &str, int offset, CaretMode caretMode) const Returns the position of the first match, or -1 if there was no match. - The \a caretMode parameter can be used to instruct whether \bold{^} + The \a caretMode parameter can be used to instruct whether \b{^} should match at index 0 or at \a offset. Although const, this function sets matchedLength(), @@ -4371,7 +4371,7 @@ int QRegExp::captureCount() const Some regexps can match an indeterminate number of times. For example if the input string is "Offsets: 12 14 99 231 7" and the - regexp, \c{rx}, is \bold{(\\d+)+}, we would hope to get a list of + regexp, \c{rx}, is \b{(\\d+)+}, we would hope to get a list of all the numbers matched. However, after calling \c{rx.indexIn(str)}, capturedTexts() will return the list ("12", "12"), i.e. the entire match was "12" and the first subexpression diff --git a/src/corelib/tools/qscopedpointer.cpp b/src/corelib/tools/qscopedpointer.cpp index b6bf525fb9..5ecca89229 100644 --- a/src/corelib/tools/qscopedpointer.cpp +++ b/src/corelib/tools/qscopedpointer.cpp @@ -89,10 +89,10 @@ QT_BEGIN_NAMESPACE The following custom cleanup handlers exist: \list - \i QScopedPointerDeleter - the default, deletes the pointer using \c delete - \i QScopedPointerArrayDeleter - deletes the pointer using \c{delete []}. Use + \li QScopedPointerDeleter - the default, deletes the pointer using \c delete + \li QScopedPointerArrayDeleter - deletes the pointer using \c{delete []}. Use this handler for pointers that were allocated with \c{new []}. - \i QScopedPointerPodDeleter - deletes the pointer using \c{free()}. Use this + \li QScopedPointerPodDeleter - deletes the pointer using \c{free()}. Use this handler for pointers that were allocated with \c{malloc()}. \endlist diff --git a/src/corelib/tools/qshareddata.cpp b/src/corelib/tools/qshareddata.cpp index 6250745400..ffc8ac601d 100644 --- a/src/corelib/tools/qshareddata.cpp +++ b/src/corelib/tools/qshareddata.cpp @@ -86,10 +86,10 @@ QT_BEGIN_NAMESPACE \list - \o Define the class \c Employee to have a single data member of + \li Define the class \c Employee to have a single data member of type \c {QSharedDataPointer<EmployeeData>}. - \o Define the \c EmployeeData class derived from \l QSharedData to + \li Define the \c EmployeeData class derived from \l QSharedData to contain all the data members you would normally have put in the \c Employee class. diff --git a/src/corelib/tools/qsize.cpp b/src/corelib/tools/qsize.cpp index 4c94f899e7..b276d2d2e0 100644 --- a/src/corelib/tools/qsize.cpp +++ b/src/corelib/tools/qsize.cpp @@ -186,10 +186,10 @@ void QSize::transpose() height, according to the specified \a mode: \list - \i If \a mode is Qt::IgnoreAspectRatio, the size is set to (\a width, \a height). - \i If \a mode is Qt::KeepAspectRatio, the current size is scaled to a rectangle + \li If \a mode is Qt::IgnoreAspectRatio, the size is set to (\a width, \a height). + \li If \a mode is Qt::KeepAspectRatio, the current size is scaled to a rectangle as large as possible inside (\a width, \a height), preserving the aspect ratio. - \i If \a mode is Qt::KeepAspectRatioByExpanding, the current size is scaled to a rectangle + \li If \a mode is Qt::KeepAspectRatioByExpanding, the current size is scaled to a rectangle as small as possible outside (\a width, \a height), preserving the aspect ratio. \endlist @@ -614,10 +614,10 @@ void QSizeF::transpose() height, according to the specified \a mode. \list - \i If \a mode is Qt::IgnoreAspectRatio, the size is set to (\a width, \a height). - \i If \a mode is Qt::KeepAspectRatio, the current size is scaled to a rectangle + \li If \a mode is Qt::IgnoreAspectRatio, the size is set to (\a width, \a height). + \li If \a mode is Qt::KeepAspectRatio, the current size is scaled to a rectangle as large as possible inside (\a width, \a height), preserving the aspect ratio. - \i If \a mode is Qt::KeepAspectRatioByExpanding, the current size is scaled to a rectangle + \li If \a mode is Qt::KeepAspectRatioByExpanding, the current size is scaled to a rectangle as small as possible outside (\a width, \a height), preserving the aspect ratio. \endlist diff --git a/src/corelib/tools/qstring.cpp b/src/corelib/tools/qstring.cpp index bf50159de2..45ccfb8aea 100644 --- a/src/corelib/tools/qstring.cpp +++ b/src/corelib/tools/qstring.cpp @@ -606,12 +606,12 @@ const QString::Null QString::null = { }; toLatin1(), toUtf8(), and toLocal8Bit(). \list - \o toAscii() returns a Latin-1 (ISO 8859-1) encoded 8-bit string. - \o toLatin1() returns a Latin-1 (ISO 8859-1) encoded 8-bit string. - \o toUtf8() returns a UTF-8 encoded 8-bit string. UTF-8 is a + \li toAscii() returns a Latin-1 (ISO 8859-1) encoded 8-bit string. + \li toLatin1() returns a Latin-1 (ISO 8859-1) encoded 8-bit string. + \li toUtf8() returns a UTF-8 encoded 8-bit string. UTF-8 is a superset of US-ASCII (ANSI X3.4-1986) that supports the entire Unicode character set through multibyte sequences. - \o toLocal8Bit() returns an 8-bit string using the system's local + \li toLocal8Bit() returns an 8-bit string using the system's local encoding. \endlist @@ -629,9 +629,9 @@ const QString::Null QString::null = { }; conversions by defining the following two preprocessor symbols: \list - \o \c QT_NO_CAST_FROM_ASCII disables automatic conversions from + \li \c QT_NO_CAST_FROM_ASCII disables automatic conversions from C string literals and pointers to Unicode. - \o \c QT_NO_CAST_TO_ASCII disables automatic conversion from QString + \li \c QT_NO_CAST_TO_ASCII disables automatic conversion from QString to C strings. \endlist @@ -655,10 +655,10 @@ const QString::Null QString::null = { }; \table 100 % \header - \o Note for C Programmers + \li Note for C Programmers \row - \o + \li Due to C++'s type system and the fact that QString is \l{implicitly shared}, QStrings may be treated like \c{int}s or other basic types. For example: @@ -697,12 +697,12 @@ const QString::Null QString::null = { }; following: \table - \header \o Format \o Meaning - \row \o \c e \o format as [-]9.9e[+|-]999 - \row \o \c E \o format as [-]9.9E[+|-]999 - \row \o \c f \o format as [-]9.9 - \row \o \c g \o use \c e or \c f format, whichever is the most concise - \row \o \c G \o use \c E or \c f format, whichever is the most concise + \header \li Format \li Meaning + \row \li \c e \li format as [-]9.9e[+|-]999 + \row \li \c E \li format as [-]9.9E[+|-]999 + \row \li \c f \li format as [-]9.9 + \row \li \c g \li use \c e or \c f format, whichever is the most concise + \row \li \c G \li use \c E or \c f format, whichever is the most concise \endtable A \e precision is also specified with the argument \e format. For @@ -2789,7 +2789,7 @@ struct QStringCapture \snippet doc/src/snippets/qstring/main.cpp 42 For regular expressions containing \l{capturing parentheses}, - occurrences of \bold{\\1}, \bold{\\2}, ..., in \a after are replaced + occurrences of \b{\\1}, \b{\\2}, ..., in \a after are replaced with \a{rx}.cap(1), cap(2), ... \snippet doc/src/snippets/qstring/main.cpp 43 @@ -6059,7 +6059,7 @@ QStringList QString::split(QChar sep, SplitBehavior behavior, Qt::CaseSensitivit \snippet doc/src/snippets/qstring/main.cpp 60 Here's a third example where we use a zero-length assertion, - \bold{\\b} (word boundary), to split the string into an + \b{\\b} (word boundary), to split the string into an alternating sequence of non-word and word tokens: \snippet doc/src/snippets/qstring/main.cpp 61 diff --git a/src/corelib/tools/qstringlist.cpp b/src/corelib/tools/qstringlist.cpp index a352045a7d..b4ec0c6498 100644 --- a/src/corelib/tools/qstringlist.cpp +++ b/src/corelib/tools/qstringlist.cpp @@ -342,7 +342,7 @@ void QtPrivate::QStringList_replaceInStrings(QStringList *that, const QString &b \snippet doc/src/snippets/qstringlist/main.cpp 14 For regular expressions that contain \l{capturing parentheses}, - occurrences of \bold{\\1}, \bold{\\2}, ..., in \a after are + occurrences of \b{\\1}, \b{\\2}, ..., in \a after are replaced with \a{rx}.cap(1), \a{rx}.cap(2), ... For example: diff --git a/src/corelib/tools/qvarlengtharray.qdoc b/src/corelib/tools/qvarlengtharray.qdoc index 1a0579a077..e1dc2bee9a 100644 --- a/src/corelib/tools/qvarlengtharray.qdoc +++ b/src/corelib/tools/qvarlengtharray.qdoc @@ -69,13 +69,13 @@ structure. The main differences between the two classes are: \list - \o QVarLengthArray's API is much more low-level. It provides no + \li QVarLengthArray's API is much more low-level. It provides no iterators and lacks much of QVector's functionality. - \o QVarLengthArray doesn't initialize the memory if the value is + \li QVarLengthArray doesn't initialize the memory if the value is a basic type. (QVector always does.) - \o QVector uses \l{implicit sharing} as a memory optimization. + \li QVector uses \l{implicit sharing} as a memory optimization. QVarLengthArray doesn't provide that feature; however, it usually produces slightly better performance due to reduced overhead, especially in tight loops. diff --git a/src/corelib/tools/qvector.cpp b/src/corelib/tools/qvector.cpp index 3efe695559..75c219bbc9 100644 --- a/src/corelib/tools/qvector.cpp +++ b/src/corelib/tools/qvector.cpp @@ -108,21 +108,21 @@ int QVectorData::grow(int sizeofTypedData, int size, int sizeofT, bool excessive similar functionality. Here's an overview: \list - \i For most purposes, QList is the right class to use. Operations + \li For most purposes, QList is the right class to use. Operations like prepend() and insert() are usually faster than with QVector because of the way QList stores its items in memory (see \l{Algorithmic Complexity} for details), and its index-based API is more convenient than QLinkedList's iterator-based API. It also expands to less code in your executable. - \i If you need a real linked list, with guarantees of \l{constant + \li If you need a real linked list, with guarantees of \l{constant time} insertions in the middle of the list and iterators to items rather than indexes, use QLinkedList. - \i If you want the items to occupy adjacent memory positions, or + \li If you want the items to occupy adjacent memory positions, or if your items are larger than a pointer and you want to avoid the overhead of allocating them on the heap individually at insertion time, then use QVector. - \i If you want a low-level variable-size array, QVarLengthArray + \li If you want a low-level variable-size array, QVarLengthArray may be sufficient. \endlist |