From 27101d9cd1b586a955f9edb83504194f9fb3f110 Mon Sep 17 00:00:00 2001 From: Milo Yip Date: Sun, 13 Jul 2014 13:27:15 +0800 Subject: [PATCH] Add API doc for Writer::Reset() and Writer::IsComplete() --- include/rapidjson/writer.h | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/include/rapidjson/writer.h b/include/rapidjson/writer.h index 22630c4f..468ad90c 100644 --- a/include/rapidjson/writer.h +++ b/include/rapidjson/writer.h @@ -44,6 +44,24 @@ public: os_(&os), level_stack_(allocator, levelDepth * sizeof(Level)), doublePrecision_(kDefaultDoublePrecision), hasRoot_(false) {} + //! Reset the writer with a new stream. + /*! + This function reset the writer with a new stream and default settings, + in order to make a Writer object reusable for output multiple JSONs. + + \param os New output stream. + \code + Writer writer(os1); + writer.StartObject(); + // ... + writer.EndObject(); + + writer.Reset(os2); + writer.StartObject(); + // ... + writer.EndObject(); + \endcode + */ void Reset(OutputStream& os) { os_ = &os; doublePrecision_ = kDefaultDoublePrecision; @@ -51,6 +69,10 @@ public: level_stack_.Clear(); } + //! Checks whether the output is a complete JSON. + /*! + A complete JSON has a complete root object or array. + */ bool IsComplete() const { return hasRoot_ && level_stack_.Empty(); }