diff options
author | jond@google.com <jond@google.com@0039d316-1c4b-4281-b951-d872f2087c98> | 2011-03-16 17:11:43 +0000 |
---|---|---|
committer | jond@google.com <jond@google.com@0039d316-1c4b-4281-b951-d872f2087c98> | 2011-03-16 17:11:43 +0000 |
commit | 37b01e6d24bf3c251708cff470b65b2574c582b5 (patch) | |
tree | e00ac671d053940dfcad91ebfd5b5f021791a216 /ppapi/c/pp_resource.h | |
parent | 849ccee35b29ff4e6d69766087c0e2d8a2a01004 (diff) | |
download | chromium_src-37b01e6d24bf3c251708cff470b65b2574c582b5.zip chromium_src-37b01e6d24bf3c251708cff470b65b2574c582b5.tar.gz chromium_src-37b01e6d24bf3c251708cff470b65b2574c582b5.tar.bz2 |
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
Diffstat (limited to 'ppapi/c/pp_resource.h')
-rw-r--r-- | ppapi/c/pp_resource.h | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/ppapi/c/pp_resource.h b/ppapi/c/pp_resource.h index cd58c6b..872c697 100644 --- a/ppapi/c/pp_resource.h +++ b/ppapi/c/pp_resource.h @@ -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); |