Skip to content

Commit

Permalink
one more round of spelling and grammar mistakes, the docs should be l…
Browse files Browse the repository at this point in the history
…ooking much better now

Signed-off-by: 5n4k3 <5n4k3@snakepitsoftware.com>
  • Loading branch information
forbesrodney committed Sep 8, 2015
1 parent e05605a commit 32668a8
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 33 deletions.
2 changes: 1 addition & 1 deletion include/qmjson.h
Expand Up @@ -51,7 +51,7 @@
* to use the QtMark JSON classes without storing them in a QMPointer as
* each class prohibits by-value copying. Although storing these classes in
* managed QMPointers adds an extra level of complexity, it also provides
* a lot of benefits. The most notible being the following:
* a lot of benefits. The most notable being the following:
*
* @code
*
Expand Down
17 changes: 8 additions & 9 deletions include/qmjsonarray.h
Expand Up @@ -686,7 +686,7 @@ bool QMJsonArray::from(int32_t index, const T &value)
/**
* @fn bool QMJsonArray::toBool(int32_t index) const
* Unwraps the JSON value at @e index and returns the internal type.
* Depending on what type the JSON value is, will dictate what is returned:
* The type of the JSON value, will dictate what is returned:
*
* - null: false
* - bool: true / falue (native)
Expand All @@ -698,7 +698,7 @@ bool QMJsonArray::from(int32_t index, const T &value)
/**
* @fn double QMJsonArray::toDouble(int32_t index) const
* Unwraps the JSON value at @e index and returns the internal type.
* Depending on what type the JSON value is, will dictate what is returned:
* The type of the JSON value, will dictate what is returned:
*
* - null: 0
* - bool: false = 0, true = 1
Expand All @@ -710,7 +710,7 @@ bool QMJsonArray::from(int32_t index, const T &value)
/**
* @fn QString QMJsonArray::toString(int32_t index) const
* Unwraps the JSON value at @e index and returns the internal type.
* Depending on what type the JSON value is, will dictate what is returned:
* The type of the JSON value, will dictate what is returned:
*
* - null: "null"
* - bool: "true" if true, "false" if false
Expand Down Expand Up @@ -782,7 +782,7 @@ bool QMJsonArray::from(int32_t index, const T &value)
/**
* @fn bool QMJsonArray::fromBool(int32_t index, bool value)
* Unwraps the JSON value at @e index and sets the internal type.
* Depending on what type the JSON value is, will dictate what the internal
* The type of the JSON value, will dictate what the internal
* type is set to:
*
* - null: (ignored, returns false)
Expand All @@ -795,7 +795,7 @@ bool QMJsonArray::from(int32_t index, const T &value)
/**
* @fn bool QMJsonArray::fromDouble(int32_t index, double value)
* Unwraps the JSON value at @e index and sets the internal type.
* Depending on what type the JSON value is, will dictate what the internal
* The type of the JSON value, will dictate what the internal
* type is set to:
*
* - null: (ignored, returns false)
Expand All @@ -808,7 +808,7 @@ bool QMJsonArray::from(int32_t index, const T &value)
/**
* @fn bool QMJsonArray::fromString(int32_t index, const QString &value);
* Unwraps the JSON value at @e index and sets the internal type.
* Depending on what type the JSON value is, will dictate what the
* The type of the JSON value, will dictate what the
* internal type is set to:
*
* - null: (ignored, returns false)
Expand All @@ -834,9 +834,8 @@ bool QMJsonArray::from(int32_t index, const T &value)

/**
* @fn bool QMJsonArray::from(int32_t index, const QMPointer<QMJsonValue> &value);
* Unwraps the JSON value at @e index and sets the internal type. Depending
* on what type the JSON value is, will dictate what the internal type
* is set to:
* Unwraps the JSON value at @e index and sets the internal type. The type of
* the JSON value, will dictate what the internal type is set to:
*
* - null: if both values are NULL, returns true, otherwise returns false
* - bool: @ref fromBool
Expand Down
17 changes: 8 additions & 9 deletions include/qmjsonobject.h
Expand Up @@ -588,7 +588,7 @@ bool QMJsonObject::from(const QString &key, const T &value)
/**
* @fn bool QMJsonObject::toBool(const QString &key) const
* Unwraps the JSON value at @e key and returns the internal type.
* Depending on what type the JSON value is, will dictate what is returned:
* The type of the JSON value, will dictate what is returned:
*
* - null: false
* - bool: true / falue (native)
Expand All @@ -600,7 +600,7 @@ bool QMJsonObject::from(const QString &key, const T &value)
/**
* @fn double QMJsonObject::toDouble(const QString &key) const
* Unwraps the JSON value at @e key and returns the internal type.
* Depending on what type the JSON value is, will dictate what is returned:
* The type of the JSON value, will dictate what is returned:
*
* - null: 0
* - bool: false = 0, true = 1
Expand All @@ -612,7 +612,7 @@ bool QMJsonObject::from(const QString &key, const T &value)
/**
* @fn QString QMJsonObject::toString(const QString &key) const
* Unwraps the JSON value at @e key and returns the internal type.
* Depending on what type the JSON value is, will dictate what is returned:
* The type of the JSON value, will dictate what is returned:
*
* - null: "null"
* - bool: "true" if true, "false" if false
Expand Down Expand Up @@ -684,7 +684,7 @@ bool QMJsonObject::from(const QString &key, const T &value)
/**
* @fn bool QMJsonObject::fromBool(const QString &key, bool value)
* Unwraps the JSON value at @e key and sets the internal type.
* Depending on what type the JSON value is, will dictate what the internal
* The type of the JSON value, will dictate what the internal
* type is set to:
*
* - null: (ignored, returns false)
Expand All @@ -697,7 +697,7 @@ bool QMJsonObject::from(const QString &key, const T &value)
/**
* @fn bool QMJsonObject::fromDouble(const QString &key, double value)
* Unwraps the JSON value at @e key and sets the internal type.
* Depending on what type the JSON value is, will dictate what the internal
* The type of the JSON value, will dictate what the internal
* type is set to:
*
* - null: (ignored, returns false)
Expand All @@ -710,7 +710,7 @@ bool QMJsonObject::from(const QString &key, const T &value)
/**
* @fn bool QMJsonObject::fromString(const QString &key, const QString &value);
* Unwraps the JSON value at @e key and sets the internal type.
* Depending on what type the JSON value is, will dictate what the
* The type of the JSON value, will dictate what the
* internal type is set to:
*
* - null: (ignored, returns false)
Expand All @@ -736,9 +736,8 @@ bool QMJsonObject::from(const QString &key, const T &value)

/**
* @fn bool QMJsonObject::from(const QString &key, const QMPointer<QMJsonValue> &value);
* Unwraps the JSON value at @e key and sets the internal type. Depending
* on what type the JSON value is, will dictate what the internal type
* is set to:
* Unwraps the JSON value at @e key and sets the internal type. The type of the
* JSON value, will dictate what the internal type is set to:
*
* - null: if both values are NULL, returns true, otherwise returns false
* - bool: @ref fromBool
Expand Down
28 changes: 14 additions & 14 deletions include/qmjsonvalue.h
Expand Up @@ -650,8 +650,8 @@ bool QMJsonValue::set(const T &value)

/**
* @fn bool QMJsonValue::toBool(void) const
* Unwraps the JSON value and returns the internal type. Depending on what
* type the JSON value is, will dictate what is returned:
* Unwraps the JSON value and returns the internal type. The type of the JSON
* value, will dictate what is returned:
*
* - null: false
* - bool: true / falue (native)
Expand All @@ -662,8 +662,8 @@ bool QMJsonValue::set(const T &value)

/**
* @fn double QMJsonValue::toDouble(void) const
* Unwraps the JSON value and returns the internal type. Depending on what
* type the JSON value is, will dictate what is returned:
* Unwraps the JSON value and returns the internal type. The type of the JSON
* value, will dictate what is returned:
*
* - null: 0
* - bool: false = 0, true = 1
Expand All @@ -674,8 +674,8 @@ bool QMJsonValue::set(const T &value)

/**
* @fn QString QMJsonValue::toString(void) const
* Unwraps the JSON value and returns the internal type. Depending on what
* type the JSON value is, will dictate what is returned:
* Unwraps the JSON value and returns the internal type. The type of the JSON
* value, will dictate what is returned:
*
* - null: "null"
* - bool: "true" if true, "false" if false
Expand Down Expand Up @@ -745,8 +745,8 @@ bool QMJsonValue::set(const T &value)

/**
* @fn bool QMJsonValue::fromBool(bool value)
* Unwraps the JSON value and sets the internal type. Depending on what
* type the JSON value is, will dictate what the internal type is set to:
* Unwraps the JSON value and sets the internal type. The type of the JSON value,
* will dictate what the internal type is set to:
*
* - null: (ignored, returns false)
* - bool: true / falue (native)
Expand All @@ -757,8 +757,8 @@ bool QMJsonValue::set(const T &value)

/**
* @fn bool QMJsonValue::fromDouble(double value)
* Unwraps the JSON value and sets the internal type. Depending on what
* type the JSON value is, will dictate what the internal type is set to:
* Unwraps the JSON value and sets the internal type. The type of the JSON value,
* will dictate what the internal type is set to:
*
* - null: (ignored, returns false)
* - bool: false if 0, true otherwise
Expand All @@ -769,8 +769,8 @@ bool QMJsonValue::set(const T &value)

/**
* @fn bool QMJsonValue::fromString(const QString &value);
* Unwraps the JSON value and sets the internal type. Depending on what
* type the JSON value is, will dictate what the internal type is set to:
* Unwraps the JSON value and sets the internal type. The type of the JSON value,
* will dictate what the internal type is set to:
*
* - null: (ignored, returns false)
* - bool: true if "true", false otherwise
Expand All @@ -793,8 +793,8 @@ bool QMJsonValue::set(const T &value)

/**
* @fn bool QMJsonValue::from(const QMPointer<QMJsonValue> &value);
* Unwraps the JSON value and sets the interanl type. Depending on what
* type the JSON value is, will dictate what the internal type is set to:
* Unwraps the JSON value and sets the interanl type. The type of the JSON value,
* will dictate what the internal type is set to:
*
* - null: if both values are NULL, returns true, otherwise returns false
* - bool: @ref fromBool
Expand Down

0 comments on commit 32668a8

Please sign in to comment.