| Index: ppapi/c/ppb_url_response_info.h
|
| ===================================================================
|
| --- ppapi/c/ppb_url_response_info.h (revision 90953)
|
| +++ ppapi/c/ppb_url_response_info.h (working copy)
|
| @@ -12,7 +12,7 @@
|
|
|
| /**
|
| * @file
|
| - * This file defines the PPB_URLResponseInfo API for examining URL
|
| + * This file defines the <code>PPB_URLResponseInfo</code> API for examining URL
|
| * responses.
|
| */
|
|
|
| @@ -29,22 +29,25 @@
|
| // full URL in the response corresponds to the relative URL in the original
|
| // request).
|
| typedef enum {
|
| - /** This corresponds to a string (PP_VARTYPE_STRING). */
|
| + /** This corresponds to a string (<code>PP_VARTYPE_STRING</code>). */
|
| PP_URLRESPONSEPROPERTY_URL,
|
|
|
| - /** This corresponds to a string (PP_VARTYPE_STRING).*/
|
| + /** This corresponds to a string (<code>PP_VARTYPE_STRING</code>).*/
|
| PP_URLRESPONSEPROPERTY_REDIRECTURL,
|
|
|
| - /** This corresponds to a string (PP_VARTYPE_STRING).*/
|
| + /** This corresponds to a string (<code>PP_VARTYPE_STRING</code>).*/
|
| PP_URLRESPONSEPROPERTY_REDIRECTMETHOD,
|
|
|
| - /** This corresponds to an int32 (PP_VARETYPE_INT32)*/
|
| + /** This corresponds to an int32 (<code>PP_VARETYPE_INT32</code>)*/
|
| PP_URLRESPONSEPROPERTY_STATUSCODE,
|
|
|
| - /** This corresponds to a string (PP_VARTYPE_STRING).*/
|
| + /** This corresponds to a string (<code>PP_VARTYPE_STRING</code>).*/
|
| PP_URLRESPONSEPROPERTY_STATUSLINE,
|
|
|
| - /** This corresponds to a string(PP_VARTYPE_STRING), \n delimited */
|
| + /**
|
| + * This corresponds to a string(<code>PP_VARTYPE_STRING</code>),
|
| + * \n delimited
|
| + */
|
| PP_URLRESPONSEPROPERTY_HEADERS
|
| } PP_URLResponseProperty;
|
| PP_COMPILE_ASSERT_SIZE_IN_BYTES(PP_URLResponseProperty, 4);
|
| @@ -62,47 +65,53 @@
|
| */
|
|
|
| /**
|
| - * The PPB_URLResponseInfo interface contains pointers to functions for
|
| - * examining URL responses. Refer to PPB_URLLoader for further
|
| + * The PPB_URLResponseInfo interface contains APIs for
|
| + * examining URL responses. Refer to <code>PPB_URLLoader</code> for further
|
| * information.
|
| */
|
| struct PPB_URLResponseInfo {
|
|
|
| /**
|
| - * IsURLResponseInfo is a pointer to a function that determines if a
|
| - * response is a URLResponseInfo.
|
| + * IsURLResponseInfo() determines if a response is a
|
| + * <code>URLResponseInfo</code>.
|
| *
|
| - * @param[in] resource A PP_Resource corresponding to a URLResponseInfo.
|
| - * @return PP_TRUE if the resource is a URLResponseInfo,
|
| - * PP_FALSE if the resource is invalid or some type other than
|
| - * URLResponseInfo.
|
| + * @param[in] resource A <code>PP_Resource</code> corresponding to a
|
| + * <code>URLResponseInfo</code>.
|
| + *
|
| + * @return <code>PP_TRUE</code> if the resource is a
|
| + * <code>URLResponseInfo</code>, <code>PP_FALSE</code> if the resource is
|
| + * invalid or some type other than <code>URLResponseInfo</code>.
|
| */
|
| PP_Bool (*IsURLResponseInfo)(PP_Resource resource);
|
|
|
| /**
|
| - * GetProperty is a pointer to a function that gets a response property.
|
| + * GetProperty() gets a response property.
|
| *
|
| - * @param[in] request A PP_Resource corresponding to a URLResponseInfo.
|
| - * @param[in] property A PP_URLResponseProperty identifying the type of
|
| - * property in the response.
|
| - * @return A PP_Var containing the response property value if successful,
|
| - * PP_VARTYPE_VOID if an input parameter is invalid.
|
| + * @param[in] request A <code>PP_Resource</code> corresponding to a
|
| + * <code>URLResponseInfo</code>.
|
| + * @param[in] property A <code>PP_URLResponseProperty</code> identifying
|
| + * the type of property in the response.
|
| + *
|
| + * @return A <code>PP_Var</code> containing the response property value if
|
| + * successful, <code>PP_VARTYPE_VOID</code> if an input parameter is invalid.
|
| */
|
| struct PP_Var (*GetProperty)(PP_Resource response,
|
| PP_URLResponseProperty property);
|
|
|
| /**
|
| - * GetBodyAsFileRef is a pointer to a function that returns a FileRef
|
| - * pointing to the file containing the response body. This
|
| - * is only valid if PP_URLREQUESTPROPERTY_STREAMTOFILE was set on the
|
| - * URLRequestInfo used to produce this response. This file remains valid
|
| - * until the URLLoader associated with this URLResponseInfo is closed or
|
| - * destroyed.
|
| + * GetBodyAsFileRef() returns a FileRef pointing to the file containing the
|
| + * response body. This is only valid if
|
| + * <code>PP_URLREQUESTPROPERTY_STREAMTOFILE</code> was set on the
|
| + * <code>URLRequestInfo</code> used to produce this response. This file
|
| + * remains valid until the <code>URLLoader</code> associated with this
|
| + * <code>URLResponseInfo is closed or destroyed.
|
| *
|
| - * @param[in] request A PP_Resource corresponding to a URLResponseInfo.
|
| - * @return A PP_Resource corresponding to a FileRef if successful, 0 if
|
| - * PP_URLREQUESTPROPERTY_STREAMTOFILE was not requested or if the URLLoader
|
| - * has not been opened yet.
|
| + * @param[in] request A <code>PP_Resource</code> corresponding to a
|
| + * <code>URLResponseInfo</code>.
|
| + *
|
| + * @return A <code>PP_Resource</code> corresponding to a FileRef if
|
| + * successful, 0 if <code>PP_URLREQUESTPROPERTY_STREAMTOFILE was not
|
| + * requested or if the <code>URLLoader</code> has not been opened yet.
|
| */
|
| PP_Resource (*GetBodyAsFileRef)(PP_Resource response);
|
| };
|
|
|