summaryrefslogtreecommitdiffstats
path: root/src/corelib/io/qabstractfileengine.cpp
diff options
context:
space:
mode:
authorCasper van Donderen <casper.vandonderen@nokia.com>2012-03-20 19:37:07 +0100
committerQt by Nokia <qt-info@nokia.com>2012-04-19 07:34:53 +0200
commit0bc02fd0d61d1e4aed9b39890d28975dff30e822 (patch)
treee967ab719c7f8df24c35b088bd48e0f5b0942148 /src/corelib/io/qabstractfileengine.cpp
parent7f0c130be963de90d1baeb037820b17a4f298700 (diff)
Doc: Prepare for building modular QtCore docs.
This change fixes most qdoc errors in QtCore. There are about 900 left. The main thing this change does is moving documentation from qtcore from /doc/src to /src/corelib/doc. Other issues resolved are mis-use of qdoc commands. Change-Id: I002d01edfb13575e8bf27ce91596a577a92562d1 Reviewed-by: Lars Knoll <lars.knoll@nokia.com> Reviewed-by: Jason McDonald <jason.mcdonald@nokia.com> Reviewed-by: Jerome Pasion <jerome.pasion@nokia.com>
Diffstat (limited to 'src/corelib/io/qabstractfileengine.cpp')
-rw-r--r--src/corelib/io/qabstractfileengine.cpp20
1 files changed, 10 insertions, 10 deletions
diff --git a/src/corelib/io/qabstractfileengine.cpp b/src/corelib/io/qabstractfileengine.cpp
index 021698115c..6c10c6cb00 100644
--- a/src/corelib/io/qabstractfileengine.cpp
+++ b/src/corelib/io/qabstractfileengine.cpp
@@ -87,7 +87,7 @@ QT_BEGIN_NAMESPACE
For example:
- \snippet doc/src/snippets/code/src_corelib_io_qabstractfileengine.cpp 0
+ \snippet code/src_corelib_io_qabstractfileengine.cpp 0
When the handler is destroyed, it is automatically removed from Qt.
@@ -184,7 +184,7 @@ QAbstractFileEngine *qt_custom_file_engine_handler_create(const QString &path)
Example:
- \snippet doc/src/snippets/code/src_corelib_io_qabstractfileengine.cpp 1
+ \snippet code/src_corelib_io_qabstractfileengine.cpp 1
\sa QAbstractFileEngine::create()
*/
@@ -461,7 +461,7 @@ bool QAbstractFileEngine::isSequential() const
This virtual function must be reimplemented by all subclasses.
- \sa setFileName() rmdir()
+ \sa setFileName(), rmdir()
*/
bool QAbstractFileEngine::remove()
{
@@ -515,7 +515,7 @@ bool QAbstractFileEngine::link(const QString &newName)
This virtual function must be reimplemented by all subclasses.
- \sa setFileName() rmdir() isRelativePath()
+ \sa setFileName(), rmdir(), isRelativePath()
*/
bool QAbstractFileEngine::mkdir(const QString &dirName, bool createParentDirectories) const
{
@@ -535,7 +535,7 @@ bool QAbstractFileEngine::mkdir(const QString &dirName, bool createParentDirecto
This virtual function must be reimplemented by all subclasses.
- \sa setFileName() remove() mkdir() isRelativePath()
+ \sa setFileName(), remove(), mkdir(), isRelativePath()
*/
bool QAbstractFileEngine::rmdir(const QString &dirName, bool recurseParentDirectories) const
{
@@ -671,7 +671,7 @@ QString QAbstractFileEngine::fileName(FileName file) const
This virtual function must be reimplemented by all subclasses.
- \sa owner() setFileName(), FileOwner
+ \sa owner(), setFileName(), FileOwner
*/
uint QAbstractFileEngine::ownerId(FileOwner owner) const
{
@@ -687,7 +687,7 @@ uint QAbstractFileEngine::ownerId(FileOwner owner) const
This virtual function must be reimplemented by all subclasses.
- \sa ownerId() setFileName(), FileOwner
+ \sa ownerId(), setFileName(), FileOwner
*/
QString QAbstractFileEngine::owner(FileOwner owner) const
{
@@ -821,7 +821,7 @@ bool QAbstractFileEngine::unmap(uchar *address)
Example:
- \snippet doc/src/snippets/code/src_corelib_io_qabstractfileengine.cpp 2
+ \snippet code/src_corelib_io_qabstractfileengine.cpp 2
QAbstractFileEngineIterator is associated with a path, name filters, and
entry filters. The path is the directory that the iterator lists entries
@@ -846,7 +846,7 @@ bool QAbstractFileEngine::unmap(uchar *address)
Here is an example of how to implement an iterator that returns each of
three fixed entries in sequence.
- \snippet doc/src/snippets/code/src_corelib_io_qabstractfileengine.cpp 3
+ \snippet code/src_corelib_io_qabstractfileengine.cpp 3
Note: QAbstractFileEngineIterator does not deal with QDir::IteratorFlags;
it simply returns entries for a single directory.
@@ -1080,7 +1080,7 @@ qint64 QAbstractFileEngine::write(const char *data, qint64 len)
}
/*!
- This function reads one line, terminated by a '\n' character, from the
+ This function reads one line, terminated by a '\\n' character, from the
file info \a data. At most \a maxlen characters will be read. The
end-of-line character is included.
*/