Skip to content

Commit

Permalink
Add doxygen
Browse files Browse the repository at this point in the history
  • Loading branch information
Rot127 committed Apr 21, 2024
1 parent d013fcf commit 55d2725
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 3 deletions.
18 changes: 18 additions & 0 deletions librz/core/core.c
Original file line number Diff line number Diff line change
Expand Up @@ -106,14 +106,32 @@ RZ_API void rz_core_notify_error(RZ_NONNULL RzCore *core, RZ_NONNULL const char
va_end(args);
}

/**
* \brief Prints a message definining the beginning of a task
*
* \param core The RzCore to use
* \param text The message to notify
*/
RZ_API void rz_core_notify_begin_str(RZ_NONNULL RzCore *core, RZ_NONNULL const char *text) {
rz_core_notify_begin(core, "%s", text);
}

/**
* \brief Prints a message definining the end of a task which succeeded
*
* \param core The RzCore to use
* \param text The message to notify
*/
RZ_API void rz_core_notify_done_str(RZ_NONNULL RzCore *core, RZ_NONNULL const char *text) {
rz_core_notify_done(core, "%s", text);
}

/**
* \brief Prints a message definining the end of a task which errored
*
* \param core The RzCore to use
* \param text The message to notify
*/
RZ_API void rz_core_notify_error_str(RZ_NONNULL RzCore *core, RZ_NONNULL const char *text) {
rz_core_notify_error(core, "%s", text);
}
Expand Down
6 changes: 3 additions & 3 deletions librz/util/log.c
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,7 @@ RZ_API void rz_vlog(const char *funcname, const char *filename,
* \param filename Contains the filename that funcname is defined in
* \param lineno The line number that this log call is being made from in filename
* \param lvl Logging level for output
* \param tag A string placed at the beginning of the log message. If NULL, the log level is used.
* \param tag A string placed at the beginning of the log message. If NULL, the log level is printed.
* \param fmtstr A printf like string
This function is used by the RZ_LOG_* preprocessor macros for logging
Expand All @@ -275,13 +275,13 @@ RZ_API void rz_log(const char *funcname, const char *filename,
}

/**
* \brief Logging function for plugins with no vargs support.
* \brief Logging function for simple strings.
*
* \param funcname Contains the function name of the calling function
* \param filename Contains the filename that \p funcname is defined in
* \param lineno The line number that this log call is being made from in filename
* \param lvl Logging level for output
* \param tag A string placed at the beginning of the log message. If NULL, the log level is used.
* \param tag A string placed at the beginning of the log message. If NULL, the log level is printed.
* \param msg The log message.
*/
RZ_API void rz_log_str(const char *funcname, const char *filename,
Expand Down

0 comments on commit 55d2725

Please sign in to comment.