ppapi/c/ppb.h - Issue 6246117: Cleaning up and adding new docs

Side by Side Diff: ppapi/c/ppb.h

Issue 6246117: Cleaning up and adding new docs (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src/

Patch Set: Created 9 years, 10 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) 2010 The Chromium Authors. All rights reserved.	1 /* Copyright (c) 2010 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 #ifndef PPAPI_C_PPB_H_	5 #ifndef PPAPI_C_PPB_H_

6 #define PPAPI_C_PPB_H_	6 #define PPAPI_C_PPB_H_

7	7

8 /**	8 /**

9 * @file	9 * @file

10 * Defines the API ...	10 * This file defines a type for storing a pointer to an interface supported

11 *	11 * by the browser.
	dmichael(do not use this one) 2011/02/08 17:04:38 Not sure about this wording... maybe instead say Not sure about this wording... maybe instead say 'This file defines a function pointer type for the PPB_GetInterface function.' Or something. jond 2011/02/09 16:42:04 Done. Show quoted text On 2011/02/08 17:04:38, dmichael wrote: > Not sure about this wording... maybe instead say 'This file defines a function > pointer type for the PPB_GetInterface function.' Or something. Done. jond 2011/02/09 16:42:04 Done. Show quoted text On 2011/02/08 17:04:38, dmichael wrote: > Not sure about this wording... maybe instead say 'This file defines a function > pointer type for the PPB_GetInterface function.' Or something. Done.
12 */	12 */

13	13

14 /**	14 /**

15 * @addtogroup Typedefs	15 * @addtogroup Typedefs

16 * @{	16 * @{

17 */	17 */

18	18

19 /**	19 /**

20 * Returns an interface pointer for the interface of the given name, or NULL	20 * This value contains a pointer to an interface supported by the browser
	dmichael(do not use this one) 2011/02/08 21:51:17 This is defining a function type, not a value. It This is defining a function type, not a value. It's going to be tricky to be both accurate and understandable. The good news is, it should be pretty familiar to experienced C developers. Maybe "This function pointer type defines the signature for the PPB_GetInterface function. [then the paragraph that's currently 2nd describing how you get the PPB_GetInterface function pointer that you can actually invoke]. I'd move the 2nd part of this paragraph in to its own paragraph. jond 2011/02/09 16:42:04 I think I got it. You'll have to check. On 2011/02 I think I got it. You'll have to check. On 2011/02/08 21:51:17, dmichael wrote: Show quoted text > This is defining a function type, not a value. It's going to be tricky to be > both accurate and understandable. The good news is, it should be pretty > familiar to experienced C developers. > > Maybe "This function pointer type defines the signature for the PPB_GetInterface > function. [then the paragraph that's currently 2nd describing how you get the > PPB_GetInterface function pointer that you can actually invoke]. I'd move the > 2nd part of this paragraph in to its own paragraph.
21 * if the interface is not supported. Interface names should be ASCII.	21 * (given the interface name). Browser interface names should be ASCII
	dmichael(do not use this one) 2011/02/08 21:51:17 "should be ASCII" is worded for PPAPI developers w "should be ASCII" is worded for PPAPI developers who are defining new interfaces. If our audience is primarily users of PPAPI, we should instead say "Browser interface names are ASCII strings..." (note "should be" -> "are") jond 2011/02/09 16:42:04 Done. Show quoted text On 2011/02/08 21:51:17, dmichael wrote: > "should be ASCII" is worded for PPAPI developers who are defining new > interfaces. If our audience is primarily users of PPAPI, we should instead say > "Browser interface names are ASCII strings..." (note "should be" -> "are") Done. jond 2011/02/09 16:42:04 Done. Show quoted text On 2011/02/08 21:51:17, dmichael wrote: > "should be ASCII" is worded for PPAPI developers who are defining new > interfaces. If our audience is primarily users of PPAPI, we should instead say > "Browser interface names are ASCII strings..." (note "should be" -> "are") Done.
	22 * and are generally defined in the header file for the interface, such

	23 * as PP_AUDIO_INTERFACE found in ppb.audio.h or PPB_GRAPHICS_2D_INTERFACE in

	24 * ppb_graphics_2d.h.

	25 *

	26 * A generic PPB_GetInterface pointer is passed to PPP_InitializedModule when

	27 * your module is loaded. You can use this pointer to request a pointer to a

	28 * specific browser interface.

	29 * This value will be NULL if the interface is not supported on the browser.

22 */	30 */

23 typedef const void* (PPB_GetInterface)(const char interface_name);	31 typedef const void* (PPB_GetInterface)(const char interface_name);

24 /**	32 /**

25 * @}	33 * @}

26 */	34 */

27 #endif /* PPAPI_C_PPB_H_ */	35 #endif /* PPAPI_C_PPB_H_ */

28	36

OLD	NEW

« ppapi/c/pp_stdint.h ('K') | « ppapi/c/pp_stdint.h ('k') | ppapi/c/ppb_instance.h » ('j') | ppapi/c/ppb_instance.h » ('J')