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

Side by Side Diff: ppapi/api/ppp_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, 3 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 PPP_Messaging interface containing pointers to	7 * This file defines the PPP_Messaging interface containing pointers to

8 * functions that you must implement to handle postMessage messages	8 * functions that you must implement to handle postMessage messages

9 * on the associated DOM element.	9 * on the associated DOM element.

10 *	10 *

11 */	11 */

12	12

13 label Chrome {	13 label Chrome {

14 M14 = 1.0	14 M14 = 1.0

15 };	15 };

16	16

17 /**	17 /**

18 * The <code>PPP_Messaging</code> interface contains pointers to functions	18 * The <code>PPP_Messaging</code> interface contains pointers to functions

19 * that you must implement to handle postMessage events on the associated	19 * that you must implement to handle postMessage events on the associated

20 * DOM element.	20 * DOM element.

21 */	21 */

22 interface PPP_Messaging {	22 interface PPP_Messaging {

23 /**	23 /**

24 * HandleMessage() is a function that the browser calls when PostMessage()	24 * HandleMessage() is a function that the browser calls when PostMessage()

25 * is invoked on the DOM element for the module instance in JavaScript. Note	25 * is invoked on the DOM element for the module instance in JavaScript. Note

26 * that PostMessage() in the JavaScript interface is asynchronous, meaning	26 * that PostMessage() in the JavaScript interface is asynchronous, meaning

27 * JavaScript execution will not be blocked while HandleMessage() is	27 * JavaScript execution will not be blocked while HandleMessage() is

28 * processing the message.	28 * processing the message.

29 *	29 *

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

31 * of a module.	31 * of a module.

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

33 * to JavaScript. Message can have an int32_t, double, bool, or string value	33 * to JavaScript. Message can have an int32_t, double, bool, or string value

34 * (objects are not supported).	34 * (objects are not supported).

35 *	35 *

36 * <strong>Example:</strong>

37 *

38 * The following JavaScript code invokes <code>HandleMessage</code>, passing	36 * The following JavaScript code invokes <code>HandleMessage</code>, passing

39 * the module instance on which it was invoked, with <code>message</code>	37 * the module instance on which it was invoked, with <code>message</code>

40 * being a string <code>PP_Var</code> containing "Hello world!"	38 * being a string <code>PP_Var</code> containing "Hello world!"

41 *	39 *

42 * @code	40 * <strong>Example:</strong>

	41 *

	42 * <code>

43 *	43 *

44 * <body>	44 * <body>

45 * <object id="plugin"	45 * <object id="plugin"

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

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

48 * document.getElementById('plugin').postMessage("Hello world!");	48 * document.getElementById('plugin').postMessage("Hello world!");

49 * </script>	49 * </script>

50 * </body>	50 * </body>

51 *	51 *

52 * @endcode	52 * </code>

53 *	53 *

54 */	54 */

55 void HandleMessage([in] PP_Instance instance, [in] PP_Var message);	55 void HandleMessage([in] PP_Instance instance, [in] PP_Var message);

56 };	56 };

57	57

OLD	NEW

« no previous file with comments | « ppapi/api/ppb_messaging.idl ('k') | ppapi/c/ppb_audio.h » ('j') | no next file with comments »