X-Git-Url: https://git.draconx.ca/gitweb/dxcommon.git/blobdiff_plain/843799dbec995b276a7d017bb32c053747b55400..d370ab57b97f352ace48992a01dc57ad84d57dd0:/src/help.h?ds=sidebyside

diff --git a/src/help.h b/src/help.h
index 9eb2654..7dbb65d 100644
--- a/src/help.h
+++ b/src/help.h
@@ -1,5 +1,5 @@
 /*
- * Copyright © 2021 Nick Bowler
+ * Copyright © 2021, 2023 Nick Bowler
  *
  * Helper functions for formatting --help program output.
  *
@@ -23,10 +23,14 @@ struct option;
 int help_print_optstring(const struct option *opt, const char *argname, int l);
 
 /*
- * Print an option description with each line indented.  The string is first
- * localized (if NLS is enabled).  The first line will be indented by i-w
- * spaces (to account for the cursor being in some other column), all other
- * lines are indented by i spaces.
+ * Print an option description with each line indented.  If opt is not NULL,
+ * then the string is first localized (if NLS is enabled) via pgettext_expr
+ * with the context set to opt->name.  The first line will be indented by
+ * i-w spaces (to account for the cursor being in some other column), all
+ * other lines are indented by i spaces.
+ *
+ * The output always ends with a newline, regardless of whether or not the
+ * input string ends with a newline.
  */
 void help_print_desc(const struct option *opt, const char *desc, int i, int w);