diff options
| author | teravest@chromium.org <teravest@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98> | 2012-12-06 00:40:14 +0000 |
|---|---|---|
| committer | teravest@chromium.org <teravest@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98> | 2012-12-06 00:40:14 +0000 |
| commit | fd2951978e515252cb1e67866fddfdcd514430c3 (patch) | |
| tree | 9e530781c3d140d42b749da47c61e3359ee1a34c /ppapi/shared_impl/host_resource.h | |
| parent | c6b539db37e1bf28754cf8bbb71c301b35094487 (diff) | |
| download | chromium_src-fd2951978e515252cb1e67866fddfdcd514430c3.zip chromium_src-fd2951978e515252cb1e67866fddfdcd514430c3.tar.gz chromium_src-fd2951978e515252cb1e67866fddfdcd514430c3.tar.bz2 | |
Improve HostResource comments for use in plugins.
The comments in host_resource.h allude to a transformation that must
happen for a PP_Resource to be used in a plugin, but doesn't specify
what it is. Added a hint so it's easier to find what to use.
Also corrected a spelling error.
BUG=
Review URL: https://chromiumcodereview.appspot.com/11437017
git-svn-id: svn://svn.chromium.org/chrome/trunk/src@171365 0039d316-1c4b-4281-b951-d872f2087c98
Diffstat (limited to 'ppapi/shared_impl/host_resource.h')
| -rw-r--r-- | ppapi/shared_impl/host_resource.h | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/ppapi/shared_impl/host_resource.h b/ppapi/shared_impl/host_resource.h index c98d2d6..3645edc 100644 --- a/ppapi/shared_impl/host_resource.h +++ b/ppapi/shared_impl/host_resource.h @@ -15,7 +15,10 @@ namespace ppapi { // The point is to prevent mistakes where the wrong resource value is sent. // Resource values are remapped in the plugin so that it can talk to multiple // hosts. If all values were PP_Resource, it would be easy to forget to do -// this tranformation. +// this transformation. +// +// To get the corresponding plugin PP_Resource for a HostResource, use +// PluginResourceTracker::PluginResourceForHostResource(). // // All HostResources respresent IDs valid in the host. class PPAPI_SHARED_EXPORT HostResource { |