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

Unified Diff: ppapi/c/ppb_instance.h

Issue 6246117: Cleaning up and adding new docs (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src/
Patch Set: '' Created 9 years, 10 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/c/ppb_instance.h
===================================================================
--- ppapi/c/ppb_instance.h (revision 74025)
+++ ppapi/c/ppb_instance.h (working copy)
@@ -14,21 +14,41 @@
/**
* @file
- * Defines the API ...
+ * This file defines the PPB_Instance interface implemented by the
+ * browser and containing pointers to functions related to
+ * the module instance on a web page.
*
* @addtogroup Interfaces
* @{
*/
+/**
+ * The PPB_Instance interface contains pointers to functions
+ * related to the module instance on a web page.
+ *
+ */
struct PPB_Instance {
- /** Returns a reference to the DOM window containing this instance. */
+ /**
+ * GetWindowObject is a pointer to a function that determines
+ * the DOM window containing this module instance.
+ *
+ * @param[in] instance A PP_Instance indentifying one instance of a module.
+ * @return A PP_Var containing window object on success.
+ */
struct PP_Var (*GetWindowObject)(PP_Instance instance);
- /** Returns a reference to the DOM element containing this instance. */
+ /**
+ * GetOwnerElementObject is a pointer to a function that determines
+ * the DOM element containing this module instance.
+ *
+ * @param[in] instance A PP_Instance whose WindowObject should be retrieved.
+ * @return A PP_Var containing DOM element on success.
+ */
struct PP_Var (*GetOwnerElementObject)(PP_Instance instance);
/**
- * Binds the given graphics device as the current drawing surface. The
+ * BindGraphics is a pointer to a function that binds the given
+ * graphics as the current drawing surface. The
* contents of this device is what will be displayed in the plugin's area
* on the web page. The device must be a 2D or a 3D device.
*
@@ -42,42 +62,47 @@
* to move a device between instances, first unbind it from the old one, and
* then rebind it to the new one.
*
- * Returns PP_TRUE if the bind was successful. False means the device was not
- * the correct type. On success, a reference to the device will be held by
- * the plugin instance, so the caller can release its reference if it
- * chooses.
- *
* Binding a device will invalidate that portion of the web page to flush the
* contents of the new device to the screen.
+ *
+ * @param[in] instance A PP_Instance indentifying one instance of a module.
+ * @param[in] device A PP_Resourse representing the graphics device.
+ * @return PP_Bool containing PP_TRUE if bind was successful or PP_FALSE if
+ * the device was not the correct type. On success, a reference to the
+ * device will be held by the plugin instance, so the caller can release
+ * its reference if it chooses.
*/
PP_Bool (*BindGraphics)(PP_Instance instance, PP_Resource device);
/**
- * Returns PP_TRUE if the instance is full-frame. Such a plugin represents
+ * IsFullFrame is a pointer to a function that determines if the
+ * module instance is full-frame (repr). Such a module represents
* the entire document in a frame rather than an embedded resource. This can
* happen if the user does a top level navigation or the page specifies an
* iframe to a resource with a MIME type registered by the plugin.
+ *
+ * @param[in] instance A PP_Instance indentifying one instance of a module.
+ * @return A PP_Bool containing PP_TRUE if the instance is full-frame.
*/
PP_Bool (*IsFullFrame)(PP_Instance instance);
/**
- * Executes the given script in the context of the frame containing the
- * plugin.
+ * ExecuteScript is a pointer to a function that executes the given
+ * script in the context of the frame containing the module.
*
- * The exception, if any, will be returned in *exception. As
- * with the PPB_Var interface, the exception parameter,
- * if non-NULL, must be initialized
+ * The exception, if any, will be returned in *exception. As with the PPB_Var
+ * interface, the exception parameter, if non-NULL, must be initialized
* to a void exception or the function will immediately return. On success,
- * the exception parameter will be set to a "void" var. On failure, the return
- * value will be a "void" var.
+ * the exception parameter will be set to a "void" var. On failure, the
+ * return value will be a "void" var.
*
- * @param script A string containing the JavaScript to execute.
- * @param exception Initialize this to NULL if you don't want exception info;
- * initialize this to a void exception if you do.
- * See the function description for details.
+ * @param[in] script A string containing the JavaScript to execute.
+ * @param[in/out] exception PP_Var containing the exception. Initialize
+ * this to NULL if you don't want exception info; initialize this to a void
+ * exception if want exception info.
*
- * @return The result of the script execution,
- * or a "void" var if execution failed.
+ * @return The result of the script execution, or a "void" var
+ * if execution failed.
*/
struct PP_Var (*ExecuteScript)(PP_Instance instance,
struct PP_Var script,

Powered by Google App Engine
This is Rietveld 408576698