From 3354d8e9a7432a9ed6d7874713488170fd9b045c Mon Sep 17 00:00:00 2001 From: Mateusz Majewski Date: Fri, 24 Jan 2020 08:21:51 +0100 Subject: [PATCH] Minor libdlogutil documentation clarification Change-Id: I4bafb349eff49a6a3e14d980d4887e8e4adc751b --- include/dlogutil.h | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/include/dlogutil.h b/include/dlogutil.h index 33409a1..975875c 100644 --- a/include/dlogutil.h +++ b/include/dlogutil.h @@ -169,7 +169,7 @@ dlogutil_filter_options_s *dlogutil_filter_options_create(void); void dlogutil_filter_options_destroy(dlogutil_filter_options_s *filter); /** - * @brief Enables retrieving only logs by the given TIDs. + * @brief Enables retrieving only those logs that are logged by the thread with the given TID. * @since_tizen 6.0 * @param[in] filter A handle to the settings struct * @param[in] tid The TID value @@ -180,7 +180,7 @@ void dlogutil_filter_options_destroy(dlogutil_filter_options_s *filter); int dlogutil_filter_options_set_tid(dlogutil_filter_options_s *filter, pid_t tid); /** - * @brief Enables retrieving only logs by the given PIDs. + * @brief Enables retrieving only those logs that are logged by the process with the given PID. * @since_tizen 6.0 * @param[in] filter A handle to the settings struct. * @param[in] pid The PID value. @@ -191,7 +191,7 @@ int dlogutil_filter_options_set_tid(dlogutil_filter_options_s *filter, pid_t tid int dlogutil_filter_options_set_pid(dlogutil_filter_options_s *filter, pid_t pid); /** - * @brief Enables retrieving only logs matching a given filter. + * @brief Enables retrieving only those logs that match a given filter. * @since_tizen 6.0 * @param[in] filter A handle to the settings struct. * @param[in] query The filter query. For syntax, see dlogutil's --help or @ref CAPI_SYSTEM_DLOG_UTIL documentation. @@ -356,7 +356,7 @@ int main(void) int dlogutil_get_logs_continuous(int buffers, dlogutil_entry_cb callback, void *data, dlogutil_sorting_options_s *sorting, dlogutil_filter_options_s *filter); /** - * @brief Dumps a limited number of the most recent logs and returns. + * @brief Dumps logs (possibly a specified amount of the most recent of them) and returns. * @since_tizen 6.0 * @remarks The function is synchronous, so it will block until an error, callback non-zero value or until all logs are processed. * The callback will be called in the thread in which this function has been called. -- 2.7.4