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

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: some doxygen tweaks 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
Index: ppapi/api/ppb_var.idl
diff --git a/ppapi/api/ppb_var.idl b/ppapi/api/ppb_var.idl
index ecb3707bcfea56b80e442f3f9be692d9af11c9c7..fecc3b8b4294f18bc15f4305163aa8d9c0db0356 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.
*/
@@ -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
+ * <code>PPB_Core::AddRefResource(resource)</code>).
raymes 2014/04/09 00:16:18 nit: also consistency issues with <code> around fu
*
* @param[in] resource A <code>PP_Resource</code> to be wrapped in a var.
*
« ppapi/api/pp_var.idl ('K') | « 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