doc fixes

This commit is contained in:
Guenter Obiltschnig
2016-08-28 17:17:56 +02:00
parent f89bea4411
commit 08e4f6af17
5 changed files with 11 additions and 11 deletions

View File

@@ -47,7 +47,7 @@ class JSON_API Array
/// Var result = parser.parse(json); /// Var result = parser.parse(json);
/// Array::Ptr arr = result.extract<Array::Ptr>(); /// Array::Ptr arr = result.extract<Array::Ptr>();
/// Object::Ptr object = arr->getObject(0); // object == {\"test\" : 0} /// Object::Ptr object = arr->getObject(0); // object == {\"test\" : 0}
/// int i = object->getValue<int>("test"); // i == 0; /// int i = object->getElement<int>("test"); // i == 0;
/// Object::Ptr subObject = *arr->getObject(1); // subObject == {\"test\" : 0} /// Object::Ptr subObject = *arr->getObject(1); // subObject == {\"test\" : 0}
/// Array subArr::Ptr = subObject->getArray("test1"); // subArr == [1, 2, 3] /// Array subArr::Ptr = subObject->getArray("test1"); // subArr == [1, 2, 3]
/// i = result = subArr->get(0); // i == 1; /// i = result = subArr->get(0); // i == 1;

View File

@@ -67,7 +67,7 @@ public:
typedef ValueMap::iterator Iterator; typedef ValueMap::iterator Iterator;
typedef ValueMap::const_iterator ConstIterator; typedef ValueMap::const_iterator ConstIterator;
Object(bool preserveInsertionOrder = false); explicit Object(bool preserveInsertionOrder = false);
/// Default constructor. If preserveInsertionOrder, object /// Default constructor. If preserveInsertionOrder, object
/// will preserve the items insertion order. Otherwise, items /// will preserve the items insertion order. Otherwise, items
/// will be sorted by keys. /// will be sorted by keys.

View File

@@ -53,14 +53,14 @@ public:
void startObject(); void startObject();
/// The parser has read a '{'; a new object is started. /// The parser has read a '{'; a new object is started.
/// If indent is greater than zero, a newline will be apended. /// If indent is greater than zero, a newline will be appended.
void endObject(); void endObject();
/// The parser has read a '}'; the object is closed. /// The parser has read a '}'; the object is closed.
void startArray(); void startArray();
/// The parser has read a [; a new array will be started. /// The parser has read a [; a new array will be started.
/// If indent is greater than zero, a newline will be apended. /// If indent is greater than zero, a newline will be appended.
void endArray(); void endArray();
/// The parser has read a ]; the array is closed. /// The parser has read a ]; the array is closed.
@@ -89,7 +89,7 @@ public:
#endif #endif
void value(const std::string& value); void value(const std::string& value);
/// A string value is read; it will be fromatted and written to the output. /// A string value is read; it will be formatted and written to the output.
void value(double d); void value(double d);
/// A double value is read; it will be written to the output. /// A double value is read; it will be written to the output.

View File

@@ -38,15 +38,15 @@ public:
/// This is just a "shortcut" to stringify(any, out) with name indicating the function effect. /// This is just a "shortcut" to stringify(any, out) with name indicating the function effect.
static void stringify(const Dynamic::Var& any, bool preserveInsertionOrder, std::ostream& out, unsigned int indent = 0); static void stringify(const Dynamic::Var& any, bool preserveInsertionOrder, std::ostream& out, unsigned int indent = 0);
/// Writes a String representation of the value to the output stream while preserving the insertion order. /// Writes a string representation of the value to the output stream while optionally preserving the insertion order.
/// When indent is 0, the generated string will be created as small as possible (condensed). /// When indent is 0, the generated string will be created as small as possible (condensed).
/// When preserveInsertionOrder is true, the original string object members order will be preserved. /// When preserveInsertionOrder is true, the original order of object members will be preserved.
/// This is a "shortcut" to stringify(any, out, indent, -1, preserveInsertionOrder). /// This is a "shortcut" to stringify(any, out, indent, -1, preserveInsertionOrder).
static void stringify(const Dynamic::Var& any, std::ostream& out, unsigned int indent = 0, int step = -1, bool preserveInsertionOrder = false); static void stringify(const Dynamic::Var& any, std::ostream& out, unsigned int indent = 0, int step = -1, bool preserveInsertionOrder = false);
/// Writes a String representation of the value to the output stream. /// Writes a string representation of the value to the output stream.
/// When indent is 0, the String will be created as small as possible. /// When indent is 0, the string will be created as small as possible.
/// When preserveInsertionOrder is true, the original string object members order will be preserved; /// When preserveInsertionOrder is true, the original order of object members will be preserved;
/// otherwise, object members are sorted by their names. /// otherwise, object members are sorted by their names.
static void formatString(const std::string& value, std::ostream& out); static void formatString(const std::string& value, std::ostream& out);

View File

@@ -69,7 +69,7 @@ class JSON_API Template
/// ///
/// <? ifexist query ?> <? else ?> <? endif ?> /// <? ifexist query ?> <? else ?> <? endif ?>
/// ---- /// ----
/// This can be used to check the existance of the value. /// This can be used to check the existence of the value.
/// Use this for example when a zero value is ok (which returns false for <? if ?>. /// Use this for example when a zero value is ok (which returns false for <? if ?>.
/// ///
/// <? for variable query ?> <? endfor ?> /// <? for variable query ?> <? endfor ?>