ppapi/api/ppb_messaging.idl - Issue 7715005: Changed all @code to <code> and @endcode to </code> as per dmichael

Side by Side Diff: ppapi/api/ppb_messaging.idl

Issue 7715005: Changed all @code to <code> and @endcode to </code> as per dmichael (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src/

Patch Set: '' Created 9 years, 4 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 unified diff | Download patch | Annotate | Revision Log

OLD	NEW
1 /* Copyright (c) 2011 The Chromium Authors. All rights reserved.	1 /* Copyright (c) 2011 The Chromium Authors. All rights reserved.

2 * Use of this source code is governed by a BSD-style license that can be	2 * Use of this source code is governed by a BSD-style license that can be

3 * found in the LICENSE file.	3 * found in the LICENSE file.

4 */	4 */

5	5

6 /**	6 /**

7 * This file defines the <code>PPB_Messaging</code> interface implemented	7 * This file defines the <code>PPB_Messaging</code> interface implemented

8 * by the browser for sending messages to DOM elements associated with a	8 * by the browser for sending messages to DOM elements associated with a

9 * specific module instance.	9 * specific module instance.

10 */	10 */

11	11

12 label Chrome {	12 label Chrome {

13 M13 = 0.1,	13 M13 = 0.1,

14 M14 = 1.0	14 M14 = 1.0

15 };	15 };

16	16

17 /**	17 /**

18 * The <code>PPB_Messaging</code> interface is implemented by the browser	18 * The <code>PPB_Messaging</code> interface is implemented by the browser

19 * and is related to sending messages to JavaScript message event listeners on	19 * and is related to sending messages to JavaScript message event listeners on

20 * the DOM element associated with specific module instance.	20 * the DOM element associated with specific module instance.

21 */	21 */

22 [version=0.1]	22 [version=0.1]

23 interface PPB_Messaging {	23 interface PPB_Messaging {

24 /**	24 /**

25 * PostMessage() asynchronously invokes any listeners for message events on	25 * PostMessage() asynchronously invokes any listeners for message events on

26 * the DOM element for the given module instance. A call to PostMessage()	26 * the DOM element for the given module instance. A call to PostMessage()

27 * will not block while the message is processed.	27 * will not block while the message is processed.

28 *	28 *

29 * @param[in] instance A <code>PP_Instance</code> indentifying one instance	29 * @param[in] instance A <code>PP_Instance</code> identifying one instance

30 * of a module.	30 * of a module.

31 * @param[in] message A <code>PP_Var</code> containing the data to be sent to	31 * @param[in] message A <code>PP_Var</code> containing the data to be sent to

32 * JavaScript.	32 * JavaScript.

33 * Message can have a numeric, boolean, or string value; arrays and	33 * Message can have a numeric, boolean, or string value; arrays and

34 * dictionaries are not yet supported. Ref-counted var types are copied, and	34 * dictionaries are not yet supported. Ref-counted var types are copied, and

35 * are therefore not shared between the module instance and the browser.	35 * are therefore not shared between the module instance and the browser.

36 *	36 *

37 * Listeners for message events in JavaScript code will receive an object	37 * Listeners for message events in JavaScript code will receive an object

38 * conforming to the HTML 5 <code>MessageEvent</code> interface.	38 * conforming to the HTML 5 <code>MessageEvent</code> interface.

39 * Specifically, the value of message will be contained as a property called	39 * Specifically, the value of message will be contained as a property called

40 * data in the received <code>MessageEvent</code>.	40 * data in the received <code>MessageEvent</code>.

41 *	41 *

42 * This messaging system is similar to the system used for listening for	42 * This messaging system is similar to the system used for listening for

43 * messages from Web Workers. Refer to	43 * messages from Web Workers. Refer to

44 * <code>http://www.whatwg.org/specs/web-workers/current-work/</code> for	44 * <code>http://www.whatwg.org/specs/web-workers/current-work/</code> for

45 * further information.	45 * further information.

46 *	46 *

47 * <strong>Example:</strong>	47 * <strong>Example:</strong>

48 *	48 *

49 * @code	49 * <code>

50 *	50 *

51 * <body>	51 * <body>

52 * <object id="plugin"	52 * <object id="plugin"

53 * type="application/x-ppapi-postMessage-example"/>	53 * type="application/x-ppapi-postMessage-example"/>

54 * <script type="text/javascript">	54 * <script type="text/javascript">

55 * var plugin = document.getElementById('plugin');	55 * var plugin = document.getElementById('plugin');

56 * plugin.AddEventListener("message",	56 * plugin.AddEventListener("message",

57 * function(message) { alert(message.data); },	57 * function(message) { alert(message.data); },

58 * false);	58 * false);

59 * </script>	59 * </script>

60 * </body>	60 * </body>

61 *	61 *

62 * @endcode	62 * </code>

63 *	63 *

64 * The module instance then invokes PostMessage() as follows:	64 * The module instance then invokes PostMessage() as follows:

65 *	65 *

66 * @code	66 * <code>

67 *	67 *

68 *	68 *

69 * char hello_world[] = "Hello world!";	69 * char hello_world[] = "Hello world!";

70 * PP_Var hello_var = ppb_var_interface->VarFromUtf8(instance,	70 * PP_Var hello_var = ppb_var_interface->VarFromUtf8(instance,

71 * hello_world,	71 * hello_world,

72 * sizeof(hello_world));	72 * sizeof(hello_world));

73 * ppb_messaging_interface->PostMessage(instance, hello_var); // Copies var.	73 * ppb_messaging_interface->PostMessage(instance, hello_var); // Copies var.

74 * ppb_var_interface->Release(hello_var);	74 * ppb_var_interface->Release(hello_var);

75 *	75 *

76 * @endcode	76 * </code>

77 *	77 *

78 * The browser will pop-up an alert saying "Hello world!"	78 * The browser will pop-up an alert saying "Hello world!"

79 */	79 */

80 void PostMessage([in] PP_Instance instance, [in] PP_Var message);	80 void PostMessage([in] PP_Instance instance, [in] PP_Var message);

81 };	81 };

82	82

OLD	NEW

« ppapi/api/ppb_audio.idl ('K') | « ppapi/api/ppb_audio.idl ('k') | ppapi/api/ppp_messaging.idl » ('j') | no next file with comments »