diff options
Diffstat (limited to 'Source/charon/utils/logger_manager.h')
| -rw-r--r-- | Source/charon/utils/logger_manager.h | 55 |
1 files changed, 35 insertions, 20 deletions
diff --git a/Source/charon/utils/logger_manager.h b/Source/charon/utils/logger_manager.h index de37e1e0f..afc199ca7 100644 --- a/Source/charon/utils/logger_manager.h +++ b/Source/charon/utils/logger_manager.h @@ -1,7 +1,7 @@ /** * @file logger_manager.h * - * @brief Logger manager. Manages globaly all logger objects + * @brief Interface of logger_manager_t. * */ @@ -31,6 +31,8 @@ typedef enum logger_context_t logger_context_t; /** * @brief Context of a specific logger + * + * @ingroup utils */ enum logger_context_t { PARSER, @@ -52,76 +54,86 @@ enum logger_context_t { typedef struct logger_manager_t logger_manager_t; /** - * @brief The logger_manager_t object + * Class to manage logger_t objects. + * + * @ingroup utils */ struct logger_manager_t { /** * @brief Gets a logger_t object for a specific logger context. * - * @warning logger_t objects which are not destroyed over function - * #logger_manager_s.destroy_logger are destroyed in logger_managers + * @warning Objects of type logger_t which are not destroyed over function + * #logger_manager_t.destroy_logger are destroyed in logger_managers * destroy function. Don't use logger_t's own destroy function with * managed logger_t objects. * * @param this logger_manager_t object - * @param context logger_context to use the logger for. + * @param context logger_context to use the logger for * @param[out] logger pointer to a a place where the new logger is stored * @param name name for the new logger. Context name is already included - * and has not to be specified (so NULL is allowed). - * @return - * - logger_t on SUCCESS - * - NULL otherwise + * and has not to be specified (so NULL is allowed) + * @return + * - logger_t object + * - NULL if out of ressources */ logger_t *(*create_logger) (logger_manager_t *this, logger_context_t context, char *name); /** - * @brief Destroys a logger_t object which is not used anymore + * @brief Destroys a logger_t object which is not used anymore. * - * @warning logger_t objects which are not destroyed over function - * #logger_manager_s.destroy_logger are destroyed in logger_managers + * @warning Objects of type logger_t which are not destroyed over function + * #logger_manager_t.destroy_logger are destroyed in logger_managers * destroy function. * * @param this logger_manager_t object * @param logger pointer to the logger which has to be destroyed - * @return - * - SUCCESS - * - OUT_OF_RES + * @return - SUCCESS + * - OUT_OF_RES (when searching the specific logger_t object) * - NOT_FOUND */ status_t (*destroy_logger) (logger_manager_t *this,logger_t *logger); /** * Returns the set logger_level of a specific context or 0. + * * @param this calling object * @param context context to check level - * @return logger_level for the given logger_context + * @return logger_level for the given logger_context */ logger_level_t (*get_logger_level) (logger_manager_t *this, logger_context_t context); /** * Enables a logger_level of a specific context. + * * @param this calling object * @param context context to set level * @param logger_level logger_level to eanble - * @return SUCCESS + * @return + * - SUCCESS + * - OUT_OF_RES */ status_t (*enable_logger_level) (logger_manager_t *this, logger_context_t context,logger_level_t logger_level); /** * Disables a logger_level of a specific context. + * * @param this calling object * @param context context to set level * @param logger_level logger_level to disable - * @return SUCCESS + * @return + * - SUCCESS + * - OUT_OF_RES */ status_t (*disable_logger_level) (logger_manager_t *this, logger_context_t context,logger_level_t logger_level); /** - * @brief destroys a logger_manager_t object. + * @brief Destroys a logger_manager_t object. + * + * All remaining managed logger_t objects are also destroyed. * * @param this logger_manager_t object * @return @@ -134,8 +146,11 @@ struct logger_manager_t { * @brief Constructor to create a logger_manager_t object. * * @param default_log_level default log level for a context - * @return logger_manager_t object or NULL if failed + * @return + * - logger_manager_t object + * - NULL if out of ressources * + * @ingroup utils */ logger_manager_t *logger_manager_create(logger_level_t default_log_level); |