diff options
Diffstat (limited to 'include')
| -rw-r--r--[-rwxr-xr-x] | include/SLP_bundle_PG.h | 4 | ||||
| -rw-r--r--[-rwxr-xr-x] | include/bundle.h | 128 | ||||
| -rw-r--r--[-rwxr-xr-x] | include/bundle_internal.h | 255 |
3 files changed, 194 insertions, 193 deletions
diff --git a/include/SLP_bundle_PG.h b/include/SLP_bundle_PG.h index 5106081..a6b316f 100755..100644 --- a/include/SLP_bundle_PG.h +++ b/include/SLP_bundle_PG.h @@ -18,14 +18,14 @@ * * @ingroup SLP_PG * @defgroup bundle_PG Bundle - * @brief A simple string-based dictionary ADT + * @brief A simple string-based dictionary ADT. * @{ <h1 class="pg">Introduction</h1> <p> Bundle is a string based Dictionary ADT. A dictionary is an ordered or unordered list of key element pairs, where keys are used to locate elements in the list. </p><br/> -<p> ADT(Abstract data type) An Abstract Data type is defined as a mathematical model of the data objects that make up a data type as well +<p> ADT (Abstract data type) An Abstract Data type is defined as a mathematical model of the data objects that make up a data type as well as the functions that operate on these objects.</p> <h1 class="pg">Features</h1> diff --git a/include/bundle.h b/include/bundle.h index 9ace22d..1cb307a 100755..100644 --- a/include/bundle.h +++ b/include/bundle.h @@ -118,10 +118,10 @@ typedef void (*bundle_iterator_t) (const char *key, const int type, const bundle * @brief Creates a bundle object. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section. - * @return The bundle object - * @retval @c NULL - Failure - * @exception BUNDLE_ERROR_NONE Success - * @exception BUNDLE_ERROR_OUT_OF_MEMORY Out of memory + * @return The bundle object, + * @c NULL - Failure + * @exception #BUNDLE_ERROR_NONE Success + * @exception #BUNDLE_ERROR_OUT_OF_MEMORY Out of memory * @see bundle_free() * * @code @@ -138,8 +138,8 @@ API bundle *bundle_create(void); * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @param[in] b The bundle object to be freed * @return The operation result - * @retval BUNDLE_ERROR_NONE Success - * @retval BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BUNDLE_ERROR_NONE Success + * @retval #BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter * @pre @a b must be a valid bundle object. * @see bundle_create() * @@ -160,10 +160,10 @@ API int bundle_free(bundle *b); * @param[in] str_array The string type value; if @c NULL, an empty array is created; you can change an item with * @param[in] len The length of the array * @return The operation result - * @retval BUNDLE_ERROR_NONE Success - * @retval BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter - * @retval BUNDLE_ERROR_KEY_EXISTS Key already exists - * @retval BUNDLE_ERROR_OUT_OF_MEMORY Out of memory + * @retval #BUNDLE_ERROR_NONE Success + * @retval #BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BUNDLE_ERROR_KEY_EXISTS Key already exists + * @retval #BUNDLE_ERROR_OUT_OF_MEMORY Out of memory * @pre @a b must be a valid bundle object. * @see bundle_get_str_array() * @@ -184,9 +184,9 @@ API int bundle_add_str_array(bundle *b, const char *key, const char **str_array, * @param[in] b The bundle object * @param[in] key The given key * @return The operation result - * @retval BUNDLE_ERROR_NONE Success - * @retval BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter - * @retval BUNDLE_ERROR_KEY_NOT_AVAILABLE Key not available + * @retval #BUNDLE_ERROR_NONE Success + * @retval #BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BUNDLE_ERROR_KEY_NOT_AVAILABLE Key not available * @pre @a b must be a valid bundle object. * * @code @@ -209,11 +209,11 @@ API int bundle_del(bundle *b, const char *key); * @param[in] b The bundle object * @param[in] key The key * @param[out] len The array length - * @return The pointer to the array of strings - * @retval @c NULL - Key not found - * @exception BUNDLE_ERROR_NONE Success - * @exception BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter - * @exception BUNDLE_ERROR_KEY_NOT_AVAILABLE Key not available + * @return The pointer to the array of strings, + * @c NULL - Key not found + * @exception #BUNDLE_ERROR_NONE Success + * @exception #BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter + * @exception #BUNDLE_ERROR_KEY_NOT_AVAILABLE Key not available * @pre @a b must be a valid bundle object. * @see bundle_add_str_array() * @@ -263,9 +263,9 @@ API int bundle_get_count(bundle *b); * @param[in] b A bundle * @param[in] key A key in the bundle * @return The type of a key in @a b - * @exception BUNDLE_ERROR_NONE Success - * @exception BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter - * @exception BUNDLE_ERROR_KEY_NOT_AVAILABLE Key not available + * @exception #BUNDLE_ERROR_NONE Success + * @exception #BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter + * @exception #BUNDLE_ERROR_KEY_NOT_AVAILABLE Key not available * @pre @a b must be a valid bundle object. * @see bundle_type_t */ @@ -276,11 +276,12 @@ API int bundle_get_type(bundle *b, const char *key); * @brief Duplicates a given bundle object. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section. + * The returned value should be released using bundle_free(). * @param[in] b_from The bundle object to be duplicated - * @return The new bundle object - * @retval @c NULL - Failure - * @exception BUNDLE_ERROR_NONE Success - * @exception BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter + * @return The new bundle object, + * @c NULL - Failure + * @exception #BUNDLE_ERROR_NONE Success + * @exception #BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter * @pre @a b must be a valid bundle object. * * @code @@ -305,8 +306,8 @@ API bundle *bundle_dup(bundle *b_from); * @param[in] b The bundle object * @param[in] iter The iteration callback function * @param[in] user_data The data for the callback function - * @exception BUNDLE_ERROR_NONE Success - * @exception BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter + * @exception #BUNDLE_ERROR_NONE Success + * @exception #BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter * @pre @a b must be a valid bundle object. * @see bundle_keyval_get_type() * @see bundle_keyval_type_is_array() @@ -357,10 +358,10 @@ API void bundle_foreach(bundle *b, bundle_iterator_t iter, void *user_data); * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section. * @param[in] kv A bundle_keyval_t object - * @return The type of @a kv - * @retval @c -1 - Failure - * @exception BUNDLE_ERROR_NONE Success - * @exception BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter + * @return The type of @a kv, + * @c -1 - Failure + * @exception #BUNDLE_ERROR_NONE Success + * @exception #BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter * @pre @a kv must be a valid bundle_keyval_t object. * @see bundle_foreach() */ @@ -373,10 +374,10 @@ API int bundle_keyval_get_type(bundle_keyval_t *kv); * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section. * @param[in] kv A bundle_keyval_t object * @return The operation result - * @retval @c 1 - @a kv is an array - * @retval @c 0 - @a kv is not an array - * @exception BUNDLE_ERROR_NONE Success - * @exception BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter + * @c 1 - @a kv is an array + * @c 0 - @a kv is not an array + * @exception #BUNDLE_ERROR_NONE Success + * @exception #BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter * @pre @a kv must be a valid bundle_keyval_t object. * @see bundle_foreach() */ @@ -391,8 +392,8 @@ API int bundle_keyval_type_is_array(bundle_keyval_t *kv); * @param[out] val The value * @param[out] size The size of @a val * @return The operation result - * @retval BUNDLE_ERROR_NONE Success - * @retval BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BUNDLE_ERROR_NONE Success + * @retval #BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter * @pre @a kv must be a valid bundle_keyval_t object. * @post @a val and @a size are set. * @see bundle_foreach() @@ -408,10 +409,10 @@ API int bundle_keyval_get_basic_val(bundle_keyval_t *kv, void **val, size_t *siz * @param[out] array_len The length of @a array_val * @param[out] array_element_size The array of size of each array element * @return The operation result - * @retval BUNDLE_ERROR_NONE Success - * @retval BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BUNDLE_ERROR_NONE Success + * @retval #BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter * @pre @a kv must be a valid bundle_keyval_t object. - * @post @a array_val, @a array_len, @a array_item_size are set. + * @post @a array_val, @a array_len, @a array_element_size are set. * @see bundle_foreach() */ API int bundle_keyval_get_array_val(bundle_keyval_t *kv, void ***array_val, unsigned int *array_len, size_t **array_element_size); @@ -425,8 +426,8 @@ API int bundle_keyval_get_array_val(bundle_keyval_t *kv, void ***array_val, unsi * @a r MUST BE FREED by free(r) * @param[out] len The size of @a r (in bytes) * @return The size of the raw data - * @retval BUNDLE_ERROR_NONE Success - * @retval BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BUNDLE_ERROR_NONE Success + * @retval #BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter * @pre @a b must be a valid bundle object. * * @code @@ -447,13 +448,14 @@ API int bundle_encode(bundle *b, bundle_raw **r, int *len); * @brief Deserializes bundle_raw and gets the bundle object. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section. + * The returned value should be released using bundle_free(). * @param[in] r The bundle_raw data to be converted to bundle object * @param[in] len The size of @a r - * @return The bundle object - * @retval @c NULL - Failure - * @exception BUNDLE_ERROR_NONE Success - * @exception BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter - * @pre @a b must be a valid bundle object. + * @return The bundle object, + * @c NULL - Failure + * @exception #BUNDLE_ERROR_NONE Success + * @exception #BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter + * @pre @a r must be a valid bundle object. * * @code #include <bundle.h> @@ -482,10 +484,10 @@ API bundle *bundle_decode(const bundle_raw *r, const int len); * @param[in] key The key * @param[in] str The string type value * @return The operation result - * @retval BUNDLE_ERROR_NONE Success - * @retval BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter - * @retval BUNDLE_ERROR_KEY_EXISTS Key already exists - * @retval BUNDLE_ERROR_OUT_OF_MEMORY Out of memory + * @retval #BUNDLE_ERROR_NONE Success + * @retval #BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BUNDLE_ERROR_KEY_EXISTS Key already exists + * @retval #BUNDLE_ERROR_OUT_OF_MEMORY Out of memory * @pre @a b must be a valid bundle object. * @see bundle_get_str() * @code @@ -508,10 +510,10 @@ API int bundle_add_str(bundle *b, const char *key, const char *str); * @param[in] bytes The byte sequence * @param[in] size The byte sequence size in bytes * @return The operation result - * @retval BUNDLE_ERROR_NONE Success - * @retval BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter - * @retval BUNDLE_ERROR_KEY_EXISTS Key already exists - * @retval BUNDLE_ERROR_OUT_OF_MEMORY Out of memory + * @retval #BUNDLE_ERROR_NONE Success + * @retval #BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BUNDLE_ERROR_KEY_EXISTS Key already exists + * @retval #BUNDLE_ERROR_OUT_OF_MEMORY Out of memory * @pre @a b must be a valid bundle object. * @see bundle_get_byte() * @@ -537,9 +539,9 @@ API int bundle_add_byte(bundle *b, const char *key, const void *bytes, const siz * @param[in] key The key * @param[out] str The returned value * @return The operation result - * @retval BUNDLE_ERROR_NONE Success - * @retval BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter - * @retval BUNDLE_ERROR_KEY_NOT_AVAILABLE Key not available + * @retval #BUNDLE_ERROR_NONE Success + * @retval #BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BUNDLE_ERROR_KEY_NOT_AVAILABLE Key not available * @pre @a b must be a valid bundle object. * @see bundle_add_str() * @@ -561,15 +563,15 @@ API int bundle_get_str(bundle *b, const char *key, char **str); /** * @brief Gets the byte sequence with the given key. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * @remarks You must not free @a byte. + * @remarks You must not free @a bytes. * @param[in] b The bundle object * @param[in] key The key * @param[out] bytes The byte sequence * @param[out] size The byte sequence size in bytes * @return The operation result - * @retval BUNDLE_ERROR_NONE Success - * @retval BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter - * @retval BUNDLE_ERROR_KEY_NOT_AVAILABLE Key not available + * @retval #BUNDLE_ERROR_NONE Success + * @retval #BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BUNDLE_ERROR_KEY_NOT_AVAILABLE Key not available * @pre @a b must be a valid bundle object. * @see bundle_add_byte() * @@ -615,8 +617,8 @@ API int bundle_add_byte_array(bundle *b, const char *key, const unsigned int len /** * @brief Sets an element of an array of byte sequences. - * @since_tizen 5.5 * @details The array will contain its own copy of the added value. + * @since_tizen 5.5 * * @param[in] b The bundle object * @param[in] key The key diff --git a/include/bundle_internal.h b/include/bundle_internal.h index a64d7d9..90e76b6 100755..100644 --- a/include/bundle_internal.h +++ b/include/bundle_internal.h @@ -44,16 +44,16 @@ typedef void (*bundle_iterate_cb_t) (const char *key, const char *val, void *dat /** * @brief Adds a string type key-value pair into a given bundle. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * @param[in] b The bundle object - * @param[in] key The key - * @param[in] val The value - * @return The operation result - * @retval BUNDLE_ERROR_NONE Success - * @retval BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter - * @retval BUNDLE_ERROR_KEY_EXISTS Key already exists - * @retval BUNDLE_ERROR_OUT_OF_MEMORY Out of memory - * @pre @a b must be a valid bundle object. - * @see bundle_add_str() + * @param[in] b The bundle object + * @param[in] key The key + * @param[in] val The value + * @return The operation result + * @retval #BUNDLE_ERROR_NONE Success + * @retval #BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BUNDLE_ERROR_KEY_EXISTS Key already exists + * @retval #BUNDLE_ERROR_OUT_OF_MEMORY Out of memory + * @pre @a b must be a valid bundle object. + * @see bundle_add_str() @code #include <bundle_internal.h> bundle *b = bundle_create(); // Create new bundle object @@ -67,17 +67,17 @@ API int bundle_add(bundle *b, const char *key, const char *val); /** * @brief Gets a value with a given key. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * @remarks You MUST NOT free or modify the returned string! + * @remarks You MUST NOT free or modify the returned string! * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section. - * @param[in] b The bundle object - * @param[in] key The key - * @return The pointer for the value string - * @retval @c NULL - Key not found - * @exception BUNDLE_ERROR_NONE Success - * @exception BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter - * @exception BUNDLE_ERROR_KEY_NOT_AVAILABLE Key not available - * @pre @a b must be a valid bundle object. - * @see bundle_get_str() + * @param[in] b The bundle object + * @param[in] key The key + * @return The pointer for the value string + * @retval @c NULL - Key not found + * @exception #BUNDLE_ERROR_NONE Success + * @exception #BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter + * @exception #BUNDLE_ERROR_KEY_NOT_AVAILABLE Key not available + * @pre @a b must be a valid bundle object. + * @see bundle_get_str() @code #include <bundle_internal.h> bundle *b = bundle_create(); // Create new bundle object @@ -95,13 +95,13 @@ API const char *bundle_get_val(bundle *b, const char *key); * @details (NOTE: Only BUNDLE_TYPE_STR type values come!) * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section. - * @remarks This function is obsolete and does not give values whose types are not BUNDLE_TYPE_STR. - * @param[in] b The bundle object - * @param[in] callback The iteration callback function - * @param[in] cb_data The data for callback function - * @exception BUNDLE_ERROR_NONE Success - * @exception BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter - * @pre @a b must be a valid bundle object. + * @remarks This function is obsolete and does not give values whose types are not BUNDLE_TYPE_STR. + * @param[in] b The bundle object + * @param[in] callback The iteration callback function + * @param[in] cb_data The data for callback function + * @exception #BUNDLE_ERROR_NONE Success + * @exception #BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter + * @pre @a b must be a valid bundle object. @code #include <stdio.h> #include <bundle_internal.h> @@ -114,7 +114,7 @@ API const char *bundle_get_val(bundle *b, const char *key); bundle_add_str(b, "k1", "v1"); // add a key-val pair bundle_add_str(b, "k2", "v2"); // add a key-val pair bundle_add_str(b, "k3", "v3"); // add a key-val pair - bundle_iterate(b, sample_cb, NULL); // iterate sample_cb() for each key/val + bundle_iterate(b, sample_cb, NULL); // iterate sample_cb() for each key/val return 0; } @endcode @@ -125,51 +125,51 @@ API void bundle_iterate(bundle *b, bundle_iterate_cb_t callback, void *cb_data); * @brief Determines whether the type of a key-value pair is measurable. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section. - * @param[in] kv A bundle_keyval_t object - * @return The operation result - * @retval @c 1 - @a kv is an measurable - * @retval @c 0 - @a kv is not an measurable - * @exception BUNDLE_ERROR_NONE Success - * @exception BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter - * @pre @a kv must be a valid bundle_keyval_t object. - * @see bundle_foreach() + * @param[in] kv A bundle_keyval_t object + * @return The operation result + * @retval @c 1 - @a kv is an measurable + * @retval @c 0 - @a kv is not an measurable + * @exception #BUNDLE_ERROR_NONE Success + * @exception #BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter + * @pre @a kv must be a valid bundle_keyval_t object. + * @see bundle_foreach() */ API int bundle_keyval_type_is_measurable(bundle_keyval_t *kv); /** - * @brief Duplicate key-value pair. + * @brief Duplicates key-value pair. * @since_tizen 5.5 - * @param[in] kv A bundle_keyval_t object - * @return The bundle object - * @retval @c NULL - Failure - * @pre @a kv must be a valid bundle_keyval_t object. + * @param[in] kv A bundle_keyval_t object + * @return The bundle object + * @retval @c NULL - Failure + * @pre @a kv must be a valid bundle_keyval_t object. */ API bundle_keyval_t *bundle_keyval_dup(const bundle_keyval_t *kv); /** * @brief Frees the encoded rawdata. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * @param[in] r The rawdata - * @return The operation result - * @retval BUNDLE_ERROR_NONE Success - * @retval BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter - * @pre @a r is a valid rawdata generated by bundle_encode(). - * @see bundle_encode() + * @param[in] r The rawdata + * @return The operation result + * @retval #BUNDLE_ERROR_NONE Success + * @retval #BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter + * @pre @a r is a valid rawdata generated by bundle_encode(). + * @see bundle_encode() */ API int bundle_free_encoded_rawdata(bundle_raw **r); /** * @brief Encodes a bundle to the bundle_raw format. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * @param[in] b The bundle object - * @param[out] r The returned bundle_raw data(byte data) - * @a r MUST BE FREED by free(r) - * @param[out] len The size of @a r (in bytes) - * @return The size of the raw data - * @retval BUNDLE_ERROR_NONE Success - * @retval BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter - * @retval BUNDLE_ERROR_OUT_OF_MEMORY Out of memory - * @pre @a b must be a valid bundle object. + * @param[in] b The bundle object + * @param[out] r The returned bundle_raw data(byte data) + * @a r MUST BE FREED by free(r) + * @param[out] len The size of @a r (in bytes) + * @return The size of the raw data + * @retval #BUNDLE_ERROR_NONE Success + * @retval #BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BUNDLE_ERROR_OUT_OF_MEMORY Out of memory + * @pre @a b must be a valid bundle object. @code #include <bundle_internal.h> bundle *b = bundle_create(); // Create new bundle object @@ -187,13 +187,13 @@ API int bundle_encode_raw(bundle *b, bundle_raw **r, int *len); * @brief Deserializes bundle_raw and gets a bundle object. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section. - * @param[in] r The bundle_raw data to be converted to a bundle object - * @param[in] len The size of @a r - * @return The bundle object - * @retval @c NULL - Failure - * @exception BUNDLE_ERROR_NONE Success - * @exception BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter - * @pre @a b must be a valid bundle object. + * @param[in] r The bundle_raw data to be converted to a bundle object + * @param[in] len The size of @a r + * @return The bundle object + * @retval @c NULL - Failure + * @exception #BUNDLE_ERROR_NONE Success + * @exception #BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter + * @pre @a r must be a valid bundle object. @code #include <bundle_internal.h> bundle *b = bundle_create(); // Create new bundle object @@ -217,18 +217,18 @@ API bundle *bundle_decode_raw(const bundle_raw *r, const int len); * @brief Exports bundle to @a argv. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section. - * @param[in] b The bundle object - * @param[out] argv The pointer of the string array; \n - * This array has NULL values for the first and last item; \n - * First NULL is for argv[0], and last NULL is a terminator for execv() \n - * @return The number of item in @a argv. This value is equal to the actual count of argv - 1. (Last NULL terminator is not counted.) - * @retval @c -1 - Failure - * @exception BUNDLE_ERROR_NONE Success - * @exception BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter - * @exception BUNDLE_ERROR_OUT_OF_MEMORY Out of memory - * @pre @a b is a valid bundle object. - * @post @a argv is a pointer of newly allocated memory. It must be freed. - * @see bundle_import_from_argv() + * @param[in] b The bundle object + * @param[out] argv The pointer of the string array; \n + * This array has NULL values for the first and last item; \n + * First NULL is for argv[0], and last NULL is a terminator for execv() \n + * @return The number of item in @a argv. This value is equal to the actual count of argv - 1. (Last NULL terminator is not counted.) + * @retval @c -1 - Failure + * @exception #BUNDLE_ERROR_NONE Success + * @exception #BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter + * @exception #BUNDLE_ERROR_OUT_OF_MEMORY Out of memory + * @pre @a b is a valid bundle object. + * @post @a argv is a pointer of newly allocated memory. It must be freed. + * @see bundle_import_from_argv() @code #include <bundle_internal.h> bundle *b = bundle_create(); // Create new bundle object @@ -253,14 +253,14 @@ API int bundle_export_to_argv(bundle *b, char ***argv); /** * @brief Frees the exported @a argv. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * @remarks You must not use this API when you use global @a argv. - * @param[in] argc The number of args, which is the return value of bundle_export_to_argv() - * @param[in] argv The array from bundle_export_to_argv() - * @return The operation result - * @retval BUNDLE_ERROR_NONE Success - * @retval BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter - * @pre @a argv is a valid string array generated from bundle_export_to_argv(). - * @see bundle_export_to_argv() + * @remarks You must not use this API when you use global @a argv. + * @param[in] argc The number of args, which is the return value of bundle_export_to_argv() + * @param[in] argv The array from bundle_export_to_argv() + * @return The operation result + * @retval #BUNDLE_ERROR_NONE Success + * @retval #BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter + * @pre @a argv is a valid string array generated from bundle_export_to_argv(). + * @see bundle_export_to_argv() @code bundle *b = bundle_create(); bundle_add_str(b, "foo", "bar"); @@ -284,16 +284,16 @@ API int bundle_free_exported_argv(int argc, char ***argv); * @brief Imports a bundle from @a argv. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section. - * @param[in] argc The argument count - * @param[in] argv The argument vector - * @return The new bundle object - * @retval @c NULL - Failure - * @exception BUNDLE_ERROR_NONE Success - * @exception BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter - * @exception BUNDLE_ERROR_OUT_OF_MEMORY Out of memory - * @pre @a argv is a valid string array, which is created by bundle_export_to_argv(). - * @post The returned bundle @a b must be freed. - * @see bundle_export_to_argv() + * @param[in] argc The argument count + * @param[in] argv The argument vector + * @return The new bundle object + * @retval @c NULL - Failure + * @exception #BUNDLE_ERROR_NONE Success + * @exception #BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter + * @exception #BUNDLE_ERROR_OUT_OF_MEMORY Out of memory + * @pre @a argv is a valid string array, which is created by bundle_export_to_argv(). + * @post The returned bundle @a b must be freed. + * @see bundle_export_to_argv() @code #include <bundle_internal.h> @@ -311,16 +311,16 @@ API bundle *bundle_import_from_argv(int argc, char **argv); /** * @brief Sets a value of string array elements. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * @param[in] b The bundle object - * @param[in] key The key - * @param[in] idx The index of the array element to be changed - * @param[in] val The string type value; if @c NULL, an empty array is created; you can change an item with - * @return The operation result - * @retval BUNDLE_ERROR_NONE Success - * @retval BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter - * @pre @a b must be a valid bundle object. - * @see bundle_add_str_array() - * @see bundle_get_str_array() + * @param[in] b The bundle object + * @param[in] key The key + * @param[in] idx The index of the array element to be changed + * @param[in] val The string type value; if @c NULL, an empty array is created; you can change an item with + * @return The operation result + * @retval #BUNDLE_ERROR_NONE Success + * @retval #BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter + * @pre @a b must be a valid bundle object. + * @see bundle_add_str_array() + * @see bundle_get_str_array() @code #include <bundle_internal.h> bundle *b = bundle_create(); @@ -341,16 +341,16 @@ API bundle *bundle_import_from_argv(int argc, char **argv); API int bundle_set_str_array_element(bundle *b, const char *key, const unsigned int idx, const char *val); /** - * @brief Creates a json data from bundle. + * @brief Creates a JSON data from bundle. * @since_tizen 3.0 - * @remarks This API only supports the string type and the string array type. - * @param[in] b The bundle object - * @param[out] json The new created json data - * @return The operation result - * @retval BUNDLE_ERROR_NONE Success - * @retval BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter - * @retval BUNDLE_ERROR_OUT_OF_MEMORY Out of memory - * @pre @a b must be a valid bundle object. + * @remarks This function only supports the string type and the string array type. + * @param[in] b The bundle object + * @param[out] json The new created json data + * @return The operation result + * @retval #BUNDLE_ERROR_NONE Success + * @retval #BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BUNDLE_ERROR_OUT_OF_MEMORY Out of memory + * @pre @a b must be a valid bundle object. @code #include <bundle_internal.h> bundle *b = bundle_create(); @@ -373,13 +373,13 @@ API int bundle_to_json(bundle *b, char **json); /** * @breif Creates a bundle object from json. * @since_tizen 3.0 - * @remarks This API only supports the string type and the string array type. - * @param[in] json The json data - * @param[out] b The bundle object - * @return The operation result - * @retval BUNDLE_ERROR_NONE Success - * @retval BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter - * @retval BUNDLE_ERROR_OUT_OF_MEMORY Out of memory + * @remarks This function only supports the string type and the string array type. + * @param[in] json The json data + * @param[out] b The bundle object + * @return The operation result + * @retval #BUNDLE_ERROR_NONE Success + * @retval #BUNDLE_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BUNDLE_ERROR_OUT_OF_MEMORY Out of memory @code #include <bundle_internal.h> bundle *b; @@ -397,9 +397,9 @@ API int bundle_from_json(const char *json, bundle **b); /** * @breif Compares the bundle 1, 2. * @since_tizen 3.0 - * @param[in]b1 The bundle object - * @param[in]b2 The bundle object - * @return The operation result + * @param[in] b1 The bundle object + * @param[in] b2 The bundle object + * @return The operation result * @retval @c 0 It is identical * @retval @c -1 Invalid parameter * @retval @c 1 It is not identical @@ -411,12 +411,11 @@ API int bundle_compare(bundle *b1, bundle *b2); * @details To set the value of the byte array element, you should use bundle_set_byte_array_element(). * This function is only for creating a buffer of the byte array. * @since_tizen 5.5 - * - * @param[in] b The bundle object - * @param[in] key The key - * @param[in] len The length of the array to be created - * @return @c 0 on success, - * otherwise a negative error value + * @param[in] b The bundle object + * @param[in] key The key + * @param[in] len The length of the array to be created + * @return @c 0 on success, + * otherwise a negative error value * @retval #BUNDLE_ERROR_NONE Successful * @retval #BUNDLE_ERROR_INVALID_PARAMETEr Invalid parameter * @retval #BUNDLE_ERROR_KEY_EXISTS Key already exists |