From 5ed2f422fc3c80731be7a07da3875aaa5572d4e6 Mon Sep 17 00:00:00 2001 From: Nico Vertriest Date: Fri, 31 Oct 2014 14:20:20 +0100 Subject: Doc: corrected autolink errors corelib/io Task-number: QTBUG-40362 Change-Id: I1cdbde1f6b003556ba4b5e97a49c6d918518da0d Reviewed-by: Venugopal Shivashankar Reviewed-by: Jerome Pasion --- doc/src/examples/codecs.qdoc | 37 ----------------------- examples/widgets/tools/codecs/doc/src/codecs.qdoc | 37 +++++++++++++++++++++++ src/corelib/codecs/qtextcodec.cpp | 4 +-- src/corelib/io/qdebug.cpp | 4 +-- src/corelib/io/qfiledevice.cpp | 6 ++-- src/corelib/io/qloggingcategory.cpp | 8 ++--- src/corelib/io/qprocess.cpp | 10 +++--- src/corelib/io/qstandardpaths.cpp | 8 ++--- src/corelib/io/qtemporarydir.cpp | 2 +- src/corelib/io/qtextstream.cpp | 16 +++++----- src/corelib/io/qurl.cpp | 13 ++++---- 11 files changed, 73 insertions(+), 72 deletions(-) delete mode 100644 doc/src/examples/codecs.qdoc create mode 100644 examples/widgets/tools/codecs/doc/src/codecs.qdoc diff --git a/doc/src/examples/codecs.qdoc b/doc/src/examples/codecs.qdoc deleted file mode 100644 index d9f69563ac..0000000000 --- a/doc/src/examples/codecs.qdoc +++ /dev/null @@ -1,37 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). -** Contact: http://www.qt-project.org/legal -** -** This file is part of the documentation of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:FDL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and Digia. For licensing terms and -** conditions see http://qt.digia.com/licensing. For further information -** use the contact form at http://qt.digia.com/contact-us. -** -** GNU Free Documentation License Usage -** Alternatively, this file may be used under the terms of the GNU Free -** Documentation License version 1.3 as published by the Free Software -** Foundation and appearing in the file included in the packaging of -** this file. Please review the following information to ensure -** the GNU Free Documentation License version 1.3 requirements -** will be met: http://www.gnu.org/copyleft/fdl.html. -** $QT_END_LICENSE$ -** -****************************************************************************/ - -/*! - \example codecs - \title Codecs Example - - The Codecs example demonstrates the principles behind importing and exporting text - using codecs to ensure that characters are encoded properly, avoiding loss of data - and retaining the correct symbols used in various scripts. - - \image codecs-example.png -*/ diff --git a/examples/widgets/tools/codecs/doc/src/codecs.qdoc b/examples/widgets/tools/codecs/doc/src/codecs.qdoc new file mode 100644 index 0000000000..e81cc00c54 --- /dev/null +++ b/examples/widgets/tools/codecs/doc/src/codecs.qdoc @@ -0,0 +1,37 @@ +/**************************************************************************** +** +** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies). +** Contact: http://www.qt-project.org/legal +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and Digia. For licensing terms and +** conditions see http://qt.digia.com/licensing. For further information +** use the contact form at http://qt.digia.com/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: http://www.gnu.org/copyleft/fdl.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \example tools/codecs + \title Text Codecs Example + + The Text Codecs example demonstrates the principles behind importing and exporting text + using codecs to ensure that characters are encoded properly, avoiding loss of data + and retaining the correct symbols used in various scripts. + + \image codecs-example.png +*/ diff --git a/src/corelib/codecs/qtextcodec.cpp b/src/corelib/codecs/qtextcodec.cpp index d2857c03b6..6eae9e598d 100644 --- a/src/corelib/codecs/qtextcodec.cpp +++ b/src/corelib/codecs/qtextcodec.cpp @@ -380,7 +380,7 @@ QTextCodec::ConverterState::~ConverterState() If Qt is compiled with ICU support enabled, most codecs supported by ICU will also be available to the application. - QTextCodecs can be used as follows to convert some locally encoded + \l {QTextCodec}s can be used as follows to convert some locally encoded string to Unicode. Suppose you have some string encoded in Russian KOI8-R encoding, and want to convert it to Unicode. The simple way to do it is like this: @@ -453,7 +453,7 @@ QTextCodec::ConverterState::~ConverterState() \li Converts a Unicode string to an 8-bit character string. \endtable - \sa QTextStream, QTextDecoder, QTextEncoder, {Codecs Example} + \sa QTextStream, QTextDecoder, QTextEncoder, {Text Codecs Example} */ /*! diff --git a/src/corelib/io/qdebug.cpp b/src/corelib/io/qdebug.cpp index c1e0125cb1..5c77ccdcbf 100644 --- a/src/corelib/io/qdebug.cpp +++ b/src/corelib/io/qdebug.cpp @@ -403,8 +403,8 @@ QDebug &QDebug::resetFormat() \brief Convenience class for custom QDebug operators Saves the settings used by QDebug, and restores them upon destruction, - then calls maybeSpace(), to separate arguments with a space if - autoInsertSpaces() was true at the time of constructing the QDebugStateSaver. + then calls \l {QDebug::maybeSpace()}{maybeSpace()}, to separate arguments with a space if + \l {QDebug::autoInsertSpaces()}{autoInsertSpaces()} was true at the time of constructing the QDebugStateSaver. The automatic insertion of spaces between writes is one of the settings that QDebugStateSaver stores for the duration of the current block. diff --git a/src/corelib/io/qfiledevice.cpp b/src/corelib/io/qfiledevice.cpp index 598347a56f..29b59f1dcc 100644 --- a/src/corelib/io/qfiledevice.cpp +++ b/src/corelib/io/qfiledevice.cpp @@ -240,7 +240,7 @@ bool QFileDevice::isSequential() const Returns the file handle of the file. This is a small positive integer, suitable for use with C library - functions such as fdopen() and fcntl(). On systems that use file + functions such as \c fdopen() and \c fcntl(). On systems that use file descriptors for sockets (i.e. Unix systems, but not Windows) the handle can be used with QSocketNotifier as well. @@ -389,9 +389,9 @@ bool QFileDevice::atEnd() const return false. Seeking beyond the end of a file: - If the position is beyond the end of a file, then seek() shall not + If the position is beyond the end of a file, then seek() will not immediately extend the file. If a write is performed at this position, - then the file shall be extended. The content of the file between the + then the file will be extended. The content of the file between the previous end of file and the newly written data is UNDEFINED and varies between platforms and file systems. */ diff --git a/src/corelib/io/qloggingcategory.cpp b/src/corelib/io/qloggingcategory.cpp index fef48a9040..79d20601a6 100644 --- a/src/corelib/io/qloggingcategory.cpp +++ b/src/corelib/io/qloggingcategory.cpp @@ -149,10 +149,10 @@ static void setBoolLane(QBasicAtomicInt *atomic, bool enable, int shift) Order of evaluation: \list - \li Rules from QtProject/qtlogging.ini - \li Rules set by \l setFilterRules() - \li Rules from file in \c QT_LOGGING_CONF - \li Rules from environment variable QT_LOGGING_RULES + \li QtProject/qtlogging.ini + \li \l setFilterRules() + \li \c QT_LOGGING_CONF + \li \c QT_LOGGING_RULES \endlist The \c QtProject/qtlogging.ini file is looked up in all directories returned diff --git a/src/corelib/io/qprocess.cpp b/src/corelib/io/qprocess.cpp index e76a836954..a234050777 100644 --- a/src/corelib/io/qprocess.cpp +++ b/src/corelib/io/qprocess.cpp @@ -1853,8 +1853,8 @@ void QProcess::setProcessState(ProcessState state) /*! This function is called in the child process context just before the - program is executed on Unix or Mac OS X (i.e., after \e fork(), but before - \e execve()). Reimplement this function to do last minute initialization + program is executed on Unix or OS X (i.e., after \c fork(), but before + \c execve()). Reimplement this function to do last minute initialization of the child process. Example: \snippet code/src_corelib_io_qprocess.cpp 4 @@ -1864,7 +1864,7 @@ void QProcess::setProcessState(ProcessState state) execution, your workaround is to emit finished() and then call exit(). - \warning This function is called by QProcess on Unix and Mac OS X + \warning This function is called by QProcess on Unix and OS X only. On Windows and QNX, it is not called. */ void QProcess::setupChildProcess() @@ -2272,7 +2272,7 @@ void QProcess::setArguments(const QStringList &arguments) On Windows, terminate() posts a WM_CLOSE message to all toplevel windows of the process and then to the main thread of the process itself. On Unix - and Mac OS X the SIGTERM signal is sent. + and OS X the \c SIGTERM signal is sent. Console applications on Windows that do not run an event loop, or whose event loop does not handle the WM_CLOSE message, can only be terminated by @@ -2289,7 +2289,7 @@ void QProcess::terminate() /*! Kills the current process, causing it to exit immediately. - On Windows, kill() uses TerminateProcess, and on Unix and Mac OS X, the + On Windows, kill() uses TerminateProcess, and on Unix and OS X, the SIGKILL signal is sent to the process. \sa terminate() diff --git a/src/corelib/io/qstandardpaths.cpp b/src/corelib/io/qstandardpaths.cpp index c206e432f6..538292f0a5 100644 --- a/src/corelib/io/qstandardpaths.cpp +++ b/src/corelib/io/qstandardpaths.cpp @@ -588,11 +588,11 @@ QString QStandardPaths::displayName(StandardLocation type) GenericCacheLocation, CacheLocation. Other locations are not affected. - On Unix, XDG_DATA_HOME is set to ~/.qttest/share, XDG_CONFIG_HOME is - set to ~/.qttest/config, and XDG_CACHE_HOME is set to ~/.qttest/cache. + On Unix, \c XDG_DATA_HOME is set to \e ~/.qttest/share, \c XDG_CONFIG_HOME is + set to \e ~/.qttest/config, and \c XDG_CACHE_HOME is set to \e ~/.qttest/cache. - On Mac, data goes to "~/.qttest/Application Support", cache goes to - ~/.qttest/Cache, and config goes to ~/.qttest/Preferences. + On OS X, data goes to \e ~/.qttest/Application Support, cache goes to + \e ~/.qttest/Cache, and config goes to \e ~/.qttest/Preferences. On Windows, everything goes to a "qttest" directory under Application Data. */ diff --git a/src/corelib/io/qtemporarydir.cpp b/src/corelib/io/qtemporarydir.cpp index 7ce37fd320..5e0def74ee 100644 --- a/src/corelib/io/qtemporarydir.cpp +++ b/src/corelib/io/qtemporarydir.cpp @@ -180,7 +180,7 @@ void QTemporaryDirPrivate::create(const QString &templateName) \snippet code/src_corelib_io_qtemporarydir.cpp 0 It is very important to test that the temporary directory could be - created, using isValid(). Do not use exists(), since a default-constructed + created, using isValid(). Do not use \l {QDir::exists()}{exists()}, since a default-constructed QDir represents the current directory, which exists. The path to the temporary dir can be found by calling path(). diff --git a/src/corelib/io/qtextstream.cpp b/src/corelib/io/qtextstream.cpp index 66727e7dc4..089a915a36 100644 --- a/src/corelib/io/qtextstream.cpp +++ b/src/corelib/io/qtextstream.cpp @@ -85,8 +85,8 @@ static const int QTEXTSTREAM_BUFFERSIZE = 16384; \li Chunk by chunk, by calling readLine() or readAll(). - \li Word by word. QTextStream supports streaming into QStrings, - QByteArrays and char* buffers. Words are delimited by space, and + \li Word by word. QTextStream supports streaming into \l {QString}s, + \l {QByteArray}s and char* buffers. Words are delimited by space, and leading white space is automatically skipped. \li Character by character, by streaming into QChar or char types. @@ -158,7 +158,7 @@ static const int QTEXTSTREAM_BUFFERSIZE = 16384; parameter: qSetFieldWidth(), qSetPadChar(), and qSetRealNumberPrecision(). - \sa QDataStream, QIODevice, QFile, QBuffer, QTcpSocket, {Codecs Example} + \sa QDataStream, QIODevice, QFile, QBuffer, QTcpSocket, {Text Codecs Example} */ /*! \enum QTextStream::RealNumberNotation @@ -1531,7 +1531,7 @@ bool QTextStream::atEnd() const QString. Avoid this function when working on large files, as it will consume a significant amount of memory. - Calling readLine() is better if you do not know how much data is + Calling \l {QTextStream::readLine()}{readLine()} is better if you do not know how much data is available. \sa readLine() @@ -1556,9 +1556,9 @@ QString QTextStream::readAll() The returned line has no trailing end-of-line characters ("\\n" or "\\r\\n"), so calling QString::trimmed() is unnecessary. - If the stream has read to the end of the file, readLine() will return a - null QString. For strings, or for devices that support it, you can - explicitly test for the end of the stream using atEnd(). + If the stream has read to the end of the file, \l {QTextStream::readLine()}{readLine()} + will return a null QString. For strings, or for devices that support it, + you can explicitly test for the end of the stream using atEnd(). \sa readAll(), QIODevice::readLine() */ @@ -2790,7 +2790,7 @@ QTextStream &endl(QTextStream &stream) /*! \relates QTextStream - Calls QTextStream::flush() on \a stream and returns \a stream. + Calls \l{QTextStream::flush()}{flush()} on \a stream and returns \a stream. \sa endl(), reset(), {QTextStream manipulators} */ diff --git a/src/corelib/io/qurl.cpp b/src/corelib/io/qurl.cpp index d4c5e03058..d4c5a34cef 100644 --- a/src/corelib/io/qurl.cpp +++ b/src/corelib/io/qurl.cpp @@ -2671,8 +2671,8 @@ void QUrl::setQuery(const QUrlQuery &query) Sets the query string of the URL to an encoded version of \a query. The contents of \a query are converted to a string internally, each pair delimited by the character returned by - queryPairDelimiter(), and the key and value are delimited by - queryValueDelimiter(). + \l {QUrlQuery::queryPairDelimiter()}{queryPairDelimiter()}, and the key and value are delimited by + \l {QUrlQuery::queryValueDelimiter()}{queryValueDelimiter()} \note This method does not encode spaces (ASCII 0x20) as plus (+) signs, like HTML forms do. If you need that kind of encoding, you must encode @@ -2691,8 +2691,8 @@ void QUrl::setQuery(const QUrlQuery &query) Sets the query string of the URL to the encoded version of \a query. The contents of \a query are converted to a string internally, each pair delimited by the character returned by - queryPairDelimiter(), and the key and value are delimited by - queryValueDelimiter(). + \l {QUrlQuery::queryPairDelimiter()}{queryPairDelimiter()}, and the key and value are delimited by + \l {QUrlQuery::queryValueDelimiter()}{queryValueDelimiter()}. \obsolete Use QUrlQuery and setQuery(). @@ -2709,8 +2709,9 @@ void QUrl::setQuery(const QUrlQuery &query) The key-value pair is encoded before it is added to the query. The pair is converted into separate strings internally. The \a key and \a value is first encoded into UTF-8 and then delimited by the - character returned by queryValueDelimiter(). Each key-value pair is - delimited by the character returned by queryPairDelimiter(). + character returned by \l {QUrlQuery::queryValueDelimiter()}{queryValueDelimiter()}. + Each key-value pair is delimited by the character returned by + \l {QUrlQuery::queryPairDelimiter()}{queryPairDelimiter()} \note This method does not encode spaces (ASCII 0x20) as plus (+) signs, like HTML forms do. If you need that kind of encoding, you must encode -- cgit v1.2.3