summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLars Knoll <lars.knoll@nokia.com>2012-01-17 13:58:43 +0100
committerLars Knoll <lars.knoll@nokia.com>2012-01-17 15:51:08 +0100
commitd325c361349ce38f5f7dc549dc69f7aae5556069 (patch)
treefe13030427f967cb10219fa62d0c692461c070c0
parentfd543de5da7c8924d353bf4d0aff45b5bdc9911f (diff)
Smaller documentation fixes
Change-Id: Iadbd09c7daad6707c95dd6efaf5d3b4978a278a3 Sanity-Review: Qt Sanity Bot <qt_sanity_bot@ovi.com> Reviewed-by: Jerome Pasion <jerome.pasion@nokia.com>
-rw-r--r--src/qjsondocument.cpp20
-rw-r--r--src/qjsonvalue.cpp4
2 files changed, 12 insertions, 12 deletions
diff --git a/src/qjsondocument.cpp b/src/qjsondocument.cpp
index 2381441..81787fc 100644
--- a/src/qjsondocument.cpp
+++ b/src/qjsondocument.cpp
@@ -61,7 +61,7 @@ namespace QtJson {
write this document both from a utf-8 encoded text based representation as well
as Qt's own binary format.
- A JSON document can be converted from it's text based representation to a QJsonDocument
+ A JSON document can be converted from its text-based representation to a QJsonDocument
using QJsonDocument::fromJson(). toJson() converts it back to text. The parser is very
fast and efficient and converts the JSON to the binary representation used by Qt.
@@ -211,7 +211,7 @@ QJsonDocument QJsonDocument::fromBinaryData(const QByteArray &data)
}
/*!
- Creates a QJsonDocument from the the QVariant \a variant.
+ Creates a QJsonDocument from the QVariant \a variant.
If the \a variant contains any other type than a QVariant::Map,
QVariant::List or QVariant::StringList, the returned document
@@ -235,7 +235,7 @@ QJsonDocument QJsonDocument::fromVariant(const QVariant &variant)
/*!
\returns a QVariant representing the Json document.
- The JSON data types are mappes as follows:
+ The JSON data types are mapped as follows:
\list
\o Null an empty variant
@@ -260,7 +260,7 @@ QVariant QJsonDocument::toVariant() const
}
/*!
- Converts the QJsonDocument to a utf-8 encoded JSON document.
+ Converts the QJsonDocument to a UTF-8 encoded JSON document.
\sa fromJson
*/
@@ -280,8 +280,8 @@ QByteArray QJsonDocument::toJson() const
}
/*!
- Parses a utf-8 encoded JSON document and creates a QJsonDocument
- from it. isValid will return true if no error was encountered during
+ Parses a UTF-8 encoded JSON document and creates a QJsonDocument
+ from it. isValid will return \c true if no error was encountered during
parsing.
\sa toJson
@@ -307,7 +307,7 @@ bool QJsonDocument::isEmpty() const
\returns a binary representation of the document.
The binary representation is also the native format used internally in Qt,
- and such very efficient and fast to convert to and from.
+ and is very efficient and fast to convert to and from.
The binary format can be stored on disk and interchanged with other applications
or computers. fromBinaryData() can be used to convert it back into a
@@ -442,7 +442,7 @@ void QJsonDocument::setArray(const QJsonArray &array)
}
/*!
- returns true if \a other is equal to this document
+ returns \c true if \a other is equal to this document
*/
bool QJsonDocument::operator==(const QJsonDocument &other) const
{
@@ -464,7 +464,7 @@ bool QJsonDocument::operator==(const QJsonDocument &other) const
}
/*!
- returns true if \a other is not equal to this document
+ returns \c true if \a other is not equal to this document
*/
bool QJsonDocument::operator!=(const QJsonDocument &other) const
{
@@ -474,7 +474,7 @@ bool QJsonDocument::operator!=(const QJsonDocument &other) const
/*!
returns true if this document is valid.
- Documents created from utf-8 encoded text are validated during
+ Documents created from UTF-8 encoded text are validated during
parsing.
Documents created from binary data are however not validated, and
diff --git a/src/qjsonvalue.cpp b/src/qjsonvalue.cpp
index b7102c1..50208f8 100644
--- a/src/qjsonvalue.cpp
+++ b/src/qjsonvalue.cpp
@@ -75,8 +75,8 @@ namespace QtJson {
A value can represent any of the above data types. In addition, QJsonValue has one special
flag to represent undefined values. This can be queried with isUndefined().
- The type of the value can be queried with type() or accessors like isBool(), isString(), etc.
- The value can be converted to the type stored in it using the toBool(), toString(), etc. methods.
+ The type of the value can be queried with type() or accessors like isBool(), isString(), and so on.
+ Likewise, the value can be converted to the type stored in it using the toBool(), toString() and so on.
Values are strictly typed internally and contrary to QVariant will not attempt to do any implicit type
conversions. This implies that converting to a type that is not stored in the value will return a default