Websocket documentation change

ppapi/c/ppb_websocket.h

 /* Copyright (c) 2012 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.
  */
 
-/* From ppb_websocket.idl modified Wed Mar 14 01:49:27 2012. */
+/* From ppb_websocket.idl modified Fri Mar 23 15:38:12 2012. */
 
 #ifndef PPAPI_C_PPB_WEBSOCKET_H_
 #define PPAPI_C_PPB_WEBSOCKET_H_
 
 #include "ppapi/c/pp_bool.h"
 #include "ppapi/c/pp_completion_callback.h"
 #include "ppapi/c/pp_instance.h"
 #include "ppapi/c/pp_macros.h"
 #include "ppapi/c/pp_resource.h"
 #include "ppapi/c/pp_stdint.h"
@@ skipping 202 matching lines @@
    * connection.
    *
    * @return An int32_t containing an error code from <code>pp_errors.h</code>.
    * Returns <code>PP_ERROR_BADARGUMENT</code> if the specified
    * <code>url</code>, or <code>protocols</code> contain an invalid string as
    * defined in the WebSocket API specification.
    * <code>PP_ERROR_BADARGUMENT</code> corresponds to a SyntaxError in the
    * WebSocket API specification.
    * Returns <code>PP_ERROR_NOACCESS</code> if the protocol specified in the
    * <code>url</code> is not a secure protocol, but the origin of the caller
-   * has a secure scheme. Also returns <code>PP_ERROR_NOACCESS</CODE> if the
+   * has a secure scheme. Also returns <code>PP_ERROR_NOACCESS</code> if the
    * port specified in the <code>url</code> is a port that the user agent
    * is configured to block access to because it is a well-known port like
-   * SMTP. <code>PP_ERROR_NOACCESS</code> corresponds to SecurityError of the
+   * SMTP. <code>PP_ERROR_NOACCESS</code> corresponds to a SecurityError of the
    * specification.
    * Returns <code>PP_ERROR_INPROGRESS</code> if this is not the first call to
    * Connect().
    */
   int32_t (*Connect)(PP_Resource web_socket,
                      struct PP_Var url,
                      const struct PP_Var protocols[],
                      uint32_t protocol_count,
                      struct PP_CompletionCallback callback);
   /**
    * Close() closes the specified WebSocket connection by specifying
    * <code>code</code> and <code>reason</code>.
    *
    * @param[in] web_socket A <code>PP_Resource</code> corresponding to a
    * WebSocket.
    *
-   * @param[in] code The WebSocket close code. Ignored if it is 0.
+   * @param[in] code The WebSocket close code. This is ignored if it is 0.
    * <code>PP_WEBSOCKETSTATUSCODE_NORMAL_CLOSURE</code> must be used for the
    * usual case. To indicate some specific error cases, codes in the range
    * <code>PP_WEBSOCKETSTATUSCODE_USER_REGISTERED_MIN</code> to
    * <code>PP_WEBSOCKETSTATUSCODE_USER_REGISTERED_MAX</code>, and in the range
    * <code>PP_WEBSOCKETSTATUSCODE_USER_PRIVATE_MIN</code> to
    * <code>PP_WEBSOCKETSTATUSCODE_USER_PRIVATE_MAX</code> are available.
    *
    * @param[in] reason A <code>PP_Var</code> representing the WebSocket
    * close reason. This is ignored if it is <code>PP_VARTYPE_UNDEFINED</code>.
    * Otherwise, its <code>PP_VarType</code> must be
    * <code>PP_VARTYPE_STRING</code>.
    *
    * @param[in] callback A <code>PP_CompletionCallback</code> called
    * when the connection is closed or an error occurs in closing the
    * connection.
    *
    * @return An int32_t containing an error code from <code>pp_errors.h</code>.
    * Returns <code>PP_ERROR_BADARGUMENT</code> if <code>reason</code> contains
    * an invalid character as a UTF-8 string, or is longer than 123 bytes.
    * <code>PP_ERROR_BADARGUMENT</code> corresponds to a JavaScript SyntaxError
    * in the WebSocket API specification.
    * Returns <code>PP_ERROR_NOACCESS</code> if the code is not an integer
    * equal to 1000 or in the range 3000 to 4999. <code>PP_ERROR_NOACCESS</code>
-   * corresponds to InvalidAccessError of the specification. Returns
-   * <code>PP_ERROR_INPROGRESS</code> if this is not the first call to
+   * corresponds to a InvalidAccessError in the WebSocket API specification.
+   * Returns <code>PP_ERROR_INPROGRESS</code> if this is not the first call to
    * Close().
    */
   int32_t (*Close)(PP_Resource web_socket,
                    uint16_t code,
                    struct PP_Var reason,
                    struct PP_CompletionCallback callback);
   /**
    * ReceiveMessage() receives a message from the WebSocket server.
    * This interface only returns a single message. That is, this interface must
    * be called at least N times to receive N messages, no matter the size of
@@ skipping 27 matching lines @@
    * WebSocket.
    *
    * @param[in] message A message to send. The message is copied to an internal
    * buffer, so the caller can free <code>message</code> safely after returning
    * from the function. Its sent <code>PP_VarType</code> must be
    * <code>PP_VARTYPE_STRING</code> or <code>PP_VARTYPE_ARRAY_BUFFER</code>.
    *
    * @return An int32_t containing an error code from <code>pp_errors.h</code>.
    * Returns <code>PP_ERROR_FAILED</code> if the ReadyState is
    * <code>PP_WEBSOCKETREADYSTATE_CONNECTING</code>.
-   * <code>PP_ERROR_FAILED</code> corresponds to the JavaScript
+   * <code>PP_ERROR_FAILED</code> corresponds to a JavaScript
    * InvalidStateError in the WebSocket API specification.
    * Returns <code>PP_ERROR_BADARGUMENT</code> if the provided
    * <code>message</code> contains an invalid character as a UTF-8 string.
-   * <code>PP_ERROR_BADARGUMENT</code> corresponds to the JavaScript
+   * <code>PP_ERROR_BADARGUMENT</code> corresponds to a JavaScript
    * SyntaxError in the WebSocket API specification.
    * Otherwise, returns <code>PP_OK</code>, which doesn't necessarily mean
    * that the server received the message.
    */
   int32_t (*SendMessage)(PP_Resource web_socket, struct PP_Var message);
   /**
    * GetBufferedAmount() returns the number of bytes of text and binary
    * messages that have been queued for the WebSocket connection to send, but
    * have not been transmitted to the network yet.
    *
@@ skipping 88 matching lines @@
   struct PP_Var (*GetURL)(PP_Resource web_socket);
 };
 
 typedef struct PPB_WebSocket_1_0 PPB_WebSocket;
 /**
  * @}
  */
 
 #endif  /* PPAPI_C_PPB_WEBSOCKET_H_ */