From 2951f8b3d84a50ae47c4c08ff5f6bed986b244d2 Mon Sep 17 00:00:00 2001 From: Victor Zverovich Date: Tue, 10 Sep 2013 09:26:11 -0700 Subject: [PATCH] API docs. --- format.h | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/format.h b/format.h index 936c5095..d3d00bcc 100644 --- a/format.h +++ b/format.h @@ -628,6 +628,9 @@ class BasicWriter { return *this; } + /** + Writes *value* to the stream. + */ BasicWriter &operator<<(const fmt::BasicStringRef value) { const Char *str = value.c_str(); std::size_t size = value.size(); @@ -1038,7 +1041,7 @@ class NoAction { } }; - // Formats an error message and prints it to std::cerr. + // Formats an error message and prints it to stdout. fmt::Formatter ReportError(const char *format) { return fmt::Formatter(format); } @@ -1183,7 +1186,7 @@ inline Formatter Format(WStringRef format) { /** A formatting action that writes formatted output to stdout. */ class Write { public: - /** Write the output to stdout. */ + /** Writes the output to stdout. */ void operator()(const BasicWriter &w) const { std::fwrite(w.data(), 1, w.size(), stdout); }