From 53b27ac8baab4dbd441409bd6794a6ea34378d96 Mon Sep 17 00:00:00 2001
From: "Philipp A. Hartmann" <pah@qo.cx>
Date: Sat, 5 Jul 2014 17:07:13 +0200
Subject: [PATCH] GenericReader: improve doxygen documentation

---
 include/rapidjson/reader.h | 25 +++++++++++++++++--------
 1 file changed, 17 insertions(+), 8 deletions(-)

diff --git a/include/rapidjson/reader.h b/include/rapidjson/reader.h
index dac1537..59d03b6 100644
--- a/include/rapidjson/reader.h
+++ b/include/rapidjson/reader.h
@@ -43,6 +43,8 @@ namespace rapidjson {
 // ParseFlag
 
 //! Combination of parseFlags
+/*! \see Reader::Parse, Document::Parse, Document::ParseInsitu, Document::ParseStream
+ */
 enum ParseFlag {
 	kParseDefaultFlags = 0,			//!< Default parse flags. Non-destructive parsing. Text strings are decoded into allocated buffer.
 	kParseInsituFlag = 1,			//!< In-situ(destructive) parsing.
@@ -257,7 +259,7 @@ template<> inline void SkipWhitespace(StringStream& is) {
 ///////////////////////////////////////////////////////////////////////////////
 // GenericReader
 
-//! SAX-style JSON parser. Use Reader for UTF8 encoding and default allocator.
+//! SAX-style JSON parser. Use \ref Reader for UTF8 encoding and default allocator.
 /*! GenericReader parses JSON text from a stream, and send events synchronously to an 
     object implementing Handler concept.
 
@@ -276,7 +278,7 @@ template<> inline void SkipWhitespace(StringStream& is) {
 template <typename SourceEncoding, typename TargetEncoding, typename Allocator = MemoryPoolAllocator<> >
 class GenericReader {
 public:
-	typedef typename SourceEncoding::Ch Ch;
+	typedef typename SourceEncoding::Ch Ch; //!< SourceEncoding character type
 
 	//! Constructor.
 	/*! \param allocator Optional allocator for allocating stack memory. (Only use for non-destructive parsing)
@@ -285,12 +287,12 @@ public:
 	GenericReader(Allocator* allocator = 0, size_t stackCapacity = kDefaultStackCapacity) : stack_(allocator, stackCapacity), parseErrorCode_(kParseErrorNone), errorOffset_(0) {}
 
 	//! Parse JSON text.
-	/*! \tparam parseFlags Combination of ParseFlag. 
-		 \tparam InputStream Type of input stream.
-		 \tparam Handler Type of handler which must implement Handler concept.
-		 \param is Input stream to be parsed.
-		 \param handler The handler to receive events.
-		 \return Whether the parsing is successful.
+	/*! \tparam parseFlags Combination of \ref ParseFlag.
+		\tparam InputStream Type of input stream, implementing Stream concept.
+		\tparam Handler Type of handler, implementing Handler concept.
+		\param is Input stream to be parsed.
+		\param handler The handler to receive events.
+		\return Whether the parsing is successful.
 	*/
 	template <unsigned parseFlags, typename InputStream, typename Handler>
 	bool Parse(InputStream& is, Handler& handler) {
@@ -321,6 +323,13 @@ public:
 		return !HasParseError();
 	}
 
+	//! Parse JSON text (with \ref kParseDefaultFlags)
+	/*! \tparam InputStream Type of input stream, implementing Stream concept
+		\tparam Handler Type of handler, implementing Handler concept.
+		\param is Input stream to be parsed.
+		\param handler The handler to receive events.
+		\return Whether the parsing is successful.
+	*/
 	template <typename InputStream, typename Handler>
 	bool Parse(InputStream& is, Handler& handler) {
 		return Parse<kParseDefaultFlags>(is, handler);