michaelh/zephyr
1
0
Fork 0
Code Releases Activity

logging: Clean up in log_backend.h (asserts and doxygen)

Browse source 
Cleaning up doxygen comments. Replacing assert() with __ASSERT_NO_MSG.

Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
This commit is contained in:
Krzysztof Chruscinski 2018-11-30 15:28:48 +01:00 • committed by Andrew Boie
commit e781daacbf
1 changed files with 17 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

34
include/logging/log_backend.h
View file

@ -81,7 +81,7 @@ extern const struct log_backend __log_backends_end[0];
/** /**
* @brief Function for putting message with log entry to the backend. * @brief Put message with log entry to the backend.
* *
* @param[in] backend Pointer to the backend instance. * @param[in] backend Pointer to the backend instance.
* @param[in] msg Pointer to message with log entry. * @param[in] msg Pointer to message with log entry.
@ -89,8 +89,8 @@ extern const struct log_backend __log_backends_end[0];
static inline void log_backend_put(const struct log_backend *const backend, static inline void log_backend_put(const struct log_backend *const backend,
struct log_msg *msg) struct log_msg *msg)
{ {
assert(backend); __ASSERT_NO_MSG(backend);
assert(msg); __ASSERT_NO_MSG(msg);
backend->api->put(backend, msg); backend->api->put(backend, msg);
} }
@ -105,7 +105,7 @@ static inline void log_backend_put(const struct log_backend *const backend,
static inline void log_backend_dropped(const struct log_backend *const backend, static inline void log_backend_dropped(const struct log_backend *const backend,
u32_t cnt) u32_t cnt)
{ {
assert(backend); __ASSERT_NO_MSG(backend);
if (backend->api->dropped) { if (backend->api->dropped) {
backend->api->dropped(backend, cnt); backend->api->dropped(backend, cnt);
@ -119,12 +119,12 @@ static inline void log_backend_dropped(const struct log_backend *const backend,
*/ */
static inline void log_backend_panic(const struct log_backend *const backend) static inline void log_backend_panic(const struct log_backend *const backend)
{ {
assert(backend); __ASSERT_NO_MSG(backend);
backend->api->panic(backend); backend->api->panic(backend);
} }
/** /**
* @brief Function for setting backend id. * @brief Set backend id.
* *
* @note It is used internally by the logger. * @note It is used internally by the logger.
* *
@ -134,12 +134,12 @@ static inline void log_backend_panic(const struct log_backend *const backend)
static inline void log_backend_id_set(const struct log_backend *const backend, static inline void log_backend_id_set(const struct log_backend *const backend,
u8_t id) u8_t id)
{ {
assert(backend); __ASSERT_NO_MSG(backend);
backend->cb->id = id; backend->cb->id = id;
} }
/** /**
* @brief Function for getting backend id. * @brief Get backend id.
* *
* @note It is used internally by the logger. * @note It is used internally by the logger.
* *
@ -148,12 +148,12 @@ static inline void log_backend_id_set(const struct log_backend *const backend,
*/ */
static inline u8_t log_backend_id_get(const struct log_backend *const backend) static inline u8_t log_backend_id_get(const struct log_backend *const backend)
{ {
assert(backend); __ASSERT_NO_MSG(backend);
return backend->cb->id; return backend->cb->id;
} }
/** /**
* @brief Function for getting backend. * @brief Get backend.
* *
* @param[in] idx Pointer to the backend instance. * @param[in] idx Pointer to the backend instance.
* *
@ -165,7 +165,7 @@ static inline const struct log_backend *log_backend_get(u32_t idx)
} }
/** /**
* @brief Function for getting number of backends. * @brief Get number of backends.
* *
* @return Number of backends. * @return Number of backends.
*/ */
@ -176,7 +176,7 @@ static inline int log_backend_count_get(void)
} }
/** /**
* @brief Function for activating backend. * @brief Activate backend.
* *
* @param[in] backend Pointer to the backend instance. * @param[in] backend Pointer to the backend instance.
* @param[in] ctx User context. * @param[in] ctx User context.
@ -184,25 +184,25 @@ static inline int log_backend_count_get(void)
static inline void log_backend_activate(const struct log_backend *const backend, static inline void log_backend_activate(const struct log_backend *const backend,
void *ctx) void *ctx)
{ {
assert(backend); __ASSERT_NO_MSG(backend);
backend->cb->ctx = ctx; backend->cb->ctx = ctx;
backend->cb->active = true; backend->cb->active = true;
} }
/** /**
* @brief Function for deactivating backend. * @brief Deactivate backend.
* *
* @param[in] backend Pointer to the backend instance. * @param[in] backend Pointer to the backend instance.
*/ */
static inline void log_backend_deactivate( static inline void log_backend_deactivate(
const struct log_backend *const backend) const struct log_backend *const backend)
{ {
assert(backend); __ASSERT_NO_MSG(backend);
backend->cb->active = false; backend->cb->active = false;
} }
/** /**
* @brief Function for checking state of the backend. * @brief Check state of the backend.
* *
* @param[in] backend Pointer to the backend instance. * @param[in] backend Pointer to the backend instance.
* *
@ -211,7 +211,7 @@ static inline void log_backend_deactivate(
static inline bool log_backend_is_active( static inline bool log_backend_is_active(
const struct log_backend *const backend) const struct log_backend *const backend)
{ {
assert(backend); __ASSERT_NO_MSG(backend);
return backend->cb->active; return backend->cb->active;
} }