Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(84)

Unified Diff: ppapi/api/ppb_var.idl

Issue 229033003: PPAPI: Update pp_var.h documentation for Resource vars. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: consistency fixes per review Created 6 years, 8 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « ppapi/api/pp_var.idl ('k') | ppapi/c/pp_var.h » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: ppapi/api/ppb_var.idl
diff --git a/ppapi/api/ppb_var.idl b/ppapi/api/ppb_var.idl
index ecb3707bcfea56b80e442f3f9be692d9af11c9c7..cc12b1bb3b759039afd3c51afe44cc61ea029419 100644
--- a/ppapi/api/ppb_var.idl
+++ b/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.
*
« no previous file with comments | « ppapi/api/pp_var.idl ('k') | ppapi/c/pp_var.h » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698