0

Updated/rewrote documentation.

Review URL: http://codereview.chromium.org/6646057

git-svn-id: svn://svn.chromium.org/chrome/trunk/src@78384 0039d316-1c4b-4281-b951-d872f2087c98
This commit is contained in:
jond@google.com
2011-03-16 17:11:43 +00:00
parent 849ccee35b
commit 37b01e6d24

@ -10,7 +10,8 @@
/**
* @file
* Defines the API ...
* This file defines the PP_Resource type which represents data associated with
* the module.
*/
/**
@ -19,19 +20,18 @@
*/
/**
* A resource is data associated with the Pepper plugin interface. While a
* Var represents something callable to JS or from the plugin to the DOM, a
* resource has no meaning or visibility outside of the plugin interface.
* This typdef represents an opaque handle assigned by the browser to the
* resource. The handle is guaranteed never to be 0 for a valid resource, so a
* module can initialize it to 0 to indicate a "NULL handle." Some interfaces
* may return a NULL resource to indicate failure.
*
* Resources are reference counted. Use AddRefResource and ReleaseResource to
* manage your reference count of a resource. The data will be automatically
* destroyed when the internal reference count reaches 0.
*
* Value is an opaque handle assigned by the browser to the resource. It is
* guaranteed never to be 0 for a valid resource, so a plugin can initialize
* it to 0 to indicate a "NULL handle." Some interfaces may return a NULL
* resource to indicate failure.
* While a Var represents something callable to JS or from the module to
* the DOM, a resource has no meaning or visibility outside of the module
* interface.
*
* Resources are reference counted. Use AddRefResource and ReleaseResource in
* ppb_core.h to manage the reference count of a resource. The data will be
* automatically destroyed when the internal reference count reaches 0.
*/
typedef int32_t PP_Resource;
PP_COMPILE_ASSERT_SIZE_IN_BYTES(PP_Resource, 4);