FGCOM/jansson
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Remove all "Added in version 1.x" info from documentation

Browse Source 
As 2.0 will be backwards incompatible anyway, there's no need to
record which features were new in which 1.x releases.
This commit is contained in:
Petri Lehtinen 2010-10-14 21:05:22 +03:00
parent 23dd078c8d
commit 1acd1a7b56
1 changed files with 0 additions and 56 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
doc/apiref.rst
View File

@ -264,8 +264,6 @@ U+10FFFF are allowed.
UTF-8. Use this function only if you are certain that this really UTF-8. Use this function only if you are certain that this really
is the case (e.g. you have already checked it by other means). is the case (e.g. you have already checked it by other means).
.. versionadded:: 1.2
.. function:: const char *json_string_value(const json_t *string) .. function:: const char *json_string_value(const json_t *string)
Returns the associated value of *string* as a null terminated UTF-8 Returns the associated value of *string* as a null terminated UTF-8
@ -277,8 +275,6 @@ U+10FFFF are allowed.
valid UTF-8 encoded Unicode string. Returns 0 on success and -1 on valid UTF-8 encoded Unicode string. Returns 0 on success and -1 on
error. error.
.. versionadded:: 1.1
.. function:: int json_string_set_nocheck(const json_t *string, const char *value) .. function:: int json_string_set_nocheck(const json_t *string, const char *value)
Like :func:`json_string_set`, but doesn't check that *value* is Like :func:`json_string_set`, but doesn't check that *value* is
@ -286,8 +282,6 @@ U+10FFFF are allowed.
really is the case (e.g. you have already checked it by other really is the case (e.g. you have already checked it by other
means). means).
.. versionadded:: 1.2
Number Number
====== ======
@ -353,8 +347,6 @@ information, see :ref:`rfc-conformance`.
Sets the associated value of *integer* to *value*. Returns 0 on Sets the associated value of *integer* to *value*. Returns 0 on
success and -1 if *integer* is not a JSON integer. success and -1 if *integer* is not a JSON integer.
.. versionadded:: 1.1
.. function:: json_t *json_real(double value) .. function:: json_t *json_real(double value)
.. refcounting:: new .. refcounting:: new
@ -371,8 +363,6 @@ information, see :ref:`rfc-conformance`.
Sets the associated value of *real* to *value*. Returns 0 on Sets the associated value of *real* to *value*. Returns 0 on
success and -1 if *real* is not a JSON real. success and -1 if *real* is not a JSON real.
.. versionadded:: 1.1
In addition to the functions above, there's a common query function In addition to the functions above, there's a common query function
for integers and reals: for integers and reals:
@ -423,8 +413,6 @@ A JSON array is an ordered collection of other JSON values.
This is useful when *value* is newly created and not used after This is useful when *value* is newly created and not used after
the call. the call.
.. versionadded:: 1.1
.. function:: int json_array_append(json_t *array, json_t *value) .. function:: int json_array_append(json_t *array, json_t *value)
Appends *value* to the end of *array*, growing the size of *array* Appends *value* to the end of *array*, growing the size of *array*
@ -436,46 +424,34 @@ A JSON array is an ordered collection of other JSON values.
*value*. This is useful when *value* is newly created and not used *value*. This is useful when *value* is newly created and not used
after the call. after the call.
.. versionadded:: 1.1
.. function:: int json_array_insert(json_t *array, size_t index, json_t *value) .. function:: int json_array_insert(json_t *array, size_t index, json_t *value)
Inserts *value* to *array* at position *index*, shifting the Inserts *value* to *array* at position *index*, shifting the
elements at *index* and after it one position towards the end of elements at *index* and after it one position towards the end of
the array. Returns 0 on success and -1 on error. the array. Returns 0 on success and -1 on error.
.. versionadded:: 1.1
.. function:: int json_array_insert_new(json_t *array, size_t index, json_t *value) .. function:: int json_array_insert_new(json_t *array, size_t index, json_t *value)
Like :func:`json_array_insert()` but steals the reference to Like :func:`json_array_insert()` but steals the reference to
*value*. This is useful when *value* is newly created and not used *value*. This is useful when *value* is newly created and not used
after the call. after the call.
.. versionadded:: 1.1
.. function:: int json_array_remove(json_t *array, size_t index) .. function:: int json_array_remove(json_t *array, size_t index)
Removes the element in *array* at position *index*, shifting the Removes the element in *array* at position *index*, shifting the
elements after *index* one position towards the start of the array. elements after *index* one position towards the start of the array.
Returns 0 on success and -1 on error. Returns 0 on success and -1 on error.
.. versionadded:: 1.1
.. function:: int json_array_clear(json_t *array) .. function:: int json_array_clear(json_t *array)
Removes all elements from *array*. Returns 0 on sucess and -1 on Removes all elements from *array*. Returns 0 on sucess and -1 on
error. error.
.. versionadded:: 1.1
.. function:: int json_array_extend(json_t *array, json_t *other_array) .. function:: int json_array_extend(json_t *array, json_t *other_array)
Appends all elements in *other_array* to the end of *array*. Appends all elements in *other_array* to the end of *array*.
Returns 0 on success and -1 on error. Returns 0 on success and -1 on error.
.. versionadded:: 1.1
Object Object
====== ======
@ -495,8 +471,6 @@ Unicode string and the value is any JSON value.
Returns the number of elements in *object*, or 0 if *object* is not Returns the number of elements in *object*, or 0 if *object* is not
a JSON object. a JSON object.
.. versionadded:: 1.1
.. function:: json_t *json_object_get(const json_t *object, const char *key) .. function:: json_t *json_object_get(const json_t *object, const char *key)
.. refcounting:: borrow .. refcounting:: borrow
@ -518,16 +492,12 @@ Unicode string and the value is any JSON value.
really is the case (e.g. you have already checked it by other really is the case (e.g. you have already checked it by other
means). means).
.. versionadded:: 1.2
.. function:: int json_object_set_new(json_t *object, const char *key, json_t *value) .. function:: int json_object_set_new(json_t *object, const char *key, json_t *value)
Like :func:`json_object_set()` but steals the reference to Like :func:`json_object_set()` but steals the reference to
*value*. This is useful when *value* is newly created and not used *value*. This is useful when *value* is newly created and not used
after the call. after the call.
.. versionadded:: 1.1
.. function:: int json_object_set_new_nocheck(json_t *object, const char *key, json_t *value) .. function:: int json_object_set_new_nocheck(json_t *object, const char *key, json_t *value)
Like :func:`json_object_set_new`, but doesn't check that *key* is Like :func:`json_object_set_new`, but doesn't check that *key* is
@ -535,8 +505,6 @@ Unicode string and the value is any JSON value.
really is the case (e.g. you have already checked it by other really is the case (e.g. you have already checked it by other
means). means).
.. versionadded:: 1.2
.. function:: int json_object_del(json_t *object, const char *key) .. function:: int json_object_del(json_t *object, const char *key)
Delete *key* from *object* if it exists. Returns 0 on success, or Delete *key* from *object* if it exists. Returns 0 on success, or
@ -548,15 +516,11 @@ Unicode string and the value is any JSON value.
Remove all elements from *object*. Returns 0 on success and -1 if Remove all elements from *object*. Returns 0 on success and -1 if
*object* is not a JSON object. *object* is not a JSON object.
.. versionadded:: 1.1
.. function:: int json_object_update(json_t *object, json_t *other) .. function:: int json_object_update(json_t *object, json_t *other)
Update *object* with the key-value pairs from *other*, overwriting Update *object* with the key-value pairs from *other*, overwriting
existing keys. Returns 0 on success or -1 on error. existing keys. Returns 0 on success or -1 on error.
.. versionadded:: 1.1
The following functions implement an iteration protocol for objects: The following functions implement an iteration protocol for objects:
@ -573,8 +537,6 @@ The following functions implement an iteration protocol for objects:
*object* only yields all key-value pairs of the object if *key* *object* only yields all key-value pairs of the object if *key*
happens to be the first key in the underlying hash table. happens to be the first key in the underlying hash table.
.. versionadded:: 1.3
.. function:: void *json_object_iter_next(json_t *object, void *iter) .. function:: void *json_object_iter_next(json_t *object, void *iter)
Returns an iterator pointing to the next key-value pair in *object* Returns an iterator pointing to the next key-value pair in *object*
@ -596,16 +558,12 @@ The following functions implement an iteration protocol for objects:
Set the value of the key-value pair in *object*, that is pointed to Set the value of the key-value pair in *object*, that is pointed to
by *iter*, to *value*. by *iter*, to *value*.
.. versionadded:: 1.3
.. function:: int json_object_iter_set_new(json_t *object, void *iter, json_t *value) .. function:: int json_object_iter_set_new(json_t *object, void *iter, json_t *value)
Like :func:`json_object_iter_set()`, but steals the reference to Like :func:`json_object_iter_set()`, but steals the reference to
*value*. This is useful when *value* is newly created and not used *value*. This is useful when *value* is newly created and not used
after the call. after the call.
.. versionadded:: 1.3
The iteration protocol can be used for example as follows:: The iteration protocol can be used for example as follows::
/* obj is a JSON object */ /* obj is a JSON object */
@ -651,30 +609,22 @@ can be ORed together to obtain *flags*.
and values to ``":"``. Without this flag, the corresponding and values to ``":"``. Without this flag, the corresponding
separators are ``", "`` and ``": "`` for more readable output. separators are ``", "`` and ``": "`` for more readable output.
.. versionadded:: 1.2
``JSON_ENSURE_ASCII`` ``JSON_ENSURE_ASCII``
If this flag is used, the output is guaranteed to consist only of If this flag is used, the output is guaranteed to consist only of
ASCII characters. This is achived by escaping all Unicode ASCII characters. This is achived by escaping all Unicode
characters outside the ASCII range. characters outside the ASCII range.
.. versionadded:: 1.2
``JSON_SORT_KEYS`` ``JSON_SORT_KEYS``
If this flag is used, all the objects in output are sorted by key. If this flag is used, all the objects in output are sorted by key.
This is useful e.g. if two JSON texts are diffed or visually This is useful e.g. if two JSON texts are diffed or visually
compared. compared.
.. versionadded:: 1.2
``JSON_PRESERVE_ORDER`` ``JSON_PRESERVE_ORDER``
If this flag is used, object keys in the output are sorted into the If this flag is used, object keys in the output are sorted into the
same order in which they were first inserted to the object. For same order in which they were first inserted to the object. For
example, decoding a JSON text and then encoding with this flag example, decoding a JSON text and then encoding with this flag
preserves the order of object keys. preserves the order of object keys.
.. versionadded:: 1.3
The following functions perform the actual JSON encoding. The result The following functions perform the actual JSON encoding. The result
is in UTF-8. is in UTF-8.
@ -842,8 +792,6 @@ equal.
Returns 0 if they are inequal or one or both of the pointers are Returns 0 if they are inequal or one or both of the pointers are
*NULL*. *NULL*.
.. versionadded:: 1.2
Copying Copying
======= =======
@ -866,12 +814,8 @@ copied in a recursive fashion.
Returns a shallow copy of *value*, or *NULL* on error. Returns a shallow copy of *value*, or *NULL* on error.
.. versionadded:: 1.2
.. function:: json_t *json_deep_copy(json_t *value) .. function:: json_t *json_deep_copy(json_t *value)
.. refcounting:: new .. refcounting:: new
Returns a deep copy of *value*, or *NULL* on error. Returns a deep copy of *value*, or *NULL* on error.
.. versionadded:: 1.2