feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Doc: edit coreplugin docs

Browse Source 
Remove \brief commands for functions.
Use standard wording for QDoc commands.
Fix style and grammar issues.
Use the \a command instead of the \c command for attributes
in function descriptions.
Do not use \returns, because it does not exist.

Change-Id: Icd32b519670cb376e246bab3a58fe7e98d2529ea
Reviewed-by: Eike Ziller <eike.ziller@digia.com>
This commit is contained in:
Leena Miettinen
2013-09-06 16:38:53 +02:00
committed by Eike Ziller
parent 65f0588196
commit 120bf88eab
14 changed files with 281 additions and 243 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
src/plugins/coreplugin/textdocument.cpp
View File

@@ -38,7 +38,7 @@
\brief The TextFile class is a base class for text files with encoding
helpers.
Stores the format obtained from read operations and uses that when writing
This class stores the format obtained from read operations and uses that when writing
out files, thus ensuring that CRLF/encodings are preserved.
\sa Utils::TextFileUtils
@@ -83,7 +83,7 @@ QByteArray TextDocument::decodingErrorSample() const
}
/*!
\brief Writes out text using the format obtained from the last read.
Writes out text using the format obtained from the last read.
*/
bool TextDocument::write(const QString &fileName, const QString &data, QString *errorMessage) const
@@ -92,7 +92,7 @@ bool TextDocument::write(const QString &fileName, const QString &data, QString *
}
/*!
\brief Writes out text using a custom format obtained.
Writes out text using a custom \a format.
*/
bool TextDocument::write(const QString &fileName, const Utils::TextFileFormat &format, const QString &data, QString *errorMessage) const
@@ -103,7 +103,7 @@ bool TextDocument::write(const QString &fileName, const Utils::TextFileFormat &f
}
/*!
\brief Autodetect format and read in a text file.
Autodetects format and reads in the text file specified by \a fileName.
*/
TextDocument::ReadResult TextDocument::read(const QString &fileName, QStringList *plainTextList, QString *errorString)
@@ -115,7 +115,7 @@ TextDocument::ReadResult TextDocument::read(const QString &fileName, QStringList
}
/*!
\brief Autodetect format and read in a text file.
Autodetects format and reads in the text file specified by \a fileName.
*/
TextDocument::ReadResult TextDocument::read(const QString &fileName, QString *plainText, QString *errorString)
@@ -146,7 +146,7 @@ void TextDocument::switchUtf8Bom()
}
/*!
\brief Returns the format obtained from the last call to read().
Returns the format obtained from the last call to \c read().
*/
Utils::TextFileFormat TextDocument::format() const