Update comments of the Pepper networking APIs.

ppapi/api/dev/ppb_host_resolver_dev.idl

Index: ppapi/api/dev/ppb_host_resolver_dev.idl
diff --git a/ppapi/api/dev/ppb_host_resolver_dev.idl b/ppapi/api/dev/ppb_host_resolver_dev.idl
index cf274341534625e603adb3dc0b463085073dfa47..6a7ee9ddb8e5ee78200e5896ce5876bc6857b465 100644
--- a/ppapi/api/dev/ppb_host_resolver_dev.idl
+++ b/ppapi/api/dev/ppb_host_resolver_dev.idl
@@ -5,7 +5,6 @@
 
 /**
  * This file defines the <code>PPB_HostResolver_Dev</code> interface.
- * TODO(yzshen): Tidy up the document.
  */
 
 [generate_thunk]
@@ -15,44 +14,85 @@ label Chrome {
 };
 
 /**
- * The <code>PP_HostResolver_Flags_Dev</code> is an enumeration of the
- * different types of flags, that can be OR-ed and passed to host
- * resolver.
+ * <code>PP_HostResolver_Flags_Dev</code> is an enumeration of flags which can
+ * be OR-ed and passed to the host resolver. Currently there is only one flag

[bbudge, 2013/06/20 17:38:27]

I think the last sentence is unnecessary.

[yzshen1, 2013/06/20 20:27:45]

According to offline discussion, I will keep it as it is.
Thanks!

On 2013/06/20 17:38:27, bbudge1 wrote:

+ * defined.
  */
 [assert_size(4)]
 enum PP_HostResolver_Flags_Dev {
   /**
-   * AI_CANONNAME
+   * Requests the canonical name of the host, which can be retrieved by

[bbudge, 2013/06/20 17:38:27]

s/Requests/Hint to request/

[yzshen1, 2013/06/20 20:27:45]

Done.

+   * <code>GetCanonicalName()</code>.
    */
-  PP_HOSTRESOLVER_FLAGS_CANONNAME = 1 << 0,
-  /**
-   * Hint to the resolver that only loopback addresses are configured.
-   */
-  PP_HOSTRESOLVER_FLAGS_LOOPBACK_ONLY = 1 << 1
+  PP_HOSTRESOLVER_FLAGS_CANONNAME = 1 << 0
 };
 
+/**
+ * <code>PP_HostResolver_Hint_Dev</code> represents hints for host resolution.
+ */
 [assert_size(8)]
 struct PP_HostResolver_Hint_Dev {
+  /**
+   * Network address family.
+   */
   PP_NetAddress_Family_Dev family;
+  /**
+   * Combination of flags from <code>PP_HostResolver_Flags_Dev</code>.
+   */
   int32_t flags;
 };
 
+/**
+ * The <code>PPB_HostResolver_Dev</code> interface supports host name
+ * resolution.
+ *
+ * Permissions: In order to run <code>Resolve()</code>, apps permission
+ * <code>socket</code> with subrule <code>resolve-host</code> is required.
+ * For more details about network communication permissions, please see:
+ * http://developer.chrome.com/apps/app_network.html
+ */
 interface PPB_HostResolver_Dev {
   /**
-   * Allocates a Host Resolver resource.
+   * Creates a host resolver resource.
+   *
+   * @param[in] instance A <code>PP_Instance</code> identifying one instance of
+   * a module.
+   *
+   * @return A <code>PP_Resource</code> corresponding to a host reslover or 0
+   * on failure.
    */
   PP_Resource Create([in] PP_Instance instance);
 
   /**
-   * Determines if a given resource is a Host Resolver.
+   * Determines if a given resource is a host resolver.
+   *
+   * @param[in] resource A <code>PP_Resource</code> to check.
+   *
+   * @return <code>PP_TRUE</code> if the input is a
+   * <code>PPB_HostResolver_Dev</code> resource; <code>PP_FALSE</code>
+   * otherwise.
    */
   PP_Bool IsHostResolver([in] PP_Resource resource);
 
   /**
-   * Creates a new request to Host Resolver. |callback| is invoked when request
-   * is processed and a list of network addresses is obtained. These addresses
-   * can be used in Connect, Bind or Listen calls to connect to a given |host|
-   * and |port|.
+   * Requests to resolve a host name. When the call completes successfully, the

[bbudge, 2013/06/20 17:38:27]

s/Requests to resolve/Requests resolution of/
s/When/If

[yzshen1, 2013/06/20 20:27:45]

Done.

+   * results can be retrieved by <code>GetCanonicalName()</code>,
+   * <code>GetNetAddressCount()</code> and <code>GetNetAddress()</code>.
+   *
+   * @param[in] host_resolver A <code>PP_Resource</code> corresponding to a host
+   * resolver.
+   * @param[in] host The host name (or IP address literal) to resolve.
+   * @param[in] port The port number to be set in the resulting network
+   * addresses.
+   * @param[in] hint A <code>PP_HostResolver_Hint_Dev</code> structure providing
+   * hints for host resolution.
+   * @param[in] callback A <code>PP_CompletionCallback</code> to be called upon
+   * completion.
+   *
+   * @return An int32_t containing an error code from <code>pp_errors.h</code>.
+   * <code>PP_ERROR_NOACCESS</code> will be returned if the caller doesn't have
+   * required permissions. <code>PP_ERROR_NAME_NOT_RESOLVED</code> will be
+   * returned if the host name couldn't be resolved.

[bbudge, 2013/06/20 17:38:27]

PP_ERROR_FAILED on other browser errors, correct?

[yzshen1, 2013/06/20 20:27:45]

There are quite a few, for example, FAILED, INPROGRESS, BADARGUMENT,
BADRESOURCE, etc. I think we don't have to mention all of those common ones.
What do you think?
On 2013/06/20 17:38:27, bbudge1 wrote:

[bbudge, 2013/06/20 21:02:32]

OK

    */
   int32_t Resolve([in] PP_Resource host_resolver,
                   [in] str_t host,
@@ -61,21 +101,41 @@ interface PPB_HostResolver_Dev {
                   [in] PP_CompletionCallback callback);
 
   /**
-   * Gets canonical name of host. Returns an undefined var if there is a pending
-   * Resolve call or the previous Resolve call failed.
+   * Gets the canonical name of the host.
+   *
+   * @param[in] host_resolver A <code>PP_Resource</code> corresponding to a host
+   * resolver.
+   *
+   * @return A string <code>PP_Var</code> on success, which is an empty string
+   * if <code>PP_HOSTRESOLVER_FLAGS_CANONNAME</code> is not specified when

[bbudge, 2013/06/20 17:38:27]

s/specified/set in the hint flags/

[yzshen1, 2013/06/20 20:27:45]

Done.

+   * calling <code>Resolve()</code>; an undefined <code>PP_Var</code> if there
+   * is a pending <code>Resolve()</code> call or the previous
+   * <code>Resolve()</code> call failed.
    */
   PP_Var GetCanonicalName([in] PP_Resource host_resolver);
 
   /**
-   * Gets number of network addresses obtained after Resolve call. Returns 0 if
-   * there is a pending Resolve call or the previous Resolve call failed.
+   * Gets the number of network addresses.
+   *
+   * @param[in] host_resolver A <code>PP_Resource</code> corresponding to a host
+   * resolver.
+   *
+   * @return The number of available network addresses on success; 0 if there is
+   * a pending <code>Resolve()</code> call or the previous
+   * <code>Resolve()</code> call failed.
    */
   uint32_t GetNetAddressCount([in] PP_Resource host_resolver);
 
   /**
-   * Gets the |index|-th network address.
-   * Returns 0 if there is a pending Resolve call or the previous Resolve call
-   * failed, or |index| is not less than the number of available addresses.
+   * Gets a network address.
+   *
+   * @param[in] host_resolver A <code>PP_Resource</code> corresponding to a host
+   * resolver.
+   * @param[in] index An index indicating which address to return.
+   *
+   * @return A <code>PPB_NetAddress_Dev</code> resource on success; 0 if there
+   * is a pending <code>Resolve()</code> call or the previous
+   * <code>Resolve()</code> call failed, or the specified index is out of range.
    */
   PP_Resource GetNetAddress([in] PP_Resource host_resolver,
                             [in] uint32_t index);