diff options
author | jond@google.com <jond@google.com@0039d316-1c4b-4281-b951-d872f2087c98> | 2012-03-27 19:11:49 +0000 |
---|---|---|
committer | jond@google.com <jond@google.com@0039d316-1c4b-4281-b951-d872f2087c98> | 2012-03-27 19:11:49 +0000 |
commit | e0aa9cf5d4555c8d4f8898611ab175ca5bed5c9b (patch) | |
tree | da4974b88b6c6fc3f281d827a2c8cf32f9816aa2 /ppapi/c | |
parent | b22fc70d174eb3ea991f52bd4b1d7227ac24cceb (diff) | |
download | chromium_src-e0aa9cf5d4555c8d4f8898611ab175ca5bed5c9b.zip chromium_src-e0aa9cf5d4555c8d4f8898611ab175ca5bed5c9b.tar.gz chromium_src-e0aa9cf5d4555c8d4f8898611ab175ca5bed5c9b.tar.bz2 |
Cleaned up documentation (standard documentation rewrite).
Review URL: http://codereview.chromium.org/9813011
git-svn-id: svn://svn.chromium.org/chrome/trunk/src@129236 0039d316-1c4b-4281-b951-d872f2087c98
Diffstat (limited to 'ppapi/c')
-rw-r--r-- | ppapi/c/ppb_websocket.h | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/ppapi/c/ppb_websocket.h b/ppapi/c/ppb_websocket.h index bec5182..fa8daa4 100644 --- a/ppapi/c/ppb_websocket.h +++ b/ppapi/c/ppb_websocket.h @@ -3,7 +3,7 @@ * found in the LICENSE file. */ -/* From ppb_websocket.idl modified Wed Mar 14 01:49:27 2012. */ +/* From ppb_websocket.idl modified Mon Mar 26 09:51:15 2012. */ #ifndef PPAPI_C_PPB_WEBSOCKET_H_ #define PPAPI_C_PPB_WEBSOCKET_H_ @@ -226,10 +226,10 @@ struct PPB_WebSocket_1_0 { * 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(). @@ -246,7 +246,7 @@ struct PPB_WebSocket_1_0 { * @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 @@ -270,8 +270,8 @@ struct PPB_WebSocket_1_0 { * 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 an 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, @@ -319,11 +319,11 @@ struct PPB_WebSocket_1_0 { * @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. |