From 611a26f86da317d9855166b4046b5315d168e16d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=C3=A5vard=20Vermeer?= Date: Mon, 16 Dec 2024 13:11:18 +0100 Subject: [PATCH] lib: lwm2m_carrier: Clarify pdn return values MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Aligned the lwm2m_os pdn return value doc with other NCS headers. Included lwm2m_os_storage_delete() for consistency. Signed-off-by: Håvard Vermeer --- lib/bin/lwm2m_carrier/include/lwm2m_os.h | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/lib/bin/lwm2m_carrier/include/lwm2m_os.h b/lib/bin/lwm2m_carrier/include/lwm2m_os.h index 40c419ff15b9..1b6e2e781965 100644 --- a/lib/bin/lwm2m_carrier/include/lwm2m_os.h +++ b/lib/bin/lwm2m_carrier/include/lwm2m_os.h @@ -221,7 +221,8 @@ int lwm2m_os_pdn_ctx_destroy(uint8_t cid); * supported, or PDN_FAM_IPV6 if only IPv6 is supported. Otherwise, this value * will remain unchanged. * - * @retval 0 If success. + * @retval 0 If the operation was successful. + * Otherwise, a negative error code is returned. */ int lwm2m_os_pdn_activate(uint8_t cid, int *esm, enum lwm2m_os_pdn_fam *family); @@ -230,7 +231,8 @@ int lwm2m_os_pdn_activate(uint8_t cid, int *esm, enum lwm2m_os_pdn_fam *family); * * @param cid The PDP context ID. * - * @retval 0 If success. + * @retval 0 If the operation was successful. + * Otherwise, a negative error code is returned. */ int lwm2m_os_pdn_deactivate(uint8_t cid); @@ -241,7 +243,7 @@ int lwm2m_os_pdn_deactivate(uint8_t cid); * * @param cid The context ID of the PDN connection. * - * @retval 0 If success. + * @return A non-negative PDN ID on success, or a negative errno otherwise. */ int lwm2m_os_pdn_id_get(uint8_t cid); @@ -249,6 +251,9 @@ int lwm2m_os_pdn_id_get(uint8_t cid); * @brief Set a callback for events pertaining to the default PDP context (zero). * * @param cb The PDN event handler. + * + * @retval 0 If the operation was successful. + * Otherwise, a negative error code is returned. */ int lwm2m_os_pdn_default_callback_set(lwm2m_os_pdn_event_handler_t cb); @@ -333,8 +338,8 @@ uint32_t lwm2m_os_rand_get(void); * * @param[in] id of the entry to be deleted. * - * @retval 0 If success - * @retval -ERRNO errno code if error. + * @retval 0 If the operation was successful. + * Otherwise, a negative error code is returned. */ int lwm2m_os_storage_delete(uint16_t id);