From 648843d1482f895f3476f78859a5c10174d2ac40 Mon Sep 17 00:00:00 2001 From: Christopher Dunn Date: Sat, 24 Jan 2015 13:57:29 -0600 Subject: [PATCH] clarify CommentStyle --- include/json/writer.h | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/include/json/writer.h b/include/json/writer.h index 6e46cf1..e4d665e 100644 --- a/include/json/writer.h +++ b/include/json/writer.h @@ -41,7 +41,11 @@ class JSON_API StreamWriter { protected: std::ostream& sout_; // not owned; will not delete public: - enum class CommentStyle {None, Some, All}; + /// `All`: Keep all comments. + /// `None`: Drop all comments. + /// Use `Most` to recover the odd behavior of previous versions. + /// Only `All` is currently implemented. + enum class CommentStyle {None, Most, All}; /// Keep a reference, but do not take ownership of `sout`. StreamWriter(std::ostream* sout);