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

Side by Side 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 unified diff | Download patch | Annotate | Revision Log
OLDNEW
1 /* Copyright (c) 2012 The Chromium Authors. All rights reserved. 1 /* Copyright (c) 2012 The Chromium Authors. All rights reserved.
2 * Use of this source code is governed by a BSD-style license that can be 2 * Use of this source code is governed by a BSD-style license that can be
3 * found in the LICENSE file. 3 * found in the LICENSE file.
4 */ 4 */
5 5
6 /** 6 /**
7 * This file defines the <code>PPB_Var</code> struct. 7 * This file defines the <code>PPB_Var</code> struct.
8 */ 8 */
9 9
10 label Chrome { 10 label Chrome {
(...skipping 11 matching lines...) Expand all
22 * object, this function will do nothing so you can always call it no matter 22 * object, this function will do nothing so you can always call it no matter
23 * what the type. 23 * what the type.
24 * 24 *
25 * @param[in] var A <code>PP_Var</code> that will have a reference added. 25 * @param[in] var A <code>PP_Var</code> that will have a reference added.
26 */ 26 */
27 [version=1.0] 27 [version=1.0]
28 void AddRef([in] PP_Var var); 28 void AddRef([in] PP_Var var);
29 29
30 /** 30 /**
31 * Release() removes a reference to given var, deleting it if the internal 31 * Release() removes a reference to given var, deleting it if the internal
32 * reference count becomes 0. If the given var is not a refcounted object, 32 * reference count becomes 0. If the <code>PP_Var</code> is of type
33 * this function will do nothing so you can always call it no matter what 33 * <code>PP_VARTYPE_RESOURCE</code>,
34 * the type. 34 * it will implicitly release a reference count on the
35 * <code>PP_Resource</code> (equivalent to PPB_Core::ReleaseResource()).
36 *
37 * If the given var is not a refcounted object, this function will do nothing
38 * so you can always call it no matter what the type.
35 * 39 *
36 * @param[in] var A <code>PP_Var</code> that will have a reference removed. 40 * @param[in] var A <code>PP_Var</code> that will have a reference removed.
37 */ 41 */
38 [version=1.0] 42 [version=1.0]
39 void Release([in] PP_Var var); 43 void Release([in] PP_Var var);
40 44
41 /** 45 /**
42 * VarFromUtf8() creates a string var from a string. The string must be 46 * VarFromUtf8() creates a string var from a string. The string must be
43 * encoded in valid UTF-8 and is NOT NULL-terminated, the length must be 47 * encoded in valid UTF-8 and is NOT NULL-terminated, the length must be
44 * specified in <code>len</code>. It is an error if the string is not 48 * specified in <code>len</code>. It is an error if the string is not
(...skipping 75 matching lines...) Expand 10 before | Expand all | Expand 10 after
120 * @param[in] var A <code>PP_Var</code> struct containing a resource-type var. 124 * @param[in] var A <code>PP_Var</code> struct containing a resource-type var.
121 * 125 *
122 * @return A <code>PP_Resource</code> retrieved from the var, or 0 if the var 126 * @return A <code>PP_Resource</code> retrieved from the var, or 0 if the var
123 * is not a resource. The reference count of the resource is incremented on 127 * is not a resource. The reference count of the resource is incremented on
124 * behalf of the caller. 128 * behalf of the caller.
125 */ 129 */
126 [version=1.2] 130 [version=1.2]
127 PP_Resource VarToResource([in] PP_Var var); 131 PP_Resource VarToResource([in] PP_Var var);
128 132
129 /** 133 /**
130 * Creates a new <code>PP_Var</code> from a given resource. 134 * Creates a new <code>PP_Var</code> from a given resource. Implicitly adds a
135 * reference count on the <code>PP_Resource</code> (equivalent to
136 * <code>PPB_Core::AddRefResource(resource)</code>).
raymes 2014/04/09 00:16:18 nit: also consistency issues with <code> around fu
131 * 137 *
132 * @param[in] resource A <code>PP_Resource</code> to be wrapped in a var. 138 * @param[in] resource A <code>PP_Resource</code> to be wrapped in a var.
133 * 139 *
134 * @return A <code>PP_Var</code> created for this resource, with type 140 * @return A <code>PP_Var</code> created for this resource, with type
135 * <code>PP_VARTYPE_RESOURCE</code>. The reference count of the var is set to 141 * <code>PP_VARTYPE_RESOURCE</code>. The reference count of the var is set to
136 * 1 on behalf of the caller. 142 * 1 on behalf of the caller.
137 */ 143 */
138 [version=1.2] 144 [version=1.2]
139 PP_Var VarFromResource([in] PP_Resource resource); 145 PP_Var VarFromResource([in] PP_Resource resource);
140 }; 146 };
141 147
OLDNEW
« 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