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

Doc: edit utils docs

Browse Source 
Use \a for all attributes in function descriptions
to avoid QDoc errors. Do not use \param, because
it is not a valid QDoc command.

Do not use \returns as it does not exist.

Do not use \brief for functions. It is not obligatory, so
rather than add them for all functions, let's consistenly leave them out.

Fix typos, grammar and style issues, and punctuation.

Change-Id: Ib8f296f93976265bb93dbeab40c5b47156518122
Reviewed-by: hjk <hjk121@nokiamail.com>
This commit is contained in:
Leena Miettinen
2013-09-06 13:23:11 +02:00
parent 5358ffe903
commit efbecf21db
14 changed files with 86 additions and 83 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
src/libs/utils/textfileformat.cpp
View File

@@ -78,7 +78,7 @@ TextFileFormat::TextFileFormat() :
}
/*!
\brief Detect the format of text data.
Detects the format of text data.
*/
TextFileFormat TextFileFormat::detect(const QByteArray &data)
@@ -111,7 +111,7 @@ TextFileFormat TextFileFormat::detect(const QByteArray &data)
}
/*!
\brief Returns a piece of text suitable as display for a encoding error.
Returns a piece of text suitable as display for a encoding error.
*/
QByteArray TextFileFormat::decodingErrorSample(const QByteArray &data)
@@ -179,7 +179,7 @@ bool decodeTextFileContent(const QByteArray &dataBA,
}
/*!
\brief Decode data to a plain string.
Decodes data to a plain string.
*/
bool TextFileFormat::decode(const QByteArray &data, QString *target) const
@@ -189,7 +189,7 @@ bool TextFileFormat::decode(const QByteArray &data, QString *target) const
}
/*!
\brief Decode data to a list of strings.
Decodes data to a list of strings.
Intended for use with progress bars loading large files.
*/
@@ -236,7 +236,7 @@ TextFileFormat::ReadResult readTextFile(const QString &fileName, const QTextCode
}
/*!
\brief Read text file into a list of strings.
Reads a text file into a list of strings.
*/
TextFileFormat::ReadResult
@@ -254,7 +254,7 @@ TextFileFormat::ReadResult
}
/*!
\brief Read text file into a string.
Reads a text file into a string.
*/
TextFileFormat::ReadResult
@@ -272,7 +272,7 @@ TextFileFormat::ReadResult
}
/*!
\brief Write out a text file.
Writes out a text file.
*/
bool TextFileFormat::writeFile(const QString &fileName, QString plainText, QString *errorString) const