riot-ci/RIOT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

sys/ubjson: add deprecation notices to the documentation.

Browse Source 
Add @deprecated doxygen tags to the module, the header and the main
reader and writer functions.
This commit is contained in:
Juan Carrano 2019-06-25 15:19:16 +02:00
parent 3b8deac3e9
commit 2d782bc225
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
sys/include/ubjson.h
View File

@ -20,12 +20,16 @@
* @defgroup sys_ubjson Universal Binary JSON library * @defgroup sys_ubjson Universal Binary JSON library
* @ingroup sys_serialization * @ingroup sys_serialization
* @brief Provides a library to read and write UBJSON serialized data * @brief Provides a library to read and write UBJSON serialized data
*
* @deprecated This module is deprecated and will be removed in release 2020.01.
* @{ * @{
* *
* @file * @file
* @brief Headers for the UBJSON module * @brief Headers for the UBJSON module
* *
* @author René Kijewski <rene.kijewski@fu-berlin.de> * @author René Kijewski <rene.kijewski@fu-berlin.de>
*
* @deprecated This module is deprecated and will be removed in release 2020.01.
*/ */
#ifndef UBJSON_H #ifndef UBJSON_H
@ -289,6 +293,10 @@ ubjson_read_callback_result_t ubjson_read_next(ubjson_cookie_t *__restrict cooki
* *
* You probably want to wrap the cookie in some other data structure, * You probably want to wrap the cookie in some other data structure,
* which you retrieve with container_of() in the callback. * which you retrieve with container_of() in the callback.
*
* @deprecated This function and its containing module are deprecated and
* will be removed in release 2020.01.
*
* @param[in] cookie The cookie that is passed to the callback function. * @param[in] cookie The cookie that is passed to the callback function.
* @param[in] read The function that is called to receive more data. * @param[in] read The function that is called to receive more data.
* @param[in] callback The callback function. * @param[in] callback The callback function.
@ -434,6 +442,10 @@ ubjson_read_callback_result_t ubjson_read_object(ubjson_cookie_t *__restrict coo
* The programmer needs to ensure that the API is used correctly. * The programmer needs to ensure that the API is used correctly.
* The library won't complain if you write multiple values that are not * The library won't complain if you write multiple values that are not
* inside an array or object. The result will just not be properly serialized. * inside an array or object. The result will just not be properly serialized.
*
* @deprecated This function and its containing module are deprecated and
* will be removed in release 2020.01
*
* @param[out] cookie The cookie that will be passed to ubjson_write_null() and friends. * @param[out] cookie The cookie that will be passed to ubjson_write_null() and friends.
* @param[in] write_fun The function that will be called to write data. * @param[in] write_fun The function that will be called to write data.
*/ */