Skip to content

Commit

Permalink
Merge pull request #278 from marcransome/fix-doc-comments
Browse files Browse the repository at this point in the history
Fix several documentation comments
  • Loading branch information
marcransome authored Dec 22, 2024
2 parents aa1adbc + ca1c8d9 commit 17cd1c9
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 7 deletions.
2 changes: 0 additions & 2 deletions src/common.h
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,6 @@ const char * flog_error_string(FlogError error);
/*! \brief Print a formatted error message representation of the error condition.
*
* \param[in] error A FlogError enumeration variant representing the error condition
*
* \return void
*/
void flog_print_error(FlogError error);

Expand Down
6 changes: 1 addition & 5 deletions src/config.h
Original file line number Diff line number Diff line change
Expand Up @@ -197,20 +197,16 @@ void flog_config_set_message(FlogConfig *config, const char *message);
*
* \pre \c config is \e not \c NULL
* \pre \c args is \e not \c NULL
*
* \return void
*/
void flog_config_set_message_from_args(FlogConfig *config, const char **args);

/*! \brief Set the log message for a FlogConfig object by reading from a stream.
*
* \param config A pointer to the FlogConfig object
* \param args A pointer to a stream
* \param stream A pointer to a stream
*
* \pre \c config is \e not \c NULL
* \pre \c stream is \e not \c NULL
*
* \return void
*/
void flog_config_set_message_from_stream(FlogConfig *config, FILE *restrict stream);

Expand Down

0 comments on commit 17cd1c9

Please sign in to comment.