]> Kevux Git Server - fll/commitdiff
Cleanup: Add additional comment for f_console_result_found_d documentation.
authorKevin Day <Kevin@kevux.org>
Sat, 22 Nov 2025 04:37:20 +0000 (22:37 -0600)
committerKevin Day <Kevin@kevux.org>
Sat, 22 Nov 2025 04:37:20 +0000 (22:37 -0600)
level_0/f_console/c/console/common.h

index e0fd12a86695ab23ad92de99283bbd9f10a719fe..7f0e0ce8415aadd7001202b29b32110d42a3a676 100644 (file)
@@ -78,7 +78,7 @@ extern "C" {
  * f_console_result_*_d:
  *   - none:    No flags are set.
  *   - alone:   The prefix character is by itself (such as only "-" rather than "-h").
- *   - found:   The parameter has been found.
+ *   - found:   The parameter has been found (this does not designate whether or not a value is associated).
  *   - inverse: The inverse prefix character ("+" by default) has been found.
  *   - long:    The found prefix is long (two characters, such as "--" or "++").
  *   - normal:  The normal prefix character ("-" by default) has been found.