Fixing up some reference documentation comments.

stgates · stgates · commit 995bda8acd4a · 2015-03-20T16:43:47.000-07:00
diff --git a/Release/include/cpprest/astreambuf.h b/Release/include/cpprest/astreambuf.h
@@ -763,10 +763,6 @@ namespace streams
     /// <typeparam name="_CharType2">
     /// The data type of the basic element of the <c>streambuf.</c>
     /// </typeparam>
-    /// <remarks>
-    /// The rationale for refcounting is discussed in the accompanying design
-    /// documentation.
-    /// </remarks>
     template<typename _CharType>
     class streambuf : public details::basic_streambuf<_CharType>
     {
@@ -887,13 +883,13 @@ namespace streams
         virtual bool can_write() const { return  get_base()->can_write(); }
 
         /// <summary>
-        /// <c>can_seek<c/> is used to determine whether a stream buffer supports seeking.
+        /// <c>can_seek</c> is used to determine whether a stream buffer supports seeking.
         /// </summary>
         /// <returns>True if seeking is supported, false otherwise.</returns>
         virtual bool can_seek() const { return get_base()->can_seek(); }
 
         /// <summary>
-        /// <c>has_size<c/> is used to determine whether a stream buffer supports size().
+        /// <c>has_size</c> is used to determine whether a stream buffer supports size().
         /// </summary>
         /// <returns>True if the <c>size</c> API is supported, false otherwise.</returns>
         virtual bool has_size() const { return get_base()->has_size(); }
diff --git a/Release/include/cpprest/http_headers.h b/Release/include/cpprest/http_headers.h
@@ -153,7 +153,7 @@ class http_headers
     /// </summary>
     /// <param name="name">The name of the header field.</param>
     /// <param name="value">The value of the header field.</param>
-    /// <remark>If the header field exists, the value will be combined as comma separated string.</remark>
+    /// <remarks>If the header field exists, the value will be combined as comma separated string.</remarks>
     template<typename _t1>
     void add(const key_type& name, const _t1& value)
     {
diff --git a/Release/include/cpprest/http_msg.h b/Release/include/cpprest/http_msg.h
@@ -491,7 +491,7 @@ class http_response
     }
 
     /// <summary>
-    /// Extracts the body of the response message into a json value, checking that the content type is application\json.
+    /// Extracts the body of the response message into a json value, checking that the content type is application/json.
     /// A body can only be extracted once because in some cases an optimization is made where the data is 'moved' out.
     /// </summary>
     /// <param name="ignore_content_type">If true, ignores the Content-Type header and assumes UTF-8.</param>
@@ -612,6 +612,7 @@ class http_response
     /// sent.
     /// </summary>
     /// <param name="stream">A readable, open asynchronous stream.</param>
+    /// <param name="content_type">A string holding the MIME type of the message body.</param>
     /// <remarks>
     /// This cannot be used in conjunction with any other means of setting the body of the request.
     /// The stream will not be read until the message is sent.
@@ -887,7 +888,7 @@ class http_request
     }
 
     /// <summary>
-    /// Extracts the body of the request message into a json value, checking that the content type is application\json.
+    /// Extracts the body of the request message into a json value, checking that the content type is application/json.
     /// A body can only be extracted once because in some cases an optimization is made where the data is 'moved' out.
     /// </summary>
     /// <param name="ignore_content_type">If true, ignores the Content-Type header and assumes UTF-8.</param>
@@ -966,7 +967,7 @@ class http_request
     /// Sets the body of the message to contain json value. If the 'Content-Type'
     /// header hasn't already been set it will be set to 'application/json'.
     /// </summary>
-    /// <param name="body_text">json value.</param>
+    /// <param name="body_data">json value.</param>
     /// <remarks>
     /// This will overwrite any previously set body data.
     /// </remarks>
@@ -1009,6 +1010,7 @@ class http_request
     /// sent.
     /// </summary>
     /// <param name="stream">A readable, open asynchronous stream.</param>
+    /// <param name="content_type">A string holding the MIME type of the message body.</param>
     /// <remarks>
     /// This cannot be used in conjunction with any other means of setting the body of the request.
     /// The stream will not be read until the message is sent.
diff --git a/Release/include/cpprest/json.h b/Release/include/cpprest/json.h
@@ -592,7 +592,7 @@ namespace json
         /// <summary>
         /// Accesses an element of a JSON array.
         /// </summary>
-        /// <param name="key">The index of an element in the JSON array</param>
+        /// <param name="index">The index of an element in the JSON array</param>
         /// <returns>The value kept at the array index; null if outside the boundaries of the array</returns>
         CASABLANCA_DEPRECATED("This API is deprecated and will be removed in a future release, use json::value::at() instead.")
         value get(size_t index) const;
diff --git a/Release/include/cpprest/oauth1.h b/Release/include/cpprest/oauth1.h
@@ -161,13 +161,13 @@ class oauth1_token
     /// <summary>
     /// Set access token.
     /// </summary>
-    /// <param name="token">Access token string to set.</param>
+    /// <param name="access_token">Access token string to set.</param>
     void set_access_token(utility::string_t &&access_token) { m_token = std::move(access_token); }
 
     /// <summary>
     /// Set access token.
     /// </summary>
-    /// <param name="token">Access token string to set.</param>
+    /// <param name="access_token">Access token string to set.</param>
     void set_access_token(const utility::string_t &access_token) { m_token = access_token; }
 
     /// <summary>

Original file line number	Diff line number	Diff line change
`@@ -153,7 +153,7 @@ class http_headers`
`153`	`153`	`/// </summary>`
`154`	`154`	`/// <param name="name">The name of the header field.</param>`
`155`	`155`	`/// <param name="value">The value of the header field.</param>`
`156`		`- /// <remark>If the header field exists, the value will be combined as comma separated string.</remark>`
	`156`	`+ /// <remarks>If the header field exists, the value will be combined as comma separated string.</remarks>`
`157`	`157`	`template<typename _t1>`
`158`	`158`	`void add(const key_type& name, const _t1& value)`
`159`	`159`	`{`