Skip to content

GitLab

T
tangled
Commit e12a6a19 authored by jond@google.com's avatar jond@google.com
Browse files
Options

Fixed spelling errors and changed all references to PP_Resource to be the 

same (on @param tags) as per polina.
Review URL: http://codereview.chromium.org/7701004

git-svn-id: svn://svn.chromium.org/chrome/trunk/src@98972 0039d316-1c4b-4281-b951-d872f2087c98
parent 31696e10
Hide whitespace changes
Inline Side-by-side
Showing with 115 additions and 98 deletions
ppapi/api/ppb_core.idl
View file @ e12a6a19
...@@ -23,14 +23,16 @@ interface PPB_Core { ...@@ -23,14 +23,16 @@ interface PPB_Core {
* *
* AddRefResource() adds a reference to a resource. * AddRefResource() adds a reference to a resource.
* *
* @param[in] config A <code>PP_Resource</code> containing the resource. * @param[in] config A <code>PP_Resource</code> corresponding to a
* resource.
*/ */
void AddRefResource([in] PP_Resource resource); void AddRefResource([in] PP_Resource resource);
/** /**
* ReleaseResource() removes a reference from a resource. * ReleaseResource() removes a reference from a resource.
* *
* @param[in] config A <code>PP_Resource</code> containing the resource. * @param[in] config A <code>PP_Resource</code> corresponding to a
* resource.
*/ */
void ReleaseResource([in] PP_Resource resource); void ReleaseResource([in] PP_Resource resource);
......
ppapi/api/ppb_file_io.idl
View file @ e12a6a19
...@@ -57,7 +57,7 @@ interface PPB_FileIO { ...@@ -57,7 +57,7 @@ interface PPB_FileIO {
/** /**
* Create() creates a new FileIO object. * Create() creates a new FileIO object.
* *
* @param[in] instance A <code>PP_Instance</code> indentifying the instance * @param[in] instance A <code>PP_Instance</code> identifying the instance
* with the file. * with the file.
* *
* @return A <code>PP_Resource</code> corresponding to a FileIO if * @return A <code>PP_Resource</code> corresponding to a FileIO if
......
ppapi/api/ppb_file_system.idl
View file @ e12a6a19
...@@ -18,7 +18,7 @@ label Chrome { ...@@ -18,7 +18,7 @@ label Chrome {
interface PPB_FileSystem { interface PPB_FileSystem {
/** Create() creates a file system object of the given type. /** Create() creates a file system object of the given type.
* *
* @param[in] instance A <code>PP_Instance</code> indentifying the instance * @param[in] instance A <code>PP_Instance</code> identifying the instance
* with the file. * with the file.
* @param[in] type A file system type as defined by * @param[in] type A file system type as defined by
* <code>PP_FileSystemType</code> enum. * <code>PP_FileSystemType</code> enum.
......
ppapi/api/ppb_image_data.idl
View file @ e12a6a19
...@@ -106,7 +106,7 @@ interface PPB_ImageData { ...@@ -106,7 +106,7 @@ interface PPB_ImageData {
* memory, but may contain data from a previous image produced by the same * memory, but may contain data from a previous image produced by the same
* module if the bitmap was cached and re-used. * module if the bitmap was cached and re-used.
* *
* @param[in] instance A <code>PP_Instance</code> indentifying one instance * @param[in] instance A <code>PP_Instance</code> identifying one instance
* of a module. * of a module.
* @param[in] format The desired image data format. * @param[in] format The desired image data format.
* @param[in] size A pointer to a <code>PP_Size</code> containing the image * @param[in] size A pointer to a <code>PP_Size</code> containing the image
...@@ -118,7 +118,7 @@ interface PPB_ImageData { ...@@ -118,7 +118,7 @@ interface PPB_ImageData {
* current contents of the bitmap will be undefined, and the module should * current contents of the bitmap will be undefined, and the module should
* be sure to set all the pixels. * be sure to set all the pixels.
* *
* @return A <code>PP_Resource</code> with a nonzero ID on succes or zero on * @return A <code>PP_Resource</code> with a nonzero ID on success or zero on
* failure. Failure means the instance, image size, or format was invalid. * failure. Failure means the instance, image size, or format was invalid.
*/ */
PP_Resource Create( PP_Resource Create(
......
ppapi/api/ppb_input_event.idl
View file @ e12a6a19
...@@ -321,9 +321,10 @@ interface PPB_InputEvent { ...@@ -321,9 +321,10 @@ interface PPB_InputEvent {
* IsInputEvent() returns true if the given resource is a valid input event * IsInputEvent() returns true if the given resource is a valid input event
* resource. * resource.
* *
* @param[in] resource A <code>PP_Resource</code>. * @param[in] resource A <code>PP_Resource</code> corresponding to a generic
* resource.
* *
* @return True if the given resource is a valid input event * @return <code>PP_TRUE</code> if the given resource is a valid input event
* resource. * resource.
*/ */
PP_Bool IsInputEvent([in] PP_Resource resource); PP_Bool IsInputEvent([in] PP_Resource resource);
...@@ -332,7 +333,8 @@ interface PPB_InputEvent { ...@@ -332,7 +333,8 @@ interface PPB_InputEvent {
* GetType() returns the type of input event for the given input event * GetType() returns the type of input event for the given input event
* resource. * resource.
* *
* @param[in] resource A <code>PP_Resource</code> containing the input event. * @param[in] resource A <code>PP_Resource</code> corresponding to an input
* event.
* *
* @return A <code>PP_InputEvent_Type</code> if its a valid input event or * @return A <code>PP_InputEvent_Type</code> if its a valid input event or
* <code>PP_INPUTEVENT_TYPE_UNDEFINED</code> if the resource is invalid. * <code>PP_INPUTEVENT_TYPE_UNDEFINED</code> if the resource is invalid.
...@@ -345,7 +347,7 @@ interface PPB_InputEvent { ...@@ -345,7 +347,7 @@ interface PPB_InputEvent {
* some overhead. Use this value to compare the times the user generated two * some overhead. Use this value to compare the times the user generated two
* events without being sensitive to variable processing time. * events without being sensitive to variable processing time.
* *
* @param[in] resource A <code>PP_Resource</code> containing the event. * @param[in] resource A <code>PP_Resource</code> corresponding to the event.
* *
* @return The return value is in time ticks, which is a monotonically * @return The return value is in time ticks, which is a monotonically
* increasing clock not related to the wall clock time. It will not change * increasing clock not related to the wall clock time. It will not change
...@@ -360,7 +362,8 @@ interface PPB_InputEvent { ...@@ -360,7 +362,8 @@ interface PPB_InputEvent {
* at the time of the event. This is a combination of the flags in the * at the time of the event. This is a combination of the flags in the
* <code>PP_InputEvent_Modifier</code> enum. * <code>PP_InputEvent_Modifier</code> enum.
* *
* @param[in] resource A <code>PP_Resource</code> containing the input event. * @param[in] resource A <code>PP_Resource</code> corresponding to an input
* event.
* *
* @return The modifiers associated with the event, or 0 if the given * @return The modifiers associated with the event, or 0 if the given
* resource is not a valid event resource. * resource is not a valid event resource.
...@@ -412,7 +415,7 @@ interface PPB_MouseInputEvent { ...@@ -412,7 +415,7 @@ interface PPB_MouseInputEvent {
/** /**
* IsMouseInputEvent() determines if a resource is a mouse event. * IsMouseInputEvent() determines if a resource is a mouse event.
* *
* @param[in] resource A <code>PP_Resource</code> containing the event. * @param[in] resource A <code>PP_Resource</code> corresponding to an event.
* *
* @return <code>PP_TRUE</code> if the given resource is a valid mouse input * @return <code>PP_TRUE</code> if the given resource is a valid mouse input
* event, otherwise <code>PP_FALSE</code>. * event, otherwise <code>PP_FALSE</code>.
...@@ -423,8 +426,8 @@ interface PPB_MouseInputEvent { ...@@ -423,8 +426,8 @@ interface PPB_MouseInputEvent {
* GetButton() returns the mouse button that generated a mouse down or up * GetButton() returns the mouse button that generated a mouse down or up
* event. * event.
* *
* @param[in] mouse_event A <code>PP_Resource</code> containing the mouse * @param[in] mouse_event A <code>PP_Resource</code> corresponding to a
* event. * mouse event.
* *
* @return The mouse button associated with mouse down and up events. This * @return The mouse button associated with mouse down and up events. This
* value will be <code>PP_EVENT_MOUSEBUTTON_NONE</code> for mouse move, * value will be <code>PP_EVENT_MOUSEBUTTON_NONE</code> for mouse move,
...@@ -435,8 +438,8 @@ interface PPB_MouseInputEvent { ...@@ -435,8 +438,8 @@ interface PPB_MouseInputEvent {
/** /**
* GetPosition() returns the pixel location of a mouse input event. * GetPosition() returns the pixel location of a mouse input event.
* *
* @param[in] mouse_event A <code>PP_Resource</code> containing the mouse * @param[in] mouse_event A <code>PP_Resource</code> corresponding to an
* event. * mouse event.
* *
* @return The point associated with the mouse event, relative to the upper- * @return The point associated with the mouse event, relative to the upper-
* left of the instance receiving the event. These values can be negative for * left of the instance receiving the event. These values can be negative for
...@@ -492,7 +495,8 @@ interface PPB_WheelInputEvent { ...@@ -492,7 +495,8 @@ interface PPB_WheelInputEvent {
/** /**
* IsWheelInputEvent() determines if a resource is a wheel event. * IsWheelInputEvent() determines if a resource is a wheel event.
* *
* @param[in] wheel_event A <code>PP_Resource</code> containing the event. * @param[in] wheel_event A <code>PP_Resource</code> corresponding to an
* event.
* *
* @return <code>PP_TRUE</code> if the given resource is a valid wheel input * @return <code>PP_TRUE</code> if the given resource is a valid wheel input
* event. * event.
...@@ -515,7 +519,7 @@ interface PPB_WheelInputEvent { ...@@ -515,7 +519,7 @@ interface PPB_WheelInputEvent {
* possible, for example, on some trackpads and newer mice that don't have * possible, for example, on some trackpads and newer mice that don't have
* "clicks". * "clicks".
* *
* @param[in] wheel_event A <code>PP_Resource</code> containing the wheel * @param[in] wheel_event A <code>PP_Resource</code> corresponding to a wheel
* event. * event.
* *
* @return The vertical and horizontal scroll values. The units are either in * @return The vertical and horizontal scroll values. The units are either in
...@@ -536,7 +540,7 @@ interface PPB_WheelInputEvent { ...@@ -536,7 +540,7 @@ interface PPB_WheelInputEvent {
* want or pixel values. An example may be cycling between different items in * want or pixel values. An example may be cycling between different items in
* a game. * a game.
* *
* @param[in] wheel_event A <code>PP_Resource</code> containing the wheel * @param[in] wheel_event A <code>PP_Resource</code> corresponding to a wheel
* event. * event.
* *
* @return The number of "clicks" of the scroll wheel. You may receive * @return The number of "clicks" of the scroll wheel. You may receive
...@@ -553,7 +557,7 @@ interface PPB_WheelInputEvent { ...@@ -553,7 +557,7 @@ interface PPB_WheelInputEvent {
* GetScrollByPage() indicates if the scroll delta x/y indicates pages or * GetScrollByPage() indicates if the scroll delta x/y indicates pages or
* lines to scroll by. * lines to scroll by.
* *
* @param[in] wheel_event A <code>PP_Resource</code> containing the wheel * @param[in] wheel_event A <code>PP_Resource</code> corresponding to a wheel
* event. * event.
* *
* @return <code>PP_TRUE</code> if the event is a wheel event and the user is * @return <code>PP_TRUE</code> if the event is a wheel event and the user is
...@@ -606,7 +610,7 @@ interface PPB_KeyboardInputEvent { ...@@ -606,7 +610,7 @@ interface PPB_KeyboardInputEvent {
/** /**
* IsKeyboardInputEvent() determines if a resource is a keyboard event. * IsKeyboardInputEvent() determines if a resource is a keyboard event.
* *
* @param[in] resource A <code>PP_Resource</code> containing the event. * @param[in] resource A <code>PP_Resource</code> corresponding to an event.
* *
* @return <code>PP_TRUE</code> if the given resource is a valid input event. * @return <code>PP_TRUE</code> if the given resource is a valid input event.
*/ */
...@@ -616,8 +620,8 @@ interface PPB_KeyboardInputEvent { ...@@ -616,8 +620,8 @@ interface PPB_KeyboardInputEvent {
* GetKeyCode() returns the DOM keyCode field for the keyboard event. * GetKeyCode() returns the DOM keyCode field for the keyboard event.
* Chrome populates this with the Windows-style Virtual Key code of the key. * Chrome populates this with the Windows-style Virtual Key code of the key.
* *
* @param[in] key_event A <code>PP_Resource</code> containing the keyboard * @param[in] key_event A <code>PP_Resource</code> corresponding to a
* event. * keyboard event.
* *
* @return The DOM keyCode field for the keyboard event. * @return The DOM keyCode field for the keyboard event.
*/ */
...@@ -627,7 +631,7 @@ interface PPB_KeyboardInputEvent { ...@@ -627,7 +631,7 @@ interface PPB_KeyboardInputEvent {
* GetCharacterText() returns the typed character as a UTF-8 string for the * GetCharacterText() returns the typed character as a UTF-8 string for the
* given character event. * given character event.
* *
* @param[in] character_event A <code>PP_Resource</code> containing the * @param[in] character_event A <code>PP_Resource</code> corresponding to a
* keyboard event. * keyboard event.
* *
* @return A string var representing a single typed character for character * @return A string var representing a single typed character for character
......
ppapi/api/ppb_instance.idl
View file @ e12a6a19
...@@ -4,7 +4,7 @@ ...@@ -4,7 +4,7 @@
*/ */
/** /**
* This file defines the PPB_Instance interface implemented by the * This file defines the <code>PPB_Instance</code> interface implemented by the
* browser and containing pointers to functions related to * browser and containing pointers to functions related to
* the module instance on a web page. * the module instance on a web page.
*/ */
...@@ -45,8 +45,8 @@ interface PPB_Instance { ...@@ -45,8 +45,8 @@ interface PPB_Instance {
* Binding a device will invalidate that portion of the web page to flush the * Binding a device will invalidate that portion of the web page to flush the
* contents of the new device to the screen. * contents of the new device to the screen.
* *
* @param[in] instance A PP_Instance indentifying one instance of a module. * @param[in] instance A PP_Instance identifying one instance of a module.
* @param[in] device A PP_Resource representing the graphics device. * @param[in] device A PP_Resource corresponding to a graphics device.
* *
* @return <code>PP_Bool</code> containing <code>PP_TRUE</code> if bind was * @return <code>PP_Bool</code> containing <code>PP_TRUE</code> if bind was
* successful or <code>PP_FALSE</code> if the device was not the correct * successful or <code>PP_FALSE</code> if the device was not the correct
...@@ -64,7 +64,7 @@ interface PPB_Instance { ...@@ -64,7 +64,7 @@ interface PPB_Instance {
* page specifies an iframe to a resource with a MIME type registered by the * page specifies an iframe to a resource with a MIME type registered by the
* module. * module.
* *
* @param[in] instance A <code>PP_Instance</code> indentifying one instance * @param[in] instance A <code>PP_Instance</code> identifying one instance
* of a module. * of a module.
* *
* @return A <code>PP_Bool</code> containing <code>PP_TRUE</code> if the * @return A <code>PP_Bool</code> containing <code>PP_TRUE</code> if the
......
ppapi/api/ppb_url_loader.idl
View file @ e12a6a19
...@@ -38,7 +38,7 @@ interface PPB_URLLoader { ...@@ -38,7 +38,7 @@ interface PPB_URLLoader {
* any UI dialogs that need to be shown to the user can be positioned * any UI dialogs that need to be shown to the user can be positioned
* relative to the window containing the instance. * relative to the window containing the instance.
* *
* @param[in] instance A <code>PP_Instance</code> indentifying one instance * @param[in] instance A <code>PP_Instance</code> identifying one instance
* of a module. * of a module.
* *
* @return A <code>PP_Resource</code> corresponding to a URLLoader if * @return A <code>PP_Resource</code> corresponding to a URLLoader if
......
ppapi/api/ppb_url_request_info.idl
View file @ e12a6a19
...@@ -153,7 +153,7 @@ interface PPB_URLRequestInfo { ...@@ -153,7 +153,7 @@ interface PPB_URLRequestInfo {
/** /**
* Create() creates a new <code>URLRequestInfo</code> object. * Create() creates a new <code>URLRequestInfo</code> object.
* *
* @param[in] instance A <code>PP_Instance</code> indentifying one instance * @param[in] instance A <code>PP_Instance</code> identifying one instance
* of a module. * of a module.
* *
* @return A <code>PP_Resource</code> identifying the * @return A <code>PP_Resource</code> identifying the
...@@ -219,7 +219,7 @@ interface PPB_URLRequestInfo { ...@@ -219,7 +219,7 @@ interface PPB_URLRequestInfo {
* *
* @param[in] request A <code>PP_Resource</code> corresponding to a * @param[in] request A <code>PP_Resource</code> corresponding to a
* <code>URLRequestInfo</code>. * <code>URLRequestInfo</code>.
* @param[in] file_ref A <code>PP_Resource</code> containing the file * @param[in] file_ref A <code>PP_Resource</code> corresponding to a file
* reference. * reference.
* @param[in] start_offset An optional starting point offset within the * @param[in] start_offset An optional starting point offset within the
* file. * file.
......
ppapi/api/ppp_instance.idl
View file @ e12a6a19
...@@ -39,7 +39,7 @@ interface PPP_Instance { ...@@ -39,7 +39,7 @@ interface PPP_Instance {
* If this function reports a failure (by returning <code>PP_FALSE</code>), * If this function reports a failure (by returning <code>PP_FALSE</code>),
* the instance will be deleted. * the instance will be deleted.
* *
* @param[in] instance A new <code>PP_Instance</code> indentifying one * @param[in] instance A new <code>PP_Instance</code> identifying one
* instance of a module. This is an opaque handle. * instance of a module. This is an opaque handle.
* *
* @param[in] argc The number of arguments contained in <code>argn</code> * @param[in] argc The number of arguments contained in <code>argn</code>
...@@ -60,7 +60,7 @@ interface PPP_Instance { ...@@ -60,7 +60,7 @@ interface PPP_Instance {
* failure. * failure.
*/ */
PP_Bool DidCreate( PP_Bool DidCreate(
/* A PP_Instance indentifying one instance of a module. */ /* A PP_Instance identifying one instance of a module. */
[in] PP_Instance instance, [in] PP_Instance instance,
/* The number of arguments contained in argn and argv. */ /* The number of arguments contained in argn and argv. */
[in] uint32_t argc, [in] uint32_t argc,
...@@ -102,11 +102,11 @@ interface PPP_Instance { ...@@ -102,11 +102,11 @@ interface PPP_Instance {
* instances are being deleted, and no cleanup functions will be called. * instances are being deleted, and no cleanup functions will be called.
* The module will just be unloaded and the process terminated. * The module will just be unloaded and the process terminated.
* *
* @param[in] instance A <code>PP_Instance</code> indentifying one instance * @param[in] instance A <code>PP_Instance</code> identifying one instance
* of a module. * of a module.
*/ */
void DidDestroy( void DidDestroy(
/* A PP_Instance indentifying one instance of a module. */ /* A PP_Instance identifying one instance of a module. */
[in] PP_Instance instance); [in] PP_Instance instance);
/** /**
...@@ -120,7 +120,7 @@ interface PPP_Instance { ...@@ -120,7 +120,7 @@ interface PPP_Instance {
* the size doesn't change, so you should always check that the size is * the size doesn't change, so you should always check that the size is
* actually different before doing any reallocations. * actually different before doing any reallocations.
* *
* @param[in] instance A <code>PP_Instance</code> indentifying the instance * @param[in] instance A <code>PP_Instance</code> identifying the instance
* that has changed. * that has changed.
* *
* @param[in] position The location on the page of the instance. This is * @param[in] position The location on the page of the instance. This is
...@@ -139,11 +139,11 @@ interface PPP_Instance { ...@@ -139,11 +139,11 @@ interface PPP_Instance {
* the clip when the instance is partially visible. Instead, update the entire * the clip when the instance is partially visible. Instead, update the entire
* region. The time saved doing partial paints is usually not significant and * region. The time saved doing partial paints is usually not significant and
* it can create artifacts when scrolling (this notification is sent * it can create artifacts when scrolling (this notification is sent
* asynchronously from scolling so there can be flashes of old content in the * asynchronously from scrolling so there can be flashes of old content in the
* exposed regions). * exposed regions).
*/ */
void DidChangeView( void DidChangeView(
/* A PP_Instance indentifying the instance whose view changed. */ /* A PP_Instance identifying the instance whose view changed. */
[in] PP_Instance instance, [in] PP_Instance instance,
/* The new location on the page of this instance. This is relative to /* The new location on the page of this instance. This is relative to
* the top left corner of the viewport, which changes as the * the top left corner of the viewport, which changes as the
...@@ -170,13 +170,13 @@ interface PPP_Instance { ...@@ -170,13 +170,13 @@ interface PPP_Instance {
* to make sure you're returning true from the mouse click in * to make sure you're returning true from the mouse click in
* <code>HandleInputEvent</code>. * <code>HandleInputEvent</code>.
* *
* @param[in] instance A <code>PP_Instance</code> indentifying the instance * @param[in] instance A <code>PP_Instance</code> identifying the instance
* receiving the input event. * receiving the input event.
* *
* @param[in] has_focus Indicates the new focused state of the instance. * @param[in] has_focus Indicates the new focused state of the instance.
*/ */
void DidChangeFocus( void DidChangeFocus(
/* A PP_Instance indentifying one instance of a module. */ /* A PP_Instance identifying one instance of a module. */
[in] PP_Instance instance, [in] PP_Instance instance,
/* Indicates whether this NaCl module gained or lost event focus. */ /* Indicates whether this NaCl module gained or lost event focus. */
[in] PP_Bool has_focus); [in] PP_Bool has_focus);
...@@ -200,7 +200,7 @@ interface PPP_Instance { ...@@ -200,7 +200,7 @@ interface PPP_Instance {
* data. In response to this method, the module should call * data. In response to this method, the module should call
* ReadResponseBody() to read the incoming data. * ReadResponseBody() to read the incoming data.
* *
* @param[in] instance A <code>PP_Instance</code> indentifying the instance * @param[in] instance A <code>PP_Instance</code> identifying the instance
* that should do the load. * that should do the load.
* *
* @param[in] url_loader An open <code>PPB_URLLoader</code> instance. * @param[in] url_loader An open <code>PPB_URLLoader</code> instance.
...@@ -209,7 +209,7 @@ interface PPP_Instance { ...@@ -209,7 +209,7 @@ interface PPP_Instance {
* <code>PP_FALSE</code> otherwise. * <code>PP_FALSE</code> otherwise.
*/ */
PP_Bool HandleDocumentLoad( PP_Bool HandleDocumentLoad(
/* A PP_Instance indentifying one instance of a module. */ /* A PP_Instance identifying one instance of a module. */
[in] PP_Instance instance, [in] PP_Instance instance,
/* A PP_Resource an open PPB_URLLoader instance. */ /* A PP_Resource an open PPB_URLLoader instance. */
[in] PP_Resource url_loader); [in] PP_Resource url_loader);
......
ppapi/c/ppb_core.h
View file @ e12a6a19
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
* found in the LICENSE file. * found in the LICENSE file.
*/ */
/* From ppb_core.idl modified Tue Jul 19 13:37:04 2011. */ /* From ppb_core.idl modified Tue Aug 23 11:13:37 2011. */
#ifndef PPAPI_C_PPB_CORE_H_ #ifndef PPAPI_C_PPB_CORE_H_
#define PPAPI_C_PPB_CORE_H_ #define PPAPI_C_PPB_CORE_H_
...@@ -40,13 +40,15 @@ struct PPB_Core { ...@@ -40,13 +40,15 @@ struct PPB_Core {
* *
* AddRefResource() adds a reference to a resource. * AddRefResource() adds a reference to a resource.
* *
* @param[in] config A <code>PP_Resource</code> containing the resource. * @param[in] config A <code>PP_Resource</code> corresponding to a
* resource.
*/ */
void (*AddRefResource)(PP_Resource resource); void (*AddRefResource)(PP_Resource resource);
/** /**
* ReleaseResource() removes a reference from a resource. * ReleaseResource() removes a reference from a resource.
* *
* @param[in] config A <code>PP_Resource</code> containing the resource. * @param[in] config A <code>PP_Resource</code> corresponding to a
* resource.
*/ */
void (*ReleaseResource)(PP_Resource resource); void (*ReleaseResource)(PP_Resource resource);
/** /**
......
ppapi/c/ppb_file_io.h
View file @ e12a6a19
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
* found in the LICENSE file. * found in the LICENSE file.
*/ */
/* From ppb_file_io.idl modified Wed Aug 24 20:51:24 2011. */ /* From ppb_file_io.idl modified Mon Aug 29 10:11:34 2011. */
#ifndef PPAPI_C_PPB_FILE_IO_H_ #ifndef PPAPI_C_PPB_FILE_IO_H_
#define PPAPI_C_PPB_FILE_IO_H_ #define PPAPI_C_PPB_FILE_IO_H_
...@@ -77,7 +77,7 @@ struct PPB_FileIO { ...@@ -77,7 +77,7 @@ struct PPB_FileIO {
/** /**
* Create() creates a new FileIO object. * Create() creates a new FileIO object.
* *
* @param[in] instance A <code>PP_Instance</code> indentifying the instance * @param[in] instance A <code>PP_Instance</code> identifying the instance
* with the file. * with the file.
* *
* @return A <code>PP_Resource</code> corresponding to a FileIO if * @return A <code>PP_Resource</code> corresponding to a FileIO if
......
ppapi/c/ppb_file_system.h
View file @ e12a6a19
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
* found in the LICENSE file. * found in the LICENSE file.
*/ */
/* From ppb_file_system.idl modified Wed Aug 24 20:52:19 2011. */ /* From ppb_file_system.idl modified Mon Aug 29 10:11:34 2011. */
#ifndef PPAPI_C_PPB_FILE_SYSTEM_H_ #ifndef PPAPI_C_PPB_FILE_SYSTEM_H_
#define PPAPI_C_PPB_FILE_SYSTEM_H_ #define PPAPI_C_PPB_FILE_SYSTEM_H_
...@@ -36,7 +36,7 @@ ...@@ -36,7 +36,7 @@
struct PPB_FileSystem { struct PPB_FileSystem {
/** Create() creates a file system object of the given type. /** Create() creates a file system object of the given type.
* *
* @param[in] instance A <code>PP_Instance</code> indentifying the instance * @param[in] instance A <code>PP_Instance</code> identifying the instance
* with the file. * with the file.
* @param[in] type A file system type as defined by * @param[in] type A file system type as defined by
* <code>PP_FileSystemType</code> enum. * <code>PP_FileSystemType</code> enum.
......
ppapi/c/ppb_image_data.h
View file @ e12a6a19
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
* found in the LICENSE file. * found in the LICENSE file.
*/ */
/* From ppb_image_data.idl modified Wed Aug 24 20:50:01 2011. */ /* From ppb_image_data.idl modified Mon Aug 29 10:11:34 2011. */
#ifndef PPAPI_C_PPB_IMAGE_DATA_H_ #ifndef PPAPI_C_PPB_IMAGE_DATA_H_
#define PPAPI_C_PPB_IMAGE_DATA_H_ #define PPAPI_C_PPB_IMAGE_DATA_H_
...@@ -132,7 +132,7 @@ struct PPB_ImageData { ...@@ -132,7 +132,7 @@ struct PPB_ImageData {
* memory, but may contain data from a previous image produced by the same * memory, but may contain data from a previous image produced by the same
* module if the bitmap was cached and re-used. * module if the bitmap was cached and re-used.
* *
* @param[in] instance A <code>PP_Instance</code> indentifying one instance * @param[in] instance A <code>PP_Instance</code> identifying one instance
* of a module. * of a module.
* @param[in] format The desired image data format. * @param[in] format The desired image data format.
* @param[in] size A pointer to a <code>PP_Size</code> containing the image * @param[in] size A pointer to a <code>PP_Size</code> containing the image
...@@ -144,7 +144,7 @@ struct PPB_ImageData { ...@@ -144,7 +144,7 @@ struct PPB_ImageData {
* current contents of the bitmap will be undefined, and the module should * current contents of the bitmap will be undefined, and the module should
* be sure to set all the pixels. * be sure to set all the pixels.
* *
* @return A <code>PP_Resource</code> with a nonzero ID on succes or zero on * @return A <code>PP_Resource</code> with a nonzero ID on success or zero on
* failure. Failure means the instance, image size, or format was invalid. * failure. Failure means the instance, image size, or format was invalid.
*/ */
PP_Resource (*Create)(PP_Instance instance, PP_Resource (*Create)(PP_Instance instance,
......
ppapi/c/ppb_input_event.h
View file @ e12a6a19
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
* found in the LICENSE file. * found in the LICENSE file.
*/ */
/* From ppb_input_event.idl modified Wed Aug 17 11:16:34 2011. */ /* From ppb_input_event.idl modified Wed Aug 24 09:43:38 2011. */
#ifndef PPAPI_C_PPB_INPUT_EVENT_H_ #ifndef PPAPI_C_PPB_INPUT_EVENT_H_
#define PPAPI_C_PPB_INPUT_EVENT_H_ #define PPAPI_C_PPB_INPUT_EVENT_H_
...@@ -336,9 +336,10 @@ struct PPB_InputEvent { ...@@ -336,9 +336,10 @@ struct PPB_InputEvent {
* IsInputEvent() returns true if the given resource is a valid input event * IsInputEvent() returns true if the given resource is a valid input event
* resource. * resource.
* *
* @param[in] resource A <code>PP_Resource</code>. * @param[in] resource A <code>PP_Resource</code> corresponding to a generic
* resource.
* *
* @return True if the given resource is a valid input event * @return <code>PP_TRUE</code> if the given resource is a valid input event
* resource. * resource.
*/ */
PP_Bool (*IsInputEvent)(PP_Resource resource); PP_Bool (*IsInputEvent)(PP_Resource resource);
...@@ -346,7 +347,8 @@ struct PPB_InputEvent { ...@@ -346,7 +347,8 @@ struct PPB_InputEvent {
* GetType() returns the type of input event for the given input event * GetType() returns the type of input event for the given input event
* resource. * resource.
* *
* @param[in] resource A <code>PP_Resource</code> containing the input event. * @param[in] resource A <code>PP_Resource</code> corresponding to an input
* event.
* *
* @return A <code>PP_InputEvent_Type</code> if its a valid input event or * @return A <code>PP_InputEvent_Type</code> if its a valid input event or
* <code>PP_INPUTEVENT_TYPE_UNDEFINED</code> if the resource is invalid. * <code>PP_INPUTEVENT_TYPE_UNDEFINED</code> if the resource is invalid.
...@@ -358,7 +360,7 @@ struct PPB_InputEvent { ...@@ -358,7 +360,7 @@ struct PPB_InputEvent {
* some overhead. Use this value to compare the times the user generated two * some overhead. Use this value to compare the times the user generated two
* events without being sensitive to variable processing time. * events without being sensitive to variable processing time.
* *
* @param[in] resource A <code>PP_Resource</code> containing the event. * @param[in] resource A <code>PP_Resource</code> corresponding to the event.
* *
* @return The return value is in time ticks, which is a monotonically * @return The return value is in time ticks, which is a monotonically
* increasing clock not related to the wall clock time. It will not change * increasing clock not related to the wall clock time. It will not change
...@@ -372,7 +374,8 @@ struct PPB_InputEvent { ...@@ -372,7 +374,8 @@ struct PPB_InputEvent {
* at the time of the event. This is a combination of the flags in the * at the time of the event. This is a combination of the flags in the
* <code>PP_InputEvent_Modifier</code> enum. * <code>PP_InputEvent_Modifier</code> enum.
* *
* @param[in] resource A <code>PP_Resource</code> containing the input event. * @param[in] resource A <code>PP_Resource</code> corresponding to an input
* event.
* *
* @return The modifiers associated with the event, or 0 if the given * @return The modifiers associated with the event, or 0 if the given
* resource is not a valid event resource. * resource is not a valid event resource.
...@@ -422,7 +425,7 @@ struct PPB_MouseInputEvent { ...@@ -422,7 +425,7 @@ struct PPB_MouseInputEvent {
/** /**
* IsMouseInputEvent() determines if a resource is a mouse event. * IsMouseInputEvent() determines if a resource is a mouse event.
* *
* @param[in] resource A <code>PP_Resource</code> containing the event. * @param[in] resource A <code>PP_Resource</code> corresponding to an event.
* *
* @return <code>PP_TRUE</code> if the given resource is a valid mouse input * @return <code>PP_TRUE</code> if the given resource is a valid mouse input
* event, otherwise <code>PP_FALSE</code>. * event, otherwise <code>PP_FALSE</code>.
...@@ -432,8 +435,8 @@ struct PPB_MouseInputEvent { ...@@ -432,8 +435,8 @@ struct PPB_MouseInputEvent {
* GetButton() returns the mouse button that generated a mouse down or up * GetButton() returns the mouse button that generated a mouse down or up
* event. * event.
* *
* @param[in] mouse_event A <code>PP_Resource</code> containing the mouse * @param[in] mouse_event A <code>PP_Resource</code> corresponding to a
* event. * mouse event.
* *
* @return The mouse button associated with mouse down and up events. This * @return The mouse button associated with mouse down and up events. This
* value will be <code>PP_EVENT_MOUSEBUTTON_NONE</code> for mouse move, * value will be <code>PP_EVENT_MOUSEBUTTON_NONE</code> for mouse move,
...@@ -443,8 +446,8 @@ struct PPB_MouseInputEvent { ...@@ -443,8 +446,8 @@ struct PPB_MouseInputEvent {
/** /**
* GetPosition() returns the pixel location of a mouse input event. * GetPosition() returns the pixel location of a mouse input event.
* *
* @param[in] mouse_event A <code>PP_Resource</code> containing the mouse * @param[in] mouse_event A <code>PP_Resource</code> corresponding to an
* event. * mouse event.
* *
* @return The point associated with the mouse event, relative to the upper- * @return The point associated with the mouse event, relative to the upper-
* left of the instance receiving the event. These values can be negative for * left of the instance receiving the event. These values can be negative for
...@@ -496,7 +499,8 @@ struct PPB_WheelInputEvent { ...@@ -496,7 +499,8 @@ struct PPB_WheelInputEvent {
/** /**
* IsWheelInputEvent() determines if a resource is a wheel event. * IsWheelInputEvent() determines if a resource is a wheel event.
* *
* @param[in] wheel_event A <code>PP_Resource</code> containing the event. * @param[in] wheel_event A <code>PP_Resource</code> corresponding to an
* event.
* *
* @return <code>PP_TRUE</code> if the given resource is a valid wheel input * @return <code>PP_TRUE</code> if the given resource is a valid wheel input
* event. * event.
...@@ -518,7 +522,7 @@ struct PPB_WheelInputEvent { ...@@ -518,7 +522,7 @@ struct PPB_WheelInputEvent {
* possible, for example, on some trackpads and newer mice that don't have * possible, for example, on some trackpads and newer mice that don't have
* "clicks". * "clicks".
* *
* @param[in] wheel_event A <code>PP_Resource</code> containing the wheel * @param[in] wheel_event A <code>PP_Resource</code> corresponding to a wheel
* event. * event.
* *
* @return The vertical and horizontal scroll values. The units are either in * @return The vertical and horizontal scroll values. The units are either in
...@@ -538,7 +542,7 @@ struct PPB_WheelInputEvent { ...@@ -538,7 +542,7 @@ struct PPB_WheelInputEvent {
* want or pixel values. An example may be cycling between different items in * want or pixel values. An example may be cycling between different items in
* a game. * a game.
* *
* @param[in] wheel_event A <code>PP_Resource</code> containing the wheel * @param[in] wheel_event A <code>PP_Resource</code> corresponding to a wheel
* event. * event.
* *
* @return The number of "clicks" of the scroll wheel. You may receive * @return The number of "clicks" of the scroll wheel. You may receive
...@@ -554,7 +558,7 @@ struct PPB_WheelInputEvent { ...@@ -554,7 +558,7 @@ struct PPB_WheelInputEvent {
* GetScrollByPage() indicates if the scroll delta x/y indicates pages or * GetScrollByPage() indicates if the scroll delta x/y indicates pages or
* lines to scroll by. * lines to scroll by.
* *
* @param[in] wheel_event A <code>PP_Resource</code> containing the wheel * @param[in] wheel_event A <code>PP_Resource</code> corresponding to a wheel
* event. * event.
* *
* @return <code>PP_TRUE</code> if the event is a wheel event and the user is * @return <code>PP_TRUE</code> if the event is a wheel event and the user is
...@@ -605,7 +609,7 @@ struct PPB_KeyboardInputEvent { ...@@ -605,7 +609,7 @@ struct PPB_KeyboardInputEvent {
/** /**
* IsKeyboardInputEvent() determines if a resource is a keyboard event. * IsKeyboardInputEvent() determines if a resource is a keyboard event.
* *
* @param[in] resource A <code>PP_Resource</code> containing the event. * @param[in] resource A <code>PP_Resource</code> corresponding to an event.
* *
* @return <code>PP_TRUE</code> if the given resource is a valid input event. * @return <code>PP_TRUE</code> if the given resource is a valid input event.
*/ */
...@@ -614,8 +618,8 @@ struct PPB_KeyboardInputEvent { ...@@ -614,8 +618,8 @@ struct PPB_KeyboardInputEvent {
* GetKeyCode() returns the DOM keyCode field for the keyboard event. * GetKeyCode() returns the DOM keyCode field for the keyboard event.
* Chrome populates this with the Windows-style Virtual Key code of the key. * Chrome populates this with the Windows-style Virtual Key code of the key.
* *
* @param[in] key_event A <code>PP_Resource</code> containing the keyboard * @param[in] key_event A <code>PP_Resource</code> corresponding to a
* event. * keyboard event.
* *
* @return The DOM keyCode field for the keyboard event. * @return The DOM keyCode field for the keyboard event.
*/ */
...@@ -624,7 +628,7 @@ struct PPB_KeyboardInputEvent { ...@@ -624,7 +628,7 @@ struct PPB_KeyboardInputEvent {
* GetCharacterText() returns the typed character as a UTF-8 string for the * GetCharacterText() returns the typed character as a UTF-8 string for the
* given character event. * given character event.
* *
* @param[in] character_event A <code>PP_Resource</code> containing the * @param[in] character_event A <code>PP_Resource</code> corresponding to a
* keyboard event. * keyboard event.
* *
* @return A string var representing a single typed character for character * @return A string var representing a single typed character for character
......
ppapi/c/ppb_instance.h
View file @ e12a6a19
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
* found in the LICENSE file. * found in the LICENSE file.
*/ */
/* From ppb_instance.idl modified Mon Aug 15 11:01:06 2011. */ /* From ppb_instance.idl modified Tue Aug 23 11:25:50 2011. */
#ifndef PPAPI_C_PPB_INSTANCE_H_ #ifndef PPAPI_C_PPB_INSTANCE_H_
#define PPAPI_C_PPB_INSTANCE_H_ #define PPAPI_C_PPB_INSTANCE_H_
...@@ -21,7 +21,7 @@ ...@@ -21,7 +21,7 @@
/** /**
* @file * @file
* This file defines the PPB_Instance interface implemented by the * This file defines the <code>PPB_Instance</code> interface implemented by the
* browser and containing pointers to functions related to * browser and containing pointers to functions related to
* the module instance on a web page. * the module instance on a web page.
*/ */
...@@ -54,8 +54,8 @@ struct PPB_Instance { ...@@ -54,8 +54,8 @@ struct PPB_Instance {
* Binding a device will invalidate that portion of the web page to flush the * Binding a device will invalidate that portion of the web page to flush the
* contents of the new device to the screen. * contents of the new device to the screen.
* *
* @param[in] instance A PP_Instance indentifying one instance of a module. * @param[in] instance A PP_Instance identifying one instance of a module.
* @param[in] device A PP_Resource representing the graphics device. * @param[in] device A PP_Resource corresponding to a graphics device.
* *
* @return <code>PP_Bool</code> containing <code>PP_TRUE</code> if bind was * @return <code>PP_Bool</code> containing <code>PP_TRUE</code> if bind was
* successful or <code>PP_FALSE</code> if the device was not the correct * successful or <code>PP_FALSE</code> if the device was not the correct
...@@ -70,7 +70,7 @@ struct PPB_Instance { ...@@ -70,7 +70,7 @@ struct PPB_Instance {
* page specifies an iframe to a resource with a MIME type registered by the * page specifies an iframe to a resource with a MIME type registered by the
* module. * module.
* *
* @param[in] instance A <code>PP_Instance</code> indentifying one instance * @param[in] instance A <code>PP_Instance</code> identifying one instance
* of a module. * of a module.
* *
* @return A <code>PP_Bool</code> containing <code>PP_TRUE</code> if the * @return A <code>PP_Bool</code> containing <code>PP_TRUE</code> if the
......
ppapi/c/ppb_url_loader.h
View file @ e12a6a19
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
* found in the LICENSE file. * found in the LICENSE file.
*/ */
/* From ppb_url_loader.idl modified Wed Aug 24 20:48:35 2011. */ /* From ppb_url_loader.idl modified Mon Aug 29 10:11:34 2011. */
#ifndef PPAPI_C_PPB_URL_LOADER_H_ #ifndef PPAPI_C_PPB_URL_LOADER_H_
#define PPAPI_C_PPB_URL_LOADER_H_ #define PPAPI_C_PPB_URL_LOADER_H_
...@@ -55,7 +55,7 @@ struct PPB_URLLoader { ...@@ -55,7 +55,7 @@ struct PPB_URLLoader {
* any UI dialogs that need to be shown to the user can be positioned * any UI dialogs that need to be shown to the user can be positioned
* relative to the window containing the instance. * relative to the window containing the instance.
* *
* @param[in] instance A <code>PP_Instance</code> indentifying one instance * @param[in] instance A <code>PP_Instance</code> identifying one instance
* of a module. * of a module.
* *
* @return A <code>PP_Resource</code> corresponding to a URLLoader if * @return A <code>PP_Resource</code> corresponding to a URLLoader if
......
ppapi/c/ppb_url_request_info.h
View file @ e12a6a19
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
* found in the LICENSE file. * found in the LICENSE file.
*/ */
/* From ppb_url_request_info.idl modified Wed Aug 24 20:53:00 2011. */ /* From ppb_url_request_info.idl modified Mon Aug 29 10:11:34 2011. */
#ifndef PPAPI_C_PPB_URL_REQUEST_INFO_H_ #ifndef PPAPI_C_PPB_URL_REQUEST_INFO_H_
#define PPAPI_C_PPB_URL_REQUEST_INFO_H_ #define PPAPI_C_PPB_URL_REQUEST_INFO_H_
...@@ -166,7 +166,7 @@ struct PPB_URLRequestInfo { ...@@ -166,7 +166,7 @@ struct PPB_URLRequestInfo {
/** /**
* Create() creates a new <code>URLRequestInfo</code> object. * Create() creates a new <code>URLRequestInfo</code> object.
* *
* @param[in] instance A <code>PP_Instance</code> indentifying one instance * @param[in] instance A <code>PP_Instance</code> identifying one instance
* of a module. * of a module.
* *
* @return A <code>PP_Resource</code> identifying the * @return A <code>PP_Resource</code> identifying the
...@@ -224,7 +224,7 @@ struct PPB_URLRequestInfo { ...@@ -224,7 +224,7 @@ struct PPB_URLRequestInfo {
* *
* @param[in] request A <code>PP_Resource</code> corresponding to a * @param[in] request A <code>PP_Resource</code> corresponding to a
* <code>URLRequestInfo</code>. * <code>URLRequestInfo</code>.
* @param[in] file_ref A <code>PP_Resource</code> containing the file * @param[in] file_ref A <code>PP_Resource</code> corresponding to a file
* reference. * reference.
* @param[in] start_offset An optional starting point offset within the * @param[in] start_offset An optional starting point offset within the
* file. * file.
......
ppapi/c/ppp_instance.h
View file @ e12a6a19
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
* found in the LICENSE file. * found in the LICENSE file.
*/ */
/* From ppp_instance.idl modified Mon Aug 15 11:01:06 2011. */ /* From ppp_instance.idl modified Tue Aug 23 11:29:06 2011. */
#ifndef PPAPI_C_PPP_INSTANCE_H_ #ifndef PPAPI_C_PPP_INSTANCE_H_
#define PPAPI_C_PPP_INSTANCE_H_ #define PPAPI_C_PPP_INSTANCE_H_
...@@ -58,7 +58,7 @@ struct PPP_Instance { ...@@ -58,7 +58,7 @@ struct PPP_Instance {
* If this function reports a failure (by returning <code>PP_FALSE</code>), * If this function reports a failure (by returning <code>PP_FALSE</code>),
* the instance will be deleted. * the instance will be deleted.
* *
* @param[in] instance A new <code>PP_Instance</code> indentifying one * @param[in] instance A new <code>PP_Instance</code> identifying one
* instance of a module. This is an opaque handle. * instance of a module. This is an opaque handle.
* *
* @param[in] argc The number of arguments contained in <code>argn</code> * @param[in] argc The number of arguments contained in <code>argn</code>
...@@ -106,7 +106,7 @@ struct PPP_Instance { ...@@ -106,7 +106,7 @@ struct PPP_Instance {
* instances are being deleted, and no cleanup functions will be called. * instances are being deleted, and no cleanup functions will be called.
* The module will just be unloaded and the process terminated. * The module will just be unloaded and the process terminated.
* *
* @param[in] instance A <code>PP_Instance</code> indentifying one instance * @param[in] instance A <code>PP_Instance</code> identifying one instance
* of a module. * of a module.
*/ */
void (*DidDestroy)(PP_Instance instance); void (*DidDestroy)(PP_Instance instance);
...@@ -121,7 +121,7 @@ struct PPP_Instance { ...@@ -121,7 +121,7 @@ struct PPP_Instance {
* the size doesn't change, so you should always check that the size is * the size doesn't change, so you should always check that the size is
* actually different before doing any reallocations. * actually different before doing any reallocations.
* *
* @param[in] instance A <code>PP_Instance</code> indentifying the instance * @param[in] instance A <code>PP_Instance</code> identifying the instance
* that has changed. * that has changed.
* *
* @param[in] position The location on the page of the instance. This is * @param[in] position The location on the page of the instance. This is
...@@ -140,7 +140,7 @@ struct PPP_Instance { ...@@ -140,7 +140,7 @@ struct PPP_Instance {
* the clip when the instance is partially visible. Instead, update the entire * the clip when the instance is partially visible. Instead, update the entire
* region. The time saved doing partial paints is usually not significant and * region. The time saved doing partial paints is usually not significant and
* it can create artifacts when scrolling (this notification is sent * it can create artifacts when scrolling (this notification is sent
* asynchronously from scolling so there can be flashes of old content in the * asynchronously from scrolling so there can be flashes of old content in the
* exposed regions). * exposed regions).
*/ */
void (*DidChangeView)(PP_Instance instance, void (*DidChangeView)(PP_Instance instance,
...@@ -160,7 +160,7 @@ struct PPP_Instance { ...@@ -160,7 +160,7 @@ struct PPP_Instance {
* to make sure you're returning true from the mouse click in * to make sure you're returning true from the mouse click in
* <code>HandleInputEvent</code>. * <code>HandleInputEvent</code>.
* *
* @param[in] instance A <code>PP_Instance</code> indentifying the instance * @param[in] instance A <code>PP_Instance</code> identifying the instance
* receiving the input event. * receiving the input event.
* *
* @param[in] has_focus Indicates the new focused state of the instance. * @param[in] has_focus Indicates the new focused state of the instance.
...@@ -185,7 +185,7 @@ struct PPP_Instance { ...@@ -185,7 +185,7 @@ struct PPP_Instance {
* data. In response to this method, the module should call * data. In response to this method, the module should call
* ReadResponseBody() to read the incoming data. * ReadResponseBody() to read the incoming data.
* *
* @param[in] instance A <code>PP_Instance</code> indentifying the instance * @param[in] instance A <code>PP_Instance</code> identifying the instance
* that should do the load. * that should do the load.
* *
* @param[in] url_loader An open <code>PPB_URLLoader</code> instance. * @param[in] url_loader An open <code>PPB_URLLoader</code> instance.
......
ppapi/cpp/audio.h
View file @ e12a6a19
...@@ -38,7 +38,7 @@ class Audio : public Resource { ...@@ -38,7 +38,7 @@ class Audio : public Resource {
/// the device configuration and is specified in the <code>AudioConfig</code> /// the device configuration and is specified in the <code>AudioConfig</code>
/// documentation. /// documentation.
/// ///
/// @param[in] instance A pointer to an <code>Instance</code> indentifying one /// @param[in] instance A pointer to an <code>Instance</code> identifying one
/// instance of a module. /// instance of a module.
/// @param[in] config An <code>AudioConfig</code> containing the audio config /// @param[in] config An <code>AudioConfig</code> containing the audio config
/// resource. /// resource.
......
ppapi/cpp/core.h
View file @ e12a6a19
...@@ -26,7 +26,8 @@ class Core { ...@@ -26,7 +26,8 @@ class Core {
/// AddRefResource() increments the reference count for the provided /// AddRefResource() increments the reference count for the provided
/// <code>resource</code>. /// <code>resource</code>.
/// ///
/// @param[in] resource A <code>PP_Resource</code> containing the resource. /// @param[in] resource A <code>PP_Resource</code> corresponding to a
/// resource.
void AddRefResource(PP_Resource resource) { void AddRefResource(PP_Resource resource) {
interface_->AddRefResource(resource); interface_->AddRefResource(resource);
} }
...@@ -35,7 +36,8 @@ class Core { ...@@ -35,7 +36,8 @@ class Core {
/// <code>resource</code>. The resource will be deallocated if the /// <code>resource</code>. The resource will be deallocated if the
/// reference count reaches zero. /// reference count reaches zero.
/// ///
/// @param[in] resource A <code>PP_Resource</code> containing the resource. /// @param[in] resource A <code>PP_Resource</code> corresponding to a
/// resource.
void ReleaseResource(PP_Resource resource) { void ReleaseResource(PP_Resource resource) {
interface_->ReleaseResource(resource); interface_->ReleaseResource(resource);
} }
......
ppapi/cpp/file_system.h
View file @ e12a6a19
...@@ -29,7 +29,7 @@ class FileSystem : public Resource { ...@@ -29,7 +29,7 @@ class FileSystem : public Resource {
/// This constructor creates a file system object of the given type. /// This constructor creates a file system object of the given type.
/// ///
/// @param[in] instance A <code>Instance</code> indentifying the instance /// @param[in] instance A <code>Instance</code> identifying the instance
/// with the file. /// with the file.
/// @param[in] type A file system type as defined by /// @param[in] type A file system type as defined by
/// <code>PP_FileSystemType</code> enum. /// <code>PP_FileSystemType</code> enum.
......
ppapi/cpp/image_data.h
View file @ e12a6a19
...@@ -29,8 +29,8 @@ class ImageData : public Resource { ...@@ -29,8 +29,8 @@ class ImageData : public Resource {
/// reference count of the underlying Image resource. /// reference count of the underlying Image resource.
struct PassRef {}; struct PassRef {};
/// A constructor used when you have received a PP_Resource as a return /// A constructor used when you have received a <code>PP_Resource</code> as a
/// value that has already been reference counted. /// return value that has already been reference counted.
/// ///
/// @param[in] resource A PP_Resource corresponding to image data. /// @param[in] resource A PP_Resource corresponding to image data.
ImageData(PassRef, PP_Resource resource); ImageData(PassRef, PP_Resource resource);
...@@ -46,7 +46,7 @@ class ImageData : public Resource { ...@@ -46,7 +46,7 @@ class ImageData : public Resource {
/// with the provided parameters. The resulting object will be is_null() if /// with the provided parameters. The resulting object will be is_null() if
/// the allocation failed. /// the allocation failed.
/// ///
/// @param[in] instance A <code>PP_Instance</code> indentifying one instance /// @param[in] instance A <code>PP_Instance</code> identifying one instance
/// of a module. /// of a module.
/// ///
/// @param[in] format A PP_ImageDataFormat containing desired image format. /// @param[in] format A PP_ImageDataFormat containing desired image format.
......
ppapi/cpp/resource.h
View file @ e12a6a19
...@@ -56,7 +56,8 @@ class Resource { ...@@ -56,7 +56,8 @@ class Resource {
/// A constructor used when a <code>PP_Resource</code> is provided as a /// A constructor used when a <code>PP_Resource</code> is provided as a
/// return value whose reference count we need to increment. /// return value whose reference count we need to increment.
/// ///
/// @param[in] resource A <code>PP_Resource</code>. /// @param[in] resource A <code>PP_Resource</code> corresponding to a
/// resource.
explicit Resource(PP_Resource resource); explicit Resource(PP_Resource resource);
/// PassRefFromConstructor is called by derived class' constructors to /// PassRefFromConstructor is called by derived class' constructors to
...@@ -71,7 +72,8 @@ class Resource { ...@@ -71,7 +72,8 @@ class Resource {
/// since it was returned by the browser, already had its reference count /// since it was returned by the browser, already had its reference count
/// increased). /// increased).
/// ///
/// @param[in] resource A PP_Resource. /// @param[in] resource A <code>PP_Resource</code> corresponding to a
/// resource.
void PassRefFromConstructor(PP_Resource resource); void PassRefFromConstructor(PP_Resource resource);
private: private:
......
ppapi/cpp/url_response_info.h
View file @ e12a6a19
...@@ -29,7 +29,8 @@ class URLResponseInfo : public Resource { ...@@ -29,7 +29,8 @@ class URLResponseInfo : public Resource {
/// A constructor used when you have received a <code>PP_Resource</code> as a /// A constructor used when you have received a <code>PP_Resource</code> as a
/// return value that has already been reference counted. /// return value that has already been reference counted.
/// ///
/// @param[in] resource A <code>PP_Resource</code>. /// @param[in] resource A <code>PP_Resource</code> corresponding to a
/// resource.
URLResponseInfo(PassRef, PP_Resource resource); URLResponseInfo(PassRef, PP_Resource resource);
/// The copy constructor for <code>URLResponseInfo</code>. /// The copy constructor for <code>URLResponseInfo</code>.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment