Skip to content

Commit

Permalink
Fix comments
Browse files Browse the repository at this point in the history
  • Loading branch information
Christer Ekholm committed Jan 18, 2024
1 parent f6f1535 commit 953c9b0
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions include/cargs.h
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ typedef struct cag_option_context
} cag_option_context;

/**
* Prototype for printer used in cag_option_printer. For example fprint have same prototype
* Prototype for printer used in cag_option_printer. For example fprintf have same prototype
*/
typedef int (*cag_printer)(void *ctx, const char *fmt, ...);

Expand Down Expand Up @@ -211,12 +211,12 @@ CAG_PUBLIC void cag_option_print_error(const cag_option_context *context,
* callback.
*
* This function prints information about the error associated with the invalid
* option to the specified destination (such as a file stream). It helps in
* displaying the error of the current context.
* option using user callback. Callback prototype is same with fprintf. It helps
* in displaying the error of the current context.
*
* @param context Pointer to the context from which the option was fetched.
* @param printer The printer callback function. For example fprint.
* @param printer_ctx The parameter for printer callback. For example fprint
* @param printer The printer callback function. For example fprintf.
* @param printer_ctx The parameter for printer callback. For example fprintf
* could use parameter stderr.
*/
CAG_PUBLIC void cag_option_printer_error(const cag_option_context *context,
Expand Down Expand Up @@ -247,8 +247,8 @@ CAG_PUBLIC void cag_option_print(const cag_option *options, size_t option_count,
* @param options The options which will be printed.
* @param option_count The option count which will be printed.
* @param destination The destination where the output will be printed.
* @param printer The printer callback function. For example fprint.
* @param printer_ctx The parameter for printer callback. For example fprint
* @param printer The printer callback function. For example fprintf.
* @param printer_ctx The parameter for printer callback. For example fprintf
* could use parameter stderr.
*/
CAG_PUBLIC void cag_option_printer(const cag_option *options,
Expand Down

0 comments on commit 953c9b0

Please sign in to comment.