Upstream version 7.36.149.0

[platform/framework/web/crosswalk.git] / src / ppapi / api / ppb_var.idl

diff --git a/src/ppapi/api/ppb_var.idl b/src/ppapi/api/ppb_var.idl
index ecb3707..cc12b1b 100644 (file)
--- a/src/ppapi/api/ppb_var.idl
+++ b/src/ppapi/api/ppb_var.idl
@@ -29,9 +29,13 @@ interface PPB_Var {
 
   /**
    * Release() removes a reference to given var, deleting it if the internal
-   * reference count becomes 0. If the given var is not a refcounted object,
-   * this function will do nothing so you can always call it no matter what
-   * the type.
+   * reference count becomes 0. If the <code>PP_Var</code> is of type
+   * <code>PP_VARTYPE_RESOURCE</code>,
+   * it will implicitly release a reference count on the
+   * <code>PP_Resource</code> (equivalent to PPB_Core::ReleaseResource()).
+   *
+   * If the given var is not a refcounted object, this function will do nothing
+   * so you can always call it no matter what the type.
    *
    * @param[in] var A <code>PP_Var</code> that will have a reference removed.
    */
@@ -46,7 +50,7 @@ interface PPB_Var {
    *
    * If the length is 0, the <code>*data</code> pointer will not be dereferenced
    * and may be <code>NULL</code>. Note, however if length is 0, the
-   * "NULL-ness" will not be preserved, as <code>VarToUtf8</code> will never
+   * "NULL-ness" will not be preserved, as VarToUtf8() will never
    * return <code>NULL</code> on success, even for empty strings.
    *
    * The resulting object will be a refcounted string object. It will be
@@ -74,8 +78,8 @@ interface PPB_Var {
    *
    * If the length is 0, the <code>*data</code> pointer will not be dereferenced
    * and may be <code>NULL</code>. Note, however if length is 0, the
-   * "NULL-ness" will not be preserved, as <code>VarToUtf8</code> will never
-   * return <code>NULL</code> on success, even for empty strings.
+   * "NULL-ness" will not be preserved, as VarToUtf8() will never return
+   * <code>NULL</code> on success, even for empty strings.
    *
    * The resulting object will be a refcounted string object. It will be
    * AddRef'ed for the caller. When the caller is done with it, it should be
@@ -127,7 +131,9 @@ interface PPB_Var {
   PP_Resource VarToResource([in] PP_Var var);
 
   /**
-   * Creates a new <code>PP_Var</code> from a given resource.
+   * Creates a new <code>PP_Var</code> from a given resource. Implicitly adds a
+   * reference count on the <code>PP_Resource</code> (equivalent to
+   * PPB_Core::AddRefResource(resource)).
    *
    * @param[in] resource A <code>PP_Resource</code> to be wrapped in a var.
    *