summaryrefslogtreecommitdiffstats
path: root/ppapi/c/ppp_messaging.h
diff options
context:
space:
mode:
authorjond@google.com <jond@google.com@0039d316-1c4b-4281-b951-d872f2087c98>2011-07-06 15:37:28 +0000
committerjond@google.com <jond@google.com@0039d316-1c4b-4281-b951-d872f2087c98>2011-07-06 15:37:28 +0000
commit8dd1f5778b67cec32b169e0a7e6558c9ca19c75c (patch)
tree2a758829f62afc4ad94d2fb3f6006c820e3a5d87 /ppapi/c/ppp_messaging.h
parentb00a46023e5ca59e7ec7d4cee84fb1aaf416f0e8 (diff)
downloadchromium_src-8dd1f5778b67cec32b169e0a7e6558c9ca19c75c.zip
chromium_src-8dd1f5778b67cec32b169e0a7e6558c9ca19c75c.tar.gz
chromium_src-8dd1f5778b67cec32b169e0a7e6558c9ca19c75c.tar.bz2
Misc. changes. Mostly formatting.
Review URL: http://codereview.chromium.org/7282015 git-svn-id: svn://svn.chromium.org/chrome/trunk/src@91562 0039d316-1c4b-4281-b951-d872f2087c98
Diffstat (limited to 'ppapi/c/ppp_messaging.h')
-rw-r--r--ppapi/c/ppp_messaging.h30
1 files changed, 16 insertions, 14 deletions
diff --git a/ppapi/c/ppp_messaging.h b/ppapi/c/ppp_messaging.h
index 5441a50..29a7976 100644
--- a/ppapi/c/ppp_messaging.h
+++ b/ppapi/c/ppp_messaging.h
@@ -24,27 +24,29 @@ struct PP_Var;
*/
/**
- * The PPP_Messaging interface contains pointers to functions that you must
- * implement to handle postMessage events on the associated DOM element.
+ * The <code>PPP_Messaging</code> interface contains pointers to functions
+ * that you must implement to handle postMessage events on the associated
+ * DOM element.
*/
struct PPP_Messaging {
/**
- * HandleMessage is a pointer to a function that the browser calls when
- * PostMessage() is invoked on the DOM element for the module instance in
- * JavaScript. Note that PostMessage() in the JavaScript interface is
- * asynchronous, meaning JavaScript execution will not be blocked while
- * HandleMessage() is processing the message.
+ * HandleMessage() is a function that the browser calls when PostMessage()
+ * is invoked on the DOM element for the module instance in JavaScript. Note
+ * that PostMessage() in the JavaScript interface is asynchronous, meaning
+ * JavaScript execution will not be blocked while HandleMessage() is
+ * processing the message.
*
- * @param[in] instance A PP_Instance indentifying one instance of a module.
- * @param[in] message A PP_Var containing the data to be sent to JavaScript.
- * Message can have an int32_t, double, bool, or string value (objects
- * are not supported).
+ * @param[in] instance A <code>PP_Instance</code> indentifying one instance
+ * of a module.
+ * @param[in] message A <code>PP_Var</code> containing the data to be sent
+ * to JavaScript. Message can have an int32_t, double, bool, or string value
+ * (objects are not supported).
*
* <strong>Example:</strong>
*
- * The following JavaScript code invokes HandleMessage, passing the module
- * instance on which it was invoked, with <code>message</code> being a
- * string PP_Var containing "Hello world!"
+ * The following JavaScript code invokes <code>HandleMessage</code>, passing
+ * the module instance on which it was invoked, with <code>message</code>
+ * being a string <code>PP_Var</code> containing "Hello world!"
*
* @code
*