From 83b13e890ebb9607522a0b98071a1e1abb20dc99 Mon Sep 17 00:00:00 2001 From: Mateusz Majewski Date: Tue, 21 Jul 2020 18:36:52 +0200 Subject: [PATCH] libdlogutil: documentation errata Change-Id: Ibaccae9d1912245d859909ff7268c5473776f981 --- include/dlogutil.h | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/include/dlogutil.h b/include/dlogutil.h index dabc8bf..9d20c77 100644 --- a/include/dlogutil.h +++ b/include/dlogutil.h @@ -315,9 +315,7 @@ typedef struct dlogutil_state dlogutil_state_s; * @brief Destroys the #dlogutil_state_s struct. * @since_tizen 6.0 * @param[in] filter A handle to the state struct - * @see dlogutil_prepare_continuous() - * @see dlogutil_prepare_monitor() - * @see dlogutil_prepare_dump() + * @see dlogutil_config_connect() */ void dlogutil_state_destroy(dlogutil_state_s *state); @@ -391,6 +389,7 @@ int dlogutil_config_connect(dlogutil_config_s *config, dlogutil_state_s **state_ * @retval TIZEN_ERROR_NONE Success * @retval TIZEN_ERROR_TIMED_OUT Timeout exceeded * @retval TIZEN_ERROR_NO_DATA In dump mode, no more logs remaining + * @retval TIZEN_ERROR_INVALID_PARAMETER One of the pointers was NULL * @retval Other An arbitrary Tizen error code */ int dlogutil_get_log(dlogutil_state_s *state, int timeout, dlogutil_entry_s **entry_out); @@ -424,7 +423,6 @@ int dlogutil_buffer_clear(dlogutil_state_s *state, log_id_t buffer); * @retval TIZEN_ERROR_NONE Success * @retval TIZEN_ERROR_INVALID_PARAMETER Invalid buffer * @retval TIZEN_ERROR_INVALID_PARAMETER The pointer was NULL - * @retval Other An arbitrary Tizen error code */ int dlogutil_buffer_get_name(log_id_t buffer, const char **name); @@ -484,7 +482,6 @@ int dlogutil_buffer_get_usage(dlogutil_state_s *state, log_id_t buffer, unsigned * @return An error code * @retval TIZEN_ERROR_NONE Success * @retval TIZEN_ERROR_INVALID_PARAMETER Invalid buffer - * @retval TIZEN_ERROR_INVALID_PARAMETER More than one buffer * @retval TIZEN_ERROR_INVALID_PARAMETER The pointer was NULL * @retval Other An arbitrary Tizen error code */ -- 2.7.4