From 999f5912f0f99666dddfcc336f031f24c1a0da2a Mon Sep 17 00:00:00 2001 From: Christopher Dunn Date: Mon, 26 Jan 2015 11:12:53 -0600 Subject: [PATCH] docs --- include/json/writer.h | 29 +++++++++++++++++++---------- 1 file changed, 19 insertions(+), 10 deletions(-) diff --git a/include/json/writer.h b/include/json/writer.h index db71cd7..0dca690 100644 --- a/include/json/writer.h +++ b/include/json/writer.h @@ -23,20 +23,18 @@ namespace Json { class Value; -class StreamWriterBuilder; /** Usage: \code using namespace Json; - Value value; - StreamWriter::Builder builder; - builder.withCommentStyle(StreamWriter::CommentStyle::None); - std::shared_ptr writer( - builder.newStreamWriter(&std::cout)); - writer->write(value); - std::cout << std::endl; // add lf and flush + void writeToStdout(StreamWriter::Builder const& builder, Value const& value) { + std::unique_ptr const writer( + builder.newStreamWriter(&std::cout)); + writer->write(value); + std::cout << std::endl; // add lf and flush + } \endcode */ class JSON_API StreamWriter { @@ -73,9 +71,20 @@ std::string writeString(Value const& root, StreamWriter::Factory const& factory) /** \brief Build a StreamWriter implementation. - */ + +Usage: +\code + using namespace Json; + Value value = ...; + StreamWriter::Builder builder; + builder.cs_ = StreamWriter::CommentStyle::None; + std::shared_ptr writer( + builder.newStreamWriter(&std::cout)); + writer->write(value); + std::cout << std::endl; // add lf and flush +\endcode +*/ class JSON_API StreamWriterBuilder : public StreamWriter::Factory { - // typedef StreamWriter::CommentStyle CommentStyle; public: // Note: We cannot add data-members to this class without a major version bump. // So these might as well be completely exposed.