Websocket documentation change

ppapi/api/ppb_websocket.idl

 /* 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.
  */
 
 /**
  * This file defines the <code>PPB_WebSocket</code> interface providing
  * bi-directional, full-duplex, communications over a single TCP socket.
  */
 label Chrome {
@@ skipping 205 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([in] PP_Resource web_socket,
                   [in] PP_Var url,
                   [in, size_as=protocol_count] PP_Var[] protocols,
                   [in] uint32_t protocol_count,
                   [in] 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.

[Takashi Toyoshima, 2012/03/26 08:14:06]

'an'?

[jond, 2012/03/26 15:53:49]

Done.

+   * Returns <code>PP_ERROR_INPROGRESS</code> if this is not the first call to
    * Close().
    */
   int32_t Close([in] PP_Resource web_socket,
                 [in] uint16_t code,
                 [in] PP_Var reason,
                 [in] PP_CompletionCallback callback);
 
   /**
    * ReceiveMessage() receives a message from the WebSocket server.
    * This interface only returns a single message. That is, this interface must
@@ skipping 29 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([in] PP_Resource web_socket,
                       [in] 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
@@ skipping 89 matching lines @@
    * @param[in] web_socket A <code>PP_Resource</code> corresponding to a
    * WebSocket.
    *
    * @return Returns a <code>PP_VARTYPE_STRING</code> var. If called before the
    * connection is established, the var contains the empty string. Returns a
    * <code>PP_VARTYPE_UNDEFINED</code> if this function is called on an
    * invalid resource.
    */
   PP_Var GetURL([in] PP_Resource web_socket);
 };