Updated descriptions to several functions, structs, enums

ppapi/c/ppp.h

 /* Copyright (c) 2010 The Chromium Authors. All rights reserved.
  * Use of this source code is governed by a BSD-style license that can be
  * found in the LICENSE file.
  */
 #ifndef PPAPI_C_PPP_H_
 #define PPAPI_C_PPP_H_
 
 #include "ppapi/c/pp_module.h"
 #include "ppapi/c/pp_stdint.h"
 #include "ppapi/c/ppb.h"
@@ skipping 17 matching lines @@
 #ifdef __cplusplus
 extern "C" {
 #endif
 
 /**
  * @addtogroup Functions
  * @{
  */
 
 /**
- * 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 put a period after each
description (maybe in PP_Var too).

[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);
 /**
  * @}
  */
 
 /**
  * @addtogroup Functions
  * @{
  */
 
-/** 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();
 /**
  * @}
  */
 
 /**
  * @addtogroup Functions
  * @{
  */
 
 /**
- * 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 much?  I thought this was
usable for other interfaces...

+ *
+ * @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);
 /**
  * @}
  */
 
 #ifdef __cplusplus
 }  /* extern "C" */
 #endif
 
 #endif  /* PPAPI_C_PPP_H_ */