bug-gnulib@gnu.org mirror (unofficial)
 help / color / mirror / code / Atom feed
* xstrtol-error: Improve comments
@ 2023-01-11 22:25 Bruno Haible
  0 siblings, 0 replies; only message in thread
From: Bruno Haible @ 2023-01-11 22:25 UTC (permalink / raw)
  To: bug-gnulib

The description of the function xstrtol_fatal mentions parameters ERR,
LONG_OPTION, OPT_IDX, etc. But the function's declaration lacks the
parameter names. So, in order to understand a comment in the .h file,
one needs to look into the declaration in the .c file. Weird!

This patch fixes it.

2023-01-11  Bruno Haible  <bruno@clisp.org>

	xstrtol-error: Improve comments.
	* lib/xstrtol-error.h (xstrtol_fatal): Add parameter names to

diff --git a/lib/xstrtol-error.h b/lib/xstrtol-error.h
index e79ff151ee..d8892ea871 100644
--- a/lib/xstrtol-error.h
+++ b/lib/xstrtol-error.h
@@ -28,7 +28,7 @@
    ERR is the error code returned by one of the xstrto* functions.
    Use OPT_IDX to decide whether to print the short option string "C"
-   or "-C" or a long option string derived from LONG_OPTION.  OPT_IDX
+   or "-C" or a long option string derived from LONG_OPTIONS.  OPT_IDX
    is -2 if the short option "C" was used, without any leading "-"; it
    is -1 if the short option "-C" was used; otherwise it is an index
    into LONG_OPTIONS, which should have a name preceded by two '-'
@@ -38,8 +38,9 @@
    After reporting an error, exit with a failure status.  */
-_Noreturn void xstrtol_fatal (enum strtol_error,
-                              int, char, struct option const *,
-                              char const *);
+_Noreturn void xstrtol_fatal (enum strtol_error /* err */,
+                              int /* opt_idx */, char /* c */,
+                              struct option const * /* long_options */,
+                              char const * /* arg */);
 #endif /* not XSTRTOL_ERROR_H_ */

^ permalink raw reply related	[flat|nested] only message in thread

only message in thread, other threads:[~2023-01-11 22:25 UTC | newest]

Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-01-11 22:25 xstrtol-error: Improve comments Bruno Haible

Code repositories for project(s) associated with this public inbox


This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).