Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix several documentation comments #278

Merged
merged 1 commit into from
Dec 22, 2024
+1 −7
Merged

Fix several documentation comments #278

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions src/common.h
View file
Open in desktop
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
View file
Open in desktop
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
Loading