diff options
author | Casper van Donderen <casper.vandonderen@nokia.com> | 2012-03-01 15:28:31 +0100 |
---|---|---|
committer | Qt by Nokia <qt-info@nokia.com> | 2012-03-02 23:16:25 +0100 |
commit | 95d83cb1b68cc4a415d5d80859b4e74472ad7112 (patch) | |
tree | 9f6fa892ee78f584224320a195f03419c0fdbc21 /src/corelib/io | |
parent | 15e136d4e116c1513c106dfbb75e1953a7f3463c (diff) |
Remove the usage of deprecated qdoc macros.
QDoc now has support for Doxygen style commands for italics, bold
and list items. This change applies that change in QDoc to the
actual documentation.
Task-number: QTBUG-24578
Change-Id: I519bf9c29b14092e3ab6067612f42bf749eeedf5
Reviewed-by: Shane Kearns <shane.kearns@accenture.com>
Reviewed-by: Lars Knoll <lars.knoll@nokia.com>
Diffstat (limited to 'src/corelib/io')
-rw-r--r-- | src/corelib/io/qdatastream.cpp | 28 | ||||
-rw-r--r-- | src/corelib/io/qdir.cpp | 20 | ||||
-rw-r--r-- | src/corelib/io/qfile.cpp | 8 | ||||
-rw-r--r-- | src/corelib/io/qfileinfo.cpp | 6 | ||||
-rw-r--r-- | src/corelib/io/qiodevice.cpp | 16 | ||||
-rw-r--r-- | src/corelib/io/qprocess.cpp | 18 | ||||
-rw-r--r-- | src/corelib/io/qsettings.cpp | 126 | ||||
-rw-r--r-- | src/corelib/io/qtextstream.cpp | 68 | ||||
-rw-r--r-- | src/corelib/io/qurl.cpp | 16 |
9 files changed, 153 insertions, 153 deletions
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) |