summaryrefslogtreecommitdiff
path: root/absl/flags/internal/usage.h
diff options
context:
space:
mode:
authorGravatar Abseil Team <absl-team@google.com>2020-10-06 12:57:41 -0700
committerGravatar Mark Barolak <mbar@google.com>2020-10-07 10:13:53 -0400
commitc678d6c6bf70d47b4aa5bc3576a3a769775bc162 (patch)
tree107afd890e90c7fef79bc6e061264fbfd05fc14e /absl/flags/internal/usage.h
parent4b4f9aae75d3c85bdc07b0575de5d4db40cea439 (diff)
Export of internal Abseil changes
-- 9b45aa0bd58cd9e8478abffafa792e1e53feed08 by Abseil Team <absl-team@google.com>: Document that command line flag help for a flag will include the default value. Cleaned up the doc for undefok. PiperOrigin-RevId: 335701801 GitOrigin-RevId: 9b45aa0bd58cd9e8478abffafa792e1e53feed08 Change-Id: I435e240bd10bf6a232a95f220cab83c41701ecb6
Diffstat (limited to 'absl/flags/internal/usage.h')
-rw-r--r--absl/flags/internal/usage.h3
1 files changed, 2 insertions, 1 deletions
diff --git a/absl/flags/internal/usage.h b/absl/flags/internal/usage.h
index 0c62dc4b..619ccceb 100644
--- a/absl/flags/internal/usage.h
+++ b/absl/flags/internal/usage.h
@@ -36,7 +36,8 @@ enum class HelpFormat {
kHumanReadable,
};
-// Outputs the help message describing specific flag.
+// Streams the help message describing `flag` to `out`.
+// The default value for `flag` is included in the output.
void FlagHelp(std::ostream& out, const CommandLineFlag& flag,
HelpFormat format = HelpFormat::kHumanReadable);