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

Unified Diff: ppapi/c/ppp.h

Issue 6286018: Updated descriptions to several functions, structs, enums (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src/
Patch Set: Created 9 years, 11 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
« ppapi/c/pp_var.h ('K') | « ppapi/c/pp_var.h ('k') | no next file » | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: ppapi/c/ppp.h
===================================================================
--- ppapi/c/ppp.h (revision 73298)
+++ ppapi/c/ppp.h (working copy)
@@ -35,12 +35,17 @@
*/
/**
- * Entrypoint for the module.
+ * PPP_InitializeModule() is the entry point for a Native Client module and is
+ * called by the browser when your module loads. Your code will implement this
dmichael(do not use this one) 2011/02/01 22:17:22 maybe change 'will' to 'must'?
jond 2011/02/02 16:54:51 Fixed. On 2011/02/01 22:17:22, dmichael wrote:
+ * function.
*
- * Returns PP_OK on success, any other value on failure. Failure indicates to
- * the browser that this plugin can not be used. In this case, the plugin will
- * be unloaded and ShutdownModule will NOT be called.
+ * Failure indicates to the browser that this plugin can not be used. In this
+ * case, the plugin will be unloaded and ShutdownModule will NOT be called.
*
+ * @param[in] module A handle to one Native Client module
+ * @param[in] get_browser_interface An interface pointer
+ * @return PP_OK on success. Any other value on failure
dmichael(do not use this one) 2011/02/01 22:17:22 Two spaces after the period. I would also maybe p
jond 2011/02/02 16:54:51 Fixed. On 2011/02/01 22:17:22, dmichael wrote:
+ *
*/
PP_EXPORT int32_t PPP_InitializeModule(PP_Module module,
PPB_GetInterface get_browser_interface);
@@ -53,7 +58,9 @@
* @{
*/
-/** Called before the plugin module is unloaded. */
+/** PPP_ShutdownModule() is called before the Native Client module is unloaded.
+ * Your code will implement this function.
dmichael(do not use this one) 2011/02/01 22:17:22 will->must?
jond 2011/02/02 16:54:51 Fixed. On 2011/02/01 22:17:22, dmichael wrote:
+ */
PP_EXPORT void PPP_ShutdownModule();
/**
* @}
@@ -65,8 +72,19 @@
*/
/**
- * Returns an interface pointer for the interface of the given name, or NULL
- * if the interface is not supported. Interface names should be ASCII.
+ * PPP_GetInterface() is called by the browser to determine the PPP_Instance
+ * functions that the Native Client module implements. PPP_Instance is
+ * an interface (struct) that contains pointers to several functions your
+ * module must implement in some form (all functions can be empty, but
+ * must be implemented). If you care about things such as keyboard events
+ * or our module gaining or loosing focus on a page, these functions will
Sang Ahn 2011/02/01 19:19:00 s/loosing/losing
dmichael(do not use this one) 2011/02/01 22:17:22 our->your, will->must
jond 2011/02/02 16:54:51 Fixed. On 2011/02/01 22:17:22, dmichael wrote:
+ * have code to handle those events. Refer to PPP_Instance interface for
+ * more information on these functions.
dmichael(do not use this one) 2011/02/01 22:17:22 Is it really accurate to focus on PPP_Instance so
+ *
+ * @param[in] interface_name A pointer to an interface name. Interface names
+ * should be ASCII
+ * @return An interface pointer for the interface or NULL if the interface is
+ * not supported
*/
PP_EXPORT const void* PPP_GetInterface(const char* interface_name);
/**
« ppapi/c/pp_var.h ('K') | « ppapi/c/pp_var.h ('k') | no next file » | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698