C++ documentation for URL Loading classes

ppapi/cpp/url_request_info.h

 // Copyright (c) 2011 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef PPAPI_CPP_URL_REQUEST_INFO_H_
 #define PPAPI_CPP_URL_REQUEST_INFO_H_
 
 #include "ppapi/c/ppb_url_request_info.h"
 #include "ppapi/cpp/resource.h"
 #include "ppapi/cpp/var.h"
 
+/// @file
+/// This file defines the API to create and manipulate URL requests.

[polina, 2011/08/01 10:35:51]

API for creating ... (to match C interface and description below)

[jond, 2011/08/01 21:03:09]

Done.

 namespace pp {
 
 class FileRef_Dev;
 class Instance;
 
+/// URLRequestInfo provides an API for creating and manipulating URL requests.
 class URLRequestInfo : public Resource {
  public:
-  // Creates an is_null resource.
+  /// Default constructor. This constructor creates an
+  /// <code>is_null</code> resource.
   URLRequestInfo() {}
 
+  /// A constructor used when an <code>Instance</code> is provided as a return

[polina, 2011/08/01 10:35:51]

This is wrong. See URLLoader constructor comment.

[jond, 2011/08/01 21:03:09]

Done.

+  /// value whose reference count we need to increment.
+  ///
+  /// @param[in] instance An <code>Instance</code>.
   explicit URLRequestInfo(Instance* instance);
+
+  /// A constructor for copying an <code>URLRequestInfo</code>.

[polina, 2011/08/01 10:35:51]

The copy constructor for URLRequestInfo.

[jond, 2011/08/01 21:03:09]

Done.

+  ///
+  /// @param[in] other A <code>URLRequestInfo</code> to be copied.
   URLRequestInfo(const URLRequestInfo& other);
 
-  // PPB_URLRequestInfo methods:
+  /// SetProperty() sets a request property. The value of the property must be
+  /// the correct type according to the property being set.
+  ///
+  /// @param[in] property A <code>URLRequestProperty</code> identifying the

[polina, 2011/08/01 10:35:51]

PP_URLRequestProperty

[jond, 2011/08/01 21:03:09]

Done.

+  /// property to set.
+  /// @param[in] value A <code>Var</code> containing the property value.
+  ///
+  /// @return True if successful, false if any of the
+  /// parameters are invalid.
   bool SetProperty(PP_URLRequestProperty property, const Var& value);
+
+  /// AppendDataToBody() appends data to the request body. A Content-Length
+  /// request header will be automatically generated.
+  ///
+  /// @param[in] data A pointer to a buffer holding the data.
+  /// @param[in] len The length, in bytes, of the data.
+  ///
+  /// @return True if successful, false if any of the
+  /// parameters are invalid.
   bool AppendDataToBody(const void* data, uint32_t len);
+
+  /// AppendFileToBody() is used to append an entire file, to be uploaded, to
+  /// the request body. A content-length request header will be automatically

[polina, 2011/08/01 10:35:51]

inconsistent: previous comment says Content-Length

[jond, 2011/08/01 21:03:09]

Done.

+  /// generated.
+  ///
+  /// @param[in] file_ref A <code>PP_Resource</code> containing the file

[polina, 2011/08/01 10:35:51]

FileRef_Dev, not PP_Resource

[jond, 2011/08/01 21:03:09]

Done.

[jond, 2011/08/01 21:03:09]

Done.

+  /// reference.
+
+  /// @param[in] expected_last_modified_time An optional (non-zero) last
+  /// modified time stamp used to validate that the file was not modified since
+  /// the given time before it was uploaded. The upload will fail with an error
+  /// code of <code>PP_ERROR_FILECHANGED</code> if the file has been modified
+  /// since the given time. If expected_last_modified_time is 0, then no
+  /// validation is performed.
+  ///
+  /// @return True if successful, false if any of the
+  /// parameters are invalid.
   bool AppendFileToBody(const FileRef_Dev& file_ref,
                         PP_Time expected_last_modified_time = 0);
+
+  /// AppendFileRangeToBody() is a pointer to a function used to append part or
+  /// all of a file, to be uploaded, to the request body. A content-length
+  /// request header will be automatically generated.
+  ///
+  /// @param[in] file_ref A <code>FileRef_Dev</code> containing the file
+  /// reference.
+  /// @param[in] start_offset An optional starting point offset within the
+  /// file.
+  /// @param[in] length An optional number of bytes of the file to
+  /// be included.

[polina, 2011/08/01 10:35:51]

If -1, then the sub-range to upload extends to the end of the file.

[jond, 2011/08/01 21:03:09]

Done.

[jond, 2011/08/01 21:03:09]

Done.

+  /// @param[in] expected_last_modified_time An optional (non-zero) last
+  /// modified time stamp used to validate that the file was not modified since
+  /// the given time before it was uploaded. The upload will fail with an error
+  /// code of <code>PP_ERROR_FILECHANGED</code> if the file has been modified
+  /// since the given time. If expected_last_modified_time is 0, then no
+  /// validation is performed.
+  ///
+  /// @return True if successful, false if any of the
+  /// parameters are invalid.
   bool AppendFileRangeToBody(const FileRef_Dev& file_ref,
                              int64_t start_offset,
                              int64_t length,
                              PP_Time expected_last_modified_time = 0);
 
-  // Convenient helpers for setting properties:
+  /// SetURL() sets the <code>PP_URLREQUESTPROPERTY_URL</code>
+  /// (corresponding to a string of type <code>PP_VARTYPE_STRING</code>)

[polina, 2011/08/01 10:35:51]

I don't think the info in () is necessary. First of all, it is a C reference in
a comment for a function that is designed to abstract out the C interface. Plus
this is already covered by the header that defines these properties.

[jond, 2011/08/01 21:03:09]

Done.

[jond, 2011/08/01 21:03:09]

Done.

[polina, 2011/08/03 00:28:33]

If you agree that this should be removed, please do this for every function.

Moreover, it would be nice if you used the same trick you followed in the other
file where the is_string type reference is added to the arg description.

E.g. @param ... An <code>is_string Var</code> containing....

+  /// property for the request.
+  ///
+  /// @param[in] url_string A <code>Var</code> containing the property value.
+  ///
+  /// @return True if successful, false if any of the parameters are invalid.

[polina, 2011/08/01 10:35:51]

these is only one parameter
(same for other functions)

[jond, 2011/08/01 21:03:09]

Done.

   bool SetURL(const Var& url_string) {
     return SetProperty(PP_URLREQUESTPROPERTY_URL, url_string);
   }
+
+  /// SetMethod() sets the <code>PP_URLREQUESTPROPERTY_METHOD</code>
+  /// (corresponding to a string of type <code>PP_VARTYPE_STRING</code>)
+  /// property for the request. This string is either a POST or GET. Refer to
+  /// the <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec5.html">HTTP
+  /// Methods</a> documentation for further information.
+  ///
+  /// @param[in] method_string A <code>Var</code> containing the property
+  /// value.
+  ///
+  /// @return True if successful, false if any of the parameters are invalid.
   bool SetMethod(const Var& method_string) {
     return SetProperty(PP_URLREQUESTPROPERTY_METHOD, method_string);
   }
+
+  /// SetHeaders() sets the <code>PP_URLREQUESTPROPERTY_HEADERS</code>
+  /// (corresponding to a <code>\n</code> delimited string of type
+  /// <code>PP_VARTYPE_STRING</code>) property for the request.
+  /// Refer to the
+  /// <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html"Header
+  /// Field Definitions</a> documentaiton for further information.
+  ///
+  /// @param[in] headers_string A <code>Var</code> containing the property
+  /// value.
+  ///
+  /// @return True if successful, false if any of the parameters are invalid.
   bool SetHeaders(const Var& headers_string) {
     return SetProperty(PP_URLREQUESTPROPERTY_HEADERS, headers_string);
   }
+  /// SetStreamToFile() sets the
+  /// </code>PP_URLREQUESTPROPERTY_STREAMTOFILE</code> (corresponding
+  /// to a bool of type <code>PP_VARTYPE_BOOL</code>). The default of the bool

[polina, 2011/08/01 10:35:51]

"default of the bool" sounds odd
how about:
the default of the property is
the default value is
(same for all other functions please)

[jond, 2011/08/01 21:03:09]

Done.

+  /// is false. Set this value to true if you want to download the data to a
+  /// file. Use URL_Loader::FinishStreamingToFile() to complete the download.
+  ///
+  /// @param[in] enable A <code>Var</code> containing the property value.

[polina, 2011/08/01 10:35:51]

bool, not Var
(same for all other)

[jond, 2011/08/01 21:03:09]

Done.

+  ///
+  /// @return True if successful, false if any of the parameters are invalid.
   bool SetStreamToFile(bool enable) {
     return SetProperty(PP_URLREQUESTPROPERTY_STREAMTOFILE, enable);
   }
+
+  /// SetFollowRedirects() sets the
+  /// <code>PP_URLREQUESTPROPERTY_FOLLOWREDIRECT</code> (corresponding
+  /// to a bool of type <code>PP_VARTYPE_BOOL</code>). The default of the bool
+  /// is true. Set this value to false if you want to use
+  /// URLLoader::FollowRedirects() to follow the redirects only after examining
+  /// redirect headers.
+  ///
+  /// @param[in] enable A <code>Var</code> containing the property value.

[polina, 2011/08/01 10:35:51]

bool, not Var

[jond, 2011/08/01 21:03:09]

Done.

+  ///
+  /// @return True if successful, false if any of the parameters are invalid.
   bool SetFollowRedirects(bool enable) {
     return SetProperty(PP_URLREQUESTPROPERTY_FOLLOWREDIRECTS, enable);
   }
+
+  /// SetRecordDownloadProgress() sets the
+  /// <code>PP_URLREQUESTPROPERTY_RECORDDOWNLOADPROGESS</code>
+  /// (corresponding to a bool of type <code>PP_VARTYPE_BOOL</code>). The
+  /// default of the bool is false. Set this value to true if you want to be
+  /// able to poll the download progress using
+  /// URLLoader::GetDownloadProgress().
+  ///
+  /// @param[in] enable A <code>Var</code> containing the property value.
+  ////
+  /// @return True if successful, false if any of the parameters are invalid.
   bool SetRecordDownloadProgress(bool enable) {
     return SetProperty(PP_URLREQUESTPROPERTY_RECORDDOWNLOADPROGRESS, enable);
   }
+
+  /// SetRecordUploadProgress() sets the
+  /// <code>PP_URLREQUESTPROPERTY_RECORDUPLOADPROGRESS</code>
+  /// (corresponding to a bool of type <code>PP_VARTYPE_BOOL</code>). The
+  /// default of the bool is false. Set this value to true if you want to be
+  /// able to poll the upload progress using URLLoader::GetUploadProgress().
+  ///
+  /// @param[in] enable A <code>Var</code> containing the property value.
+  ///
+  /// @return True if successful, false if any of the parameters are invalid.
   bool SetRecordUploadProgress(bool enable) {
     return SetProperty(PP_URLREQUESTPROPERTY_RECORDUPLOADPROGRESS, enable);
   }
-  // To use the default referrer, set url to an Undefined Var.
+
+  /// SetCustomReferrerURL() sets the
+  /// <code>PP_URLREQUESTPROPERTY_CUSTOMREFERRERURL</code>
+  /// (corresponding to a string of type <code>PP_VARTYPE_STRING</code> or
+  /// might be set to undefined as <code>PP_VARTYPE_UNDEFINED</code>). Set it
+  /// to a string to set a custom referrer (if empty, the referrer header will
+  /// be omitted), or to undefined to use the default referrer. Only loaders
+  /// with universal access (only available on trusted implementations) will
+  /// accept <code>URLRequestInfo</code> objects that try to set a custom
+  /// referrer; if given to a loader without universal access,
+  /// <code>PP_ERROR_BADARGUMENT</code> will result.
+  ///
+  /// @param[in] url A <code>Var</code> containing the property value.
+  ///
+  /// @return True if successful, false if any of the parameters are invalid.
   bool SetCustomReferrerURL(const Var& url) {
     return SetProperty(PP_URLREQUESTPROPERTY_CUSTOMREFERRERURL, url);
   }
+
+  /// SetAllowCrossOriginRequests() sets the
+  /// </code>PP_URLREQUESTPROPERTY_ALLOWCROSSORIGINREQUESTS</code>
+  /// (corresponding to a bool of type <code>PP_VARTYPE_BOOL</code>). The
+  /// default of the bool is false. Whether cross-origin requests are
+  /// allowed. Cross-origin requests are made using the CORS (Cross-Origin
+  /// Resource Sharing) algorithm to check whether the request should be
+  /// allowed. For the complete CORS algorithm, refer to the
+  /// <a href="http://www.w3.org/TR/access-control">Cross-Origin Resource
+  /// Sharing</a> documentation.
+  ///
+  /// @param[in] enable A <code>Var</code> containing the property value.
+  ///
+  /// @return True if successful, false if any of the parameters are invalid.
   bool SetAllowCrossOriginRequests(bool enable) {
     return SetProperty(PP_URLREQUESTPROPERTY_ALLOWCROSSORIGINREQUESTS, enable);
   }
+
+  /// SetAllowCredentials() sets the
+  /// <code>PP_URLREQUESTPROPERTY_ALLOWCREDENTIALS</code>
+  /// (corresponding to a bool of type <code>PP_VARTYPE_BOOL</code>). The
+  /// default of the bool is false. Whether HTTP credentials are sent with
+  /// cross-origin requests. If false, no credentials are sent with the request
+  /// and cookies are ignored in the response. If the request is not
+  /// cross-origin, this property is ignored.
+  ///
+  /// @param[in] enable A <code>Var</code> containing the property value.
+  ///
+  /// @return True if successful, false if any of the parameters are invalid.
   bool SetAllowCredentials(bool enable) {
     return SetProperty(PP_URLREQUESTPROPERTY_ALLOWCREDENTIALS, enable);
   }
-  // To use the default content transfer encoding, set content_transfer_encoding
-  // to an Undefined Var.
+
+  /// SetCustomContentTransferEncoding() sets the
+  /// <code>PP_URLREQUESTPROPERTY_CUSTOMCONTENTTRANSFERENCODING</code>
+  /// (corresponding to a string of type <code>PP_VARTYPE_STRING</code> or
+  /// might be set to undefined as <code>PP_VARTYPE_UNDEFINED</code>). Set it
+  /// to a string to set a custom content-transfer-encoding header (if empty,
+  /// that header will be omitted), or to undefined to use the default (if
+  /// any). Only loaders with universal access (only available on trusted
+  /// implementations) will accept <code>URLRequestInfo</code> objects that try
+  /// to set a custom content transfer encoding; if given to a loader without
+  /// universal access, <code>PP_ERROR_BADARGUMENT</code> will result.
+  ///
+  /// @param[in] content_transfer_encoding A <code>Var</code> containing the
+  /// property value. To use the default content transfer encoding, set
+  /// <code>content_transfer_encoding</code> to an undefined <code>Var</code>.
+  ///
+  /// @return True if successful, false if any of the parameters are invalid.
   bool SetCustomContentTransferEncoding(const Var& content_transfer_encoding) {
     return SetProperty(PP_URLREQUESTPROPERTY_CUSTOMCONTENTTRANSFERENCODING,
                        content_transfer_encoding);
   }
+
+  /// SetPrefetchBufferUpperThreshold() sets the
+  /// <code>PP_URLREQUESTPROPERTY_PREFETCHBUFFERUPPERTHRESHOLD</code>
+  /// (corresponding to a integer of type <code>PP_VARTYPE_INT32</code>). The
+  /// default is not defined and is set by the browser possibly depending on
+  /// system capabilities. Set it to an integer to set an upper threshold for
+  /// the prefetched buffer of an asynchronous load. When exceeded, the browser
+  /// will defer loading until
+  /// <code>PP_URLREQUESTPROPERTY_PREFETCHBUFFERLOWERERTHRESHOLD</code> is hit,
+  /// at which time it will begin prefetching again. When setting this
+  /// property,
+  /// <code>PP_URLREQUESTPROPERTY_PREFETCHBUFFERLOWERERTHRESHOLD</code> must
+  /// also be set. Behavior is undefined if the former is <= the latter.
+  ///
+  /// @param[in] size An int32_t containing the property value.
+  /// @return True if successful, false if any of the parameters are invalid.
   bool SetPrefetchBufferUpperThreshold(int32_t size) {
     return SetProperty(PP_URLREQUESTPROPERTY_PREFETCHBUFFERUPPERTHRESHOLD,
                        size);
   }
+
+  /// SetPrefetchBufferLowerThreshold() sets the
+  /// <code>PP_URLREQUESTPROPERTY_PREFETCHBUFFERLOWERTHRESHOLD</code>
+  /// (corresponding to a integer of type <code>PP_VARTYPE_INT32</code>). The
+  /// default is not defined and is set by the browser to a value appropriate
+  /// for the default
+  /// <code>PP_URLREQUESTPROPERTY_PREFETCHBUFFERUPPERTHRESHOLD</code>.
+  /// Set it to an integer to set a lower threshold for the prefetched buffer
+  /// of an asynchronous load. When reached, the browser will resume loading if
+  /// If <code>PP_URLREQUESTPROPERTY_PREFETCHBUFFERLOWERERTHRESHOLD</code> had
+  /// previously been reached.
+  /// When setting this property,
+  /// <code>PP_URLREQUESTPROPERTY_PREFETCHBUFFERUPPERTHRESHOLD</code> must also
+  /// be set. Behavior is undefined if the former is >= the latter.
+  ///
+  /// @param[in] size An int32_t containing the property value.
+  /// @return True if successful, false if any of the parameters are invalid.
   bool SetPrefetchBufferLowerThreshold(int32_t size) {
     return SetProperty(PP_URLREQUESTPROPERTY_PREFETCHBUFFERLOWERTHRESHOLD,
                        size);
   }
 };
 
 }  // namespace pp
 
 #endif  // PPAPI_CPP_URL_REQUEST_INFO_H_