From da3467b7f9fc36f5c9c42ef59e992dd4e20c3395 Mon Sep 17 00:00:00 2001 From: vitaut Date: Wed, 20 Apr 2016 07:45:11 -0700 Subject: [PATCH] Document BasicArgFormatter --- cppformat/format.h | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/cppformat/format.h b/cppformat/format.h index bb73a54c..0be1bfbf 100644 --- a/cppformat/format.h +++ b/cppformat/format.h @@ -1964,7 +1964,14 @@ class BasicArgFormatter : public internal::ArgFormatterBase { const Char *format_; public: - /** Constructs an argument formatter object. */ + /** + \rst + Constructs an argument formatter object. + *f* is a reference to the main formatter object, *s* contains format + specifier information for standard argument types, and *fmt* points to + the part of the format string being parsed for custom argument types. + \endrst + */ BasicArgFormatter(BasicFormatter &f, FormatSpec &s, const Char *fmt) : internal::ArgFormatterBase(f.writer(), s),