WebSocket Pepper API documents minor revision

ppapi/api/dev/ppb_websocket_dev.idl

Index: ppapi/api/dev/ppb_websocket_dev.idl
diff --git a/ppapi/api/dev/ppb_websocket_dev.idl b/ppapi/api/dev/ppb_websocket_dev.idl
index c4819108e736101932a7a1d96fcee30a84333aab..810222cce1adb733f5948428ae0a20afc324e2ec 100644
--- a/ppapi/api/dev/ppb_websocket_dev.idl
+++ b/ppapi/api/dev/ppb_websocket_dev.idl
@@ -232,9 +232,9 @@ interface PPB_WebSocket_Dev {
    * @param[in] web_socket A <code>PP_Resource</code> corresponding to a
    * WebSocket.
    *
-   * @return Returns a <code>PP_VARTYPE_NULL</code> var if called before the
-   * close reason is set, or <code>PP_VARTYPE_UNDEFINED</code> if called on an
-   * invalid resource.
+   * @return Returns a <code>PP_VARTYPE_STRING</code> var. if called before the
+   * close reason is set, its data is empty string. Returns a
+   * <code>PP_VARTYPE_UNDEFINED</code> if called on an invalid resource.
    */
   PP_Var GetCloseReason([in] PP_Resource web_socket);
 
@@ -246,9 +246,9 @@ interface PPB_WebSocket_Dev {
    * WebSocket.
    *
    * @return Returns <code>PP_FALSE</code> if called before the connection is
-   * closed. Otherwise, returns <code>PP_TRUE</code> if the connection was
-   * closed cleanly and returns <code>PP_FALSE</code> if the connection was
-   * closed by abnormal reasons.
+   * closed, or called on an invalid resource. Otherwise, returns
+   * <code>PP_TRUE</code> if the connection was closed cleanly, or returns
+   * <code>PP_FALSE</code> if the connection was closed by abnormal reasons.
    */
   PP_Bool GetCloseWasClean([in] PP_Resource web_socket);
 
@@ -260,9 +260,9 @@ interface PPB_WebSocket_Dev {
    * WebSocket.
    *
    * @return Returns a <code>PP_VARTYPE_STRING</code> var. If called before the
-   * connection is established or called on an invalid resource, its data is
-   * empty string.
-   * Currently its data is always empty string.
+   * connection is established, its data is empty string. Returns a
+   * <code>PP_VARTYPE_UNDEFINED</code> if called on an invalid resource.
+   * Currently its data for valid resources are always empty string.
    */
   PP_Var GetExtensions([in] PP_Resource web_socket);
 
@@ -274,8 +274,8 @@ interface PPB_WebSocket_Dev {
    * WebSocket.
    *
    * @return Returns a <code>PP_VARTYPE_STRING</code> var. If called before the
-   * connection is established, or called on an invalid resource, its data is
-   * empty string.
+   * connection is established, its data is empty string. Returns a
+   * <code>PP_VARTYPE_UNDEFINED</code> if called on an invalid resource.
    */
   PP_Var GetProtocol([in] PP_Resource web_socket);
 
@@ -286,8 +286,8 @@ interface PPB_WebSocket_Dev {
    * @param[in] web_socket A <code>PP_Resource</code> corresponding to a
    * WebSocket.
    *
-   * @return Returns <code>PP_WEBSOCKETREADYSTATE_CONNECTING</code> if called
-   * before the connection is established.
+   * @return Returns <code>PP_WEBSOCKETREADYSTATE_CLOSED_DEV</code> if called
+   * before connect() is called, or called on an invalid resource.

[dmichael (off chromium), 2011/11/15 17:33:11]

It seems to me it would make sense to define a new value; say,
'PP_WEBSOCKETREADYSTATE_INVALID_DEV' or similar.

    */
   PP_WebSocketReadyState_Dev GetReadyState([in] PP_Resource web_socket);
 
@@ -298,8 +298,8 @@ interface PPB_WebSocket_Dev {
    * WebSocket.
    *
    * @return Returns a <code>PP_VARTYPE_STRING</code> var. If called before the
-   * connection is established, or called on an invalid resource, its data is
-   * empty string.
+   * connection is established, its data is empty string. Return a
+   * <code>PP_VARTYPE_UNDEFINED</code> if called on an invalid resource.
    */
   PP_Var GetURL([in] PP_Resource web_socket);
 };