diff options
author | jond@google.com <jond@google.com@0039d316-1c4b-4281-b951-d872f2087c98> | 2011-01-28 15:38:38 +0000 |
---|---|---|
committer | jond@google.com <jond@google.com@0039d316-1c4b-4281-b951-d872f2087c98> | 2011-01-28 15:38:38 +0000 |
commit | 040d5e8ab48c9afd2e6b4cf5242ac046246294a9 (patch) | |
tree | 0ea586d994085daa68a9b755f537ebe93f82d808 /ppapi/c | |
parent | 37b5646dc039811b09502b501dffd7c8a35202cd (diff) | |
download | chromium_src-040d5e8ab48c9afd2e6b4cf5242ac046246294a9.zip chromium_src-040d5e8ab48c9afd2e6b4cf5242ac046246294a9.tar.gz chromium_src-040d5e8ab48c9afd2e6b4cf5242ac046246294a9.tar.bz2 |
Removed Doxygen groupings by ppb_, pp_, and ppp_. Added grouping by construct (enums, interfaces, and so on).
Review URL: http://codereview.chromium.org/6297018
git-svn-id: svn://svn.chromium.org/chrome/trunk/src@72960 0039d316-1c4b-4281-b951-d872f2087c98
Diffstat (limited to 'ppapi/c')
-rw-r--r-- | ppapi/c/pp_bool.h | 11 | ||||
-rw-r--r-- | ppapi/c/pp_completion_callback.h | 40 | ||||
-rw-r--r-- | ppapi/c/pp_errors.h | 7 | ||||
-rw-r--r-- | ppapi/c/pp_input_event.h | 67 | ||||
-rw-r--r-- | ppapi/c/pp_instance.h | 10 | ||||
-rw-r--r-- | ppapi/c/pp_module.h | 11 | ||||
-rw-r--r-- | ppapi/c/pp_point.h | 17 | ||||
-rw-r--r-- | ppapi/c/pp_rect.h | 16 | ||||
-rw-r--r-- | ppapi/c/pp_resource.h | 9 | ||||
-rw-r--r-- | ppapi/c/pp_size.h | 16 | ||||
-rw-r--r-- | ppapi/c/pp_stdint.h | 7 | ||||
-rw-r--r-- | ppapi/c/pp_var.h | 27 | ||||
-rw-r--r-- | ppapi/c/ppb.h | 7 | ||||
-rw-r--r-- | ppapi/c/ppb_audio.h | 14 | ||||
-rw-r--r-- | ppapi/c/ppb_audio_config.h | 24 | ||||
-rw-r--r-- | ppapi/c/ppb_class.h | 34 | ||||
-rw-r--r-- | ppapi/c/ppb_core.h | 9 | ||||
-rw-r--r-- | ppapi/c/ppb_graphics_2d.h | 3 | ||||
-rw-r--r-- | ppapi/c/ppb_image_data.h | 29 | ||||
-rw-r--r-- | ppapi/c/ppb_instance.h | 5 | ||||
-rw-r--r-- | ppapi/c/ppb_url_loader.h | 13 | ||||
-rw-r--r-- | ppapi/c/ppb_url_request_info.h | 21 | ||||
-rw-r--r-- | ppapi/c/ppb_url_response_info.h | 21 | ||||
-rw-r--r-- | ppapi/c/ppb_var.h | 36 | ||||
-rw-r--r-- | ppapi/c/ppp.h | 33 | ||||
-rw-r--r-- | ppapi/c/ppp_instance.h | 5 |
26 files changed, 399 insertions, 93 deletions
diff --git a/ppapi/c/pp_bool.h b/ppapi/c/pp_bool.h index 8bca4ef..dcc3923 100644 --- a/ppapi/c/pp_bool.h +++ b/ppapi/c/pp_bool.h @@ -10,8 +10,11 @@ /** * @file * Defines the API ... + */ + +/** * - * @addtogroup PP + * @addtogroup Enums * @{ */ @@ -26,11 +29,13 @@ typedef enum { PP_TRUE = 1 } PP_Bool; PP_COMPILE_ASSERT_SIZE_IN_BYTES(PP_Bool, 4); - /** * @} - * End addtogroup PP */ + + + + #endif /* PPAPI_C_PP_BOOL_H_ */ diff --git a/ppapi/c/pp_completion_callback.h b/ppapi/c/pp_completion_callback.h index ac9aa3f..f648951 100644 --- a/ppapi/c/pp_completion_callback.h +++ b/ppapi/c/pp_completion_callback.h @@ -8,9 +8,6 @@ /** * @file * Defines the API ... - * - * @addtogroup PP - * @{ */ #include <stdlib.h> @@ -18,7 +15,19 @@ #include "ppapi/c/pp_macros.h" #include "ppapi/c/pp_stdint.h" +/** + * @addtogroup Typedefs + * @{ + */ typedef void (*PP_CompletionCallback_Func)(void* user_data, int32_t result); +/** + * @} + */ + +/** + * @addtogroup Structs + * @{ + */ /** * Any method that takes a PP_CompletionCallback has the option of completing @@ -36,7 +45,14 @@ struct PP_CompletionCallback { PP_CompletionCallback_Func func; void* user_data; }; +/** + * @} + */ +/** + * @addtogroup Functions + * @{ + */ PP_INLINE struct PP_CompletionCallback PP_MakeCompletionCallback( PP_CompletionCallback_Func func, void* user_data) { @@ -45,11 +61,26 @@ PP_INLINE struct PP_CompletionCallback PP_MakeCompletionCallback( cc.user_data = user_data; return cc; } +/** + * @} + */ +/** + * @addtogroup Functions + * @{ + */ PP_INLINE void PP_RunCompletionCallback(struct PP_CompletionCallback* cc, int32_t res) { cc->func(cc->user_data, res); } +/** + * @} + */ + +/** + * @addtogroup Functions + * @{ + */ /** * Use this in place of an actual completion callback to request blocking @@ -59,10 +90,9 @@ PP_INLINE void PP_RunCompletionCallback(struct PP_CompletionCallback* cc, PP_INLINE struct PP_CompletionCallback PP_BlockUntilComplete() { return PP_MakeCompletionCallback(NULL, NULL); } - /** * @} - * End of addtogroup PP */ + #endif /* PPAPI_C_PP_COMPLETION_CALLBACK_H_ */ diff --git a/ppapi/c/pp_errors.h b/ppapi/c/pp_errors.h index 5d2e13a..cec0f01 100644 --- a/ppapi/c/pp_errors.h +++ b/ppapi/c/pp_errors.h @@ -8,8 +8,11 @@ /** * @file * Defines the API ... + + */ +/** * - * @addtogroup PP + * @addtogroup Enums * @{ */ @@ -76,7 +79,7 @@ enum { /** * @} - * End of addtogroup PP + * End of addtogroup Enums */ #endif /* PPAPI_C_PP_ERRORS_H_ */ diff --git a/ppapi/c/pp_input_event.h b/ppapi/c/pp_input_event.h index f1a46cf..9dc7849 100644 --- a/ppapi/c/pp_input_event.h +++ b/ppapi/c/pp_input_event.h @@ -8,9 +8,6 @@ /** * @file * Defines the API ... - * - * @addtogroup PP - * @{ */ #include "ppapi/c/pp_bool.h" @@ -18,6 +15,11 @@ #include "ppapi/c/pp_stdint.h" #include "ppapi/c/pp_time.h" +/** + * + * @addtogroup Enums + * @{ + */ typedef enum { PP_INPUTEVENT_MOUSEBUTTON_NONE = -1, PP_INPUTEVENT_MOUSEBUTTON_LEFT = 0, @@ -25,7 +27,15 @@ typedef enum { PP_INPUTEVENT_MOUSEBUTTON_RIGHT = 2 } PP_InputEvent_MouseButton; PP_COMPILE_ASSERT_SIZE_IN_BYTES(PP_InputEvent_MouseButton, 4); +/** + * @} + */ +/** + * + * @addtogroup Enums + * @{ + */ typedef enum { PP_INPUTEVENT_TYPE_UNDEFINED = -1, PP_INPUTEVENT_TYPE_MOUSEDOWN = 0, // PP_InputEvent_Mouse @@ -41,7 +51,15 @@ typedef enum { PP_INPUTEVENT_TYPE_CONTEXTMENU = 10 // PP_InputEvent_Mouse } PP_InputEvent_Type; PP_COMPILE_ASSERT_SIZE_IN_BYTES(PP_InputEvent_Type, 4); +/** + * @} + */ +/** + * + * @addtogroup Enums + * @{ + */ typedef enum { PP_INPUTEVENT_MODIFIER_SHIFTKEY = 1 << 0, PP_INPUTEVENT_MODIFIER_CONTROLKEY = 1 << 1, @@ -56,6 +74,14 @@ typedef enum { PP_INPUTEVENT_MODIFIER_NUMLOCKKEY = 1 << 10 } PP_InputEvent_Modifier; PP_COMPILE_ASSERT_SIZE_IN_BYTES(PP_InputEvent_Modifier, 4); +/** + * @} + */ + +/** + * @addtogroup Structs + * @{ + */ /** * An event representing a key up or down event. @@ -70,6 +96,7 @@ PP_COMPILE_ASSERT_SIZE_IN_BYTES(PP_InputEvent_Modifier, 4); * click elsewhere on the web page, the plugin focus will be lost and no more * input events will be delivered. If you depend on getting key up events, you * will also want to handle "lost focus" as the equivalent of "all keys up." + * */ struct PP_InputEvent_Key { /** A combination of the EVENT_MODIFIER flags. */ @@ -83,6 +110,14 @@ struct PP_InputEvent_Key { uint32_t key_code; }; PP_COMPILE_ASSERT_STRUCT_SIZE_IN_BYTES(PP_InputEvent_Key, 8); +/** + * @} + */ + +/** + * @addtogroup Structs + * @{ + */ /** * An event representing a typed character. @@ -103,6 +138,7 @@ PP_COMPILE_ASSERT_STRUCT_SIZE_IN_BYTES(PP_InputEvent_Key, 8); * an 'R', the system might send unlaut down, umlaut up, 'R' key down, umlaut * character ("whoops, I can't combine it with 'R', I better just send the raw * unlaut so it isn't lost"), 'R' character event, 'R' key up. + * */ struct PP_InputEvent_Character { /** A combination of the EVENT_MODIFIER flags. */ @@ -117,6 +153,14 @@ struct PP_InputEvent_Character { char text[5]; }; PP_COMPILE_ASSERT_STRUCT_SIZE_IN_BYTES(PP_InputEvent_Character, 12); +/** + * @} + */ + +/** + * @addtogroup Structs + * @{ + */ /** Represents a mouse event for everything other than the mouse wheel. */ struct PP_InputEvent_Mouse { @@ -144,7 +188,14 @@ struct PP_InputEvent_Mouse { int32_t click_count; }; PP_COMPILE_ASSERT_STRUCT_SIZE_IN_BYTES(PP_InputEvent_Mouse, 20); +/** + * @} + */ +/** + * @addtogroup Structs + * @{ + */ struct PP_InputEvent_Wheel { /** A combination of the EVENT_MODIFIER flags. */ uint32_t modifier; @@ -157,7 +208,15 @@ struct PP_InputEvent_Wheel { PP_Bool scroll_by_page; }; PP_COMPILE_ASSERT_STRUCT_SIZE_IN_BYTES(PP_InputEvent_Wheel, 24); +/** + * @} + */ +/** + * + * @addtogroup Structs + * @{ + */ struct PP_InputEvent { /** Identifies the type of the event. */ PP_InputEvent_Type type; @@ -188,10 +247,8 @@ struct PP_InputEvent { } u; }; PP_COMPILE_ASSERT_STRUCT_SIZE_IN_BYTES(PP_InputEvent, 80); - /** * @} - * End of addtogroup PP */ #endif /* PPAPI_C_PP_INPUT_EVENT_H_ */ diff --git a/ppapi/c/pp_instance.h b/ppapi/c/pp_instance.h index 87d430c..9dcdc4b 100644 --- a/ppapi/c/pp_instance.h +++ b/ppapi/c/pp_instance.h @@ -8,14 +8,16 @@ /** * @file * Defines the API ... - * - * @addtogroup PP - * @{ */ #include "ppapi/c/pp_macros.h" #include "ppapi/c/pp_stdint.h" +/** + * @addtogroup Typedefs + * @{ + */ + /** A PP_Instance uniquely identifies one plugin instance, which is one time * that a page says \<embed>. There can be multiple instances of the same plugin * type on a page that will all be in the same module. @@ -26,10 +28,8 @@ */ typedef int32_t PP_Instance; PP_COMPILE_ASSERT_SIZE_IN_BYTES(PP_Instance, 4); - /** * @} - * End addtogroup PP */ #endif /* PPAPI_C_PP_INSTANCE_H_ */ diff --git a/ppapi/c/pp_module.h b/ppapi/c/pp_module.h index 02373b2..90126c4 100644 --- a/ppapi/c/pp_module.h +++ b/ppapi/c/pp_module.h @@ -8,25 +8,26 @@ /** * @file * Defines the API ... - * - * @addtogroup PP - * @{ */ #include "ppapi/c/pp_macros.h" #include "ppapi/c/pp_stdint.h" /** + * + * @addtogroup Typedefs + * @{ + */ + +/** * A module uniquely identifies one plugin library. The identifier is an opaque * handle assigned by the browser to the plugin. It is guaranteed never to be * 0, so a plugin can initialize it to 0 to indicate a "NULL handle." */ typedef int32_t PP_Module; PP_COMPILE_ASSERT_SIZE_IN_BYTES(PP_Module, 4); - /** * @} - * End addtogroup PP */ #endif /* PPAPI_C_PP_MODULE_H_ */ diff --git a/ppapi/c/pp_point.h b/ppapi/c/pp_point.h index fe15dbe..8ff052e 100644 --- a/ppapi/c/pp_point.h +++ b/ppapi/c/pp_point.h @@ -8,30 +8,37 @@ /** * @file * Defines the API ... - * - * @addtogroup PP - * @{ */ #include "ppapi/c/pp_macros.h" #include "ppapi/c/pp_stdint.h" +/** + * + * @addtogroup Structs + * @{ + */ struct PP_Point { int32_t x; int32_t y; }; PP_COMPILE_ASSERT_STRUCT_SIZE_IN_BYTES(PP_Point, 8); +/** + * @} + */ +/** + * @addtogroup Functions + * @{ + */ PP_INLINE struct PP_Point PP_MakePoint(int32_t x, int32_t y) { struct PP_Point ret; ret.x = x; ret.y = y; return ret; } - /** * @} - * End addtogroup PP */ #endif /* PPAPI_C_PP_POINT_H_ */ diff --git a/ppapi/c/pp_rect.h b/ppapi/c/pp_rect.h index 9fae6f8..3debabb 100644 --- a/ppapi/c/pp_rect.h +++ b/ppapi/c/pp_rect.h @@ -8,9 +8,6 @@ /** * @file * Defines the API ... - * - * @addtogroup PP - * @{ */ #include "ppapi/c/pp_macros.h" @@ -18,12 +15,23 @@ #include "ppapi/c/pp_size.h" #include "ppapi/c/pp_stdint.h" +/** + * @addtogroup Structs + * @{ + */ struct PP_Rect { struct PP_Point point; struct PP_Size size; }; PP_COMPILE_ASSERT_STRUCT_SIZE_IN_BYTES(PP_Rect, 16); +/** + * @} + */ +/** + * @addtogroup Functions + * @{ + */ PP_INLINE struct PP_Rect PP_MakeRectFromXYWH(int32_t x, int32_t y, int32_t w, int32_t h) { struct PP_Rect ret; @@ -33,10 +41,8 @@ PP_INLINE struct PP_Rect PP_MakeRectFromXYWH(int32_t x, int32_t y, ret.size.height = h; return ret; } - /** * @} - * End addtogroup PP */ #endif /* PPAPI_C_PP_RECT_H_ */ diff --git a/ppapi/c/pp_resource.h b/ppapi/c/pp_resource.h index e74799d..cd58c6b 100644 --- a/ppapi/c/pp_resource.h +++ b/ppapi/c/pp_resource.h @@ -11,8 +11,10 @@ /** * @file * Defines the API ... - * - * @addtogroup PP + */ + +/** + * @addtogroup Typedefs * @{ */ @@ -29,13 +31,12 @@ * guaranteed never to be 0 for a valid resource, so a plugin can initialize * it to 0 to indicate a "NULL handle." Some interfaces may return a NULL * resource to indicate failure. + * */ typedef int32_t PP_Resource; PP_COMPILE_ASSERT_SIZE_IN_BYTES(PP_Resource, 4); - /** * @} - * End addtogroup PP */ #endif /* PPAPI_C_PP_RESOURCE_H_ */ diff --git a/ppapi/c/pp_size.h b/ppapi/c/pp_size.h index 945a499..e414376 100644 --- a/ppapi/c/pp_size.h +++ b/ppapi/c/pp_size.h @@ -8,30 +8,36 @@ /** * @file * Defines the API ... - * - * @addtogroup PP - * @{ */ #include "ppapi/c/pp_macros.h" #include "ppapi/c/pp_stdint.h" +/** + * @addtogroup Structs + * @{ + */ struct PP_Size { int32_t width; int32_t height; }; PP_COMPILE_ASSERT_STRUCT_SIZE_IN_BYTES(PP_Size, 8); +/** + * @} + */ +/** + * @addtogroup Functions + * @{ + */ PP_INLINE struct PP_Size PP_MakeSize(int32_t w, int32_t h) { struct PP_Size ret; ret.width = w; ret.height = h; return ret; } - /** * @} - * End addtogroup PP */ #endif /* PPAPI_C_PP_SIZE_H_ */ diff --git a/ppapi/c/pp_stdint.h b/ppapi/c/pp_stdint.h index 2875e4b..412b949 100644 --- a/ppapi/c/pp_stdint.h +++ b/ppapi/c/pp_stdint.h @@ -9,9 +9,6 @@ * @file * Provides a definition of C99 sized types * across different compilers. - * - * @addtogroup PP - * @{ */ #if defined(_MSC_VER) @@ -30,9 +27,5 @@ typedef unsigned __int64 uint64_t; #include <stddef.h> /* Needed for size_t. */ -/** - * @} - * End addtogroup PP - */ #endif /* PPAPI_C_PP_STDINT_H_ */ diff --git a/ppapi/c/pp_var.h b/ppapi/c/pp_var.h index 9a429cb..a53a5e8 100644 --- a/ppapi/c/pp_var.h +++ b/ppapi/c/pp_var.h @@ -8,15 +8,17 @@ /** * @file * Defines the API ... - * - * @addtogroup PP - * @{ */ #include "ppapi/c/pp_bool.h" #include "ppapi/c/pp_macros.h" #include "ppapi/c/pp_stdint.h" +/** + * + * @addtogroup Enums + * @{ + */ typedef enum { PP_VARTYPE_UNDEFINED, PP_VARTYPE_NULL, @@ -27,6 +29,14 @@ typedef enum { PP_VARTYPE_OBJECT } PP_VarType; PP_COMPILE_ASSERT_SIZE_IN_BYTES(PP_VarType, 4); +/** + * @} + */ + +/** + * @addtogroup Structs + * @{ + */ /** * Do not rely on having a predictable and reproducible @@ -39,6 +49,7 @@ PP_COMPILE_ASSERT_SIZE_IN_BYTES(PP_VarType, 4); * * Your best bet is to have a wrapper for variables * that always gets out the type you expect, converting as necessary. + * */ struct PP_Var { PP_VarType type; @@ -63,7 +74,14 @@ struct PP_Var { } value; }; PP_COMPILE_ASSERT_STRUCT_SIZE_IN_BYTES(PP_Var, 16); +/** + * @} + */ +/** + * @addtogroup Functions + * @{ + */ PP_INLINE struct PP_Var PP_MakeUndefined() { struct PP_Var result = { PP_VARTYPE_UNDEFINED, 0, {PP_FALSE} }; return result; @@ -91,10 +109,9 @@ PP_INLINE struct PP_Var PP_MakeDouble(double value) { result.value.as_double = value; return result; } - /** * @} - * End addtogroup PP */ + #endif /* PPAPI_C_PP_VAR_H_ */ diff --git a/ppapi/c/ppb.h b/ppapi/c/ppb.h index 3f05257..f777d0e 100644 --- a/ppapi/c/ppb.h +++ b/ppapi/c/ppb.h @@ -9,7 +9,10 @@ * @file * Defines the API ... * - * @addtogroup PPB + */ + +/** + * @addtogroup Typedefs * @{ */ @@ -18,10 +21,8 @@ * if the interface is not supported. Interface names should be ASCII. */ typedef const void* (*PPB_GetInterface)(const char* interface_name); - /** * @} - * End addtogroup PPB */ #endif /* PPAPI_C_PPB_H_ */ diff --git a/ppapi/c/ppb_audio.h b/ppapi/c/ppb_audio.h index 63603a2..e659976 100644 --- a/ppapi/c/ppb_audio.h +++ b/ppapi/c/ppb_audio.h @@ -13,11 +13,22 @@ #define PPB_AUDIO_INTERFACE "PPB_Audio;0.5" +/** + * @addtogroup Typedefs + * @{ + */ // Callback function type for SetCallback. typedef void (*PPB_Audio_Callback)(void* sample_buffer, size_t buffer_size_in_bytes, void* user_data); +/** + * @} + */ +/** + * @addtogroup Structs + * @{ + */ // Callback-based audio interface. User of audio must set the callback that will // be called each time that the buffer needs to be filled. // @@ -68,6 +79,9 @@ struct PPB_Audio { // StopPlayback will block until callback completes. PP_Bool (*StopPlayback)(PP_Resource audio); }; +/** + * @} + */ #endif /* PPAPI_C_PPB_DEVICE_CONTEXT_AUDIO_H_ */ diff --git a/ppapi/c/ppb_audio_config.h b/ppapi/c/ppb_audio_config.h index 8c16797..585db6a 100644 --- a/ppapi/c/ppb_audio_config.h +++ b/ppapi/c/ppb_audio_config.h @@ -13,17 +13,38 @@ #define PPB_AUDIO_CONFIG_INTERFACE "PPB_AudioConfig;0.5" +/** + * + * @addtogroup Enums + * @{ + */ enum { PP_AUDIOMINSAMPLEFRAMECOUNT = 64, PP_AUDIOMAXSAMPLEFRAMECOUNT = 32768 }; +/** + * @} + */ +/** + * + * @addtogroup Enums + * @{ + */ typedef enum { PP_AUDIOSAMPLERATE_NONE = 0, PP_AUDIOSAMPLERATE_44100 = 44100, PP_AUDIOSAMPLERATE_48000 = 48000 } PP_AudioSampleRate; PP_COMPILE_ASSERT_SIZE_IN_BYTES(PP_AudioSampleRate, 4); +/** + * @} + */ + +/** + * @addtogroup Interfaces + * @{ + */ /** * Audio configuration. This base configuration interface supports only stereo @@ -93,6 +114,9 @@ struct PPB_AudioConfig { */ uint32_t (*GetSampleFrameCount)(PP_Resource config); }; +/** + * @} + */ #endif /* PPAPI_C_PPB_AUDIO_CONFIG_H_ */ diff --git a/ppapi/c/ppb_class.h b/ppapi/c/ppb_class.h index ce058c5..e2fc940 100644 --- a/ppapi/c/ppb_class.h +++ b/ppapi/c/ppb_class.h @@ -17,7 +17,10 @@ * @file * Defines the PPB_Class struct. * - * @addtogroup PPB + */ + +/** + * @addtogroup Typedefs * @{ */ @@ -29,14 +32,30 @@ * is no other type protection - if your module contains two objects with * different native_ptr information, make sure you can handle the case of * JS calling one object's function with another object set as this. + * */ typedef struct PP_Var (*PP_ClassFunction)(void* native_ptr, struct PP_Var this_object, /*NOLINT*/ struct PP_Var* args, uint32_t argc, struct PP_Var* exception); +/** + * @} + */ +/** + * @addtogroup Typedefs + * @{ + */ typedef void (*PP_ClassDestructor)(void* native_ptr); +/** + * @} + */ + +/** + * @addtogroup Structs + * @{ + */ /** * One property of a class. @@ -50,6 +69,7 @@ typedef void (*PP_ClassDestructor)(void* native_ptr); * Not providing a getter will be equivalent to having a getter which returns * undefined. Not providing a setter will be equivalent to providing a setter * which doesn't do anything. + * */ struct PP_ClassProperty { const char* name; @@ -58,6 +78,14 @@ struct PP_ClassProperty { PP_ClassFunction setter; uint32_t modifiers; }; +/** + * @} + */ + +/** + * @addtogroup Interfaces + * @{ + */ /** Interface for implementing JavaScript-accessible objects. * @@ -116,10 +144,10 @@ struct PPB_Class { void* native_ptr, struct PP_Var* exception); }; - /** * @} - * End addtogroup PPP */ + + #endif /* PPAPI_C_PPP_CLASS_H_ */ diff --git a/ppapi/c/ppb_core.h b/ppapi/c/ppb_core.h index 0d27937..c577013 100644 --- a/ppapi/c/ppb_core.h +++ b/ppapi/c/ppb_core.h @@ -19,7 +19,10 @@ struct PP_CompletionCallback; * @file * Defines the API ... * - * @addtogroup PPB + */ + +/** + * @addtogroup Interfaces * @{ */ @@ -85,10 +88,10 @@ struct PPB_Core { */ PP_Bool (*IsMainThread)(); }; - /** * @} - * End addtogroup PPB */ + + #endif /* PPAPI_C_DEV_PPB_CORE_DEV_H_ */ diff --git a/ppapi/c/ppb_graphics_2d.h b/ppapi/c/ppb_graphics_2d.h index c0a4225..1cb97b7 100644 --- a/ppapi/c/ppb_graphics_2d.h +++ b/ppapi/c/ppb_graphics_2d.h @@ -22,7 +22,7 @@ struct PP_Size; * @file * Defines the PPB_Graphics2D struct. * - * @addtogroup PPB + * @addtogroup Interfaces * @{ */ @@ -219,7 +219,6 @@ struct PPB_Graphics2D { /** * @} - * End addtogroup PPB */ #endif /* PPAPI_C_PPB_GRAPHICS_2D_H_ */ diff --git a/ppapi/c/ppb_image_data.h b/ppapi/c/ppb_image_data.h index 27fbbc0..c9c6f99 100644 --- a/ppapi/c/ppb_image_data.h +++ b/ppapi/c/ppb_image_data.h @@ -13,12 +13,29 @@ #include "ppapi/c/pp_size.h" #include "ppapi/c/pp_stdint.h" +/** + * @file + * Defines the API ... + */ + +/** + * @addtogroup Enums + * @{ + */ + typedef enum { PP_IMAGEDATAFORMAT_BGRA_PREMUL, PP_IMAGEDATAFORMAT_RGBA_PREMUL } PP_ImageDataFormat; PP_COMPILE_ASSERT_SIZE_IN_BYTES(PP_ImageDataFormat, 4); +/** + * @} + */ +/** + * @addtogroup Structs + * @{ + */ struct PP_ImageDataDesc { PP_ImageDataFormat format; @@ -31,17 +48,16 @@ struct PP_ImageDataDesc { int32_t stride; }; PP_COMPILE_ASSERT_STRUCT_SIZE_IN_BYTES(PP_ImageDataDesc, 16); +/** + * @} + */ #define PPB_IMAGEDATA_INTERFACE "PPB_ImageData;0.3" /** - * @file - * Defines the API ... - * - * @addtogroup PPB + * @addtogroup Interfaces * @{ */ - struct PPB_ImageData { /** * Returns the browser's preferred format for image data. This format will be @@ -97,10 +113,9 @@ struct PPB_ImageData { void (*Unmap)(PP_Resource image_data); }; - /** * @} - * End addtogroup PPB */ + #endif /* PPAPI_C_PPB_IMAGE_DATA_H_ */ diff --git a/ppapi/c/ppb_instance.h b/ppapi/c/ppb_instance.h index 48d47a8..852e215 100644 --- a/ppapi/c/ppb_instance.h +++ b/ppapi/c/ppb_instance.h @@ -16,7 +16,7 @@ * @file * Defines the API ... * - * @addtogroup PPB + * @addtogroup Interfaces * @{ */ @@ -83,10 +83,9 @@ struct PPB_Instance { struct PP_Var script, struct PP_Var* exception); }; - /** * @} - * End addtogroup PPB */ + #endif /* PPAPI_C_PPB_INSTANCE_H_ */ diff --git a/ppapi/c/ppb_url_loader.h b/ppapi/c/ppb_url_loader.h index 01390c9..8dfc409 100644 --- a/ppapi/c/ppb_url_loader.h +++ b/ppapi/c/ppb_url_loader.h @@ -14,6 +14,16 @@ struct PP_CompletionCallback; #define PPB_URLLOADER_INTERFACE "PPB_URLLoader;0.1" +/** + * @file + * Defines the API ... + */ + +/** + * @addtogroup Interfaces + * @{ + */ + // The interface for loading URLs. // // Typical steps for loading an URL: @@ -105,6 +115,9 @@ struct PPB_URLLoader { // Close method. void (*Close)(PP_Resource loader); }; +/** + * @} + */ #endif /* PPAPI_C_PPB_URL_LOADER_H_ */ diff --git a/ppapi/c/ppb_url_request_info.h b/ppapi/c/ppb_url_request_info.h index aef42bb..1369c31 100644 --- a/ppapi/c/ppb_url_request_info.h +++ b/ppapi/c/ppb_url_request_info.h @@ -14,6 +14,16 @@ struct PP_Var; +/** + * @file + * Defines the API ... + */ + +/** + * + * @addtogroup Enums + * @{ + */ typedef enum { PP_URLREQUESTPROPERTY_URL, // string PP_URLREQUESTPROPERTY_METHOD, // string @@ -34,9 +44,17 @@ typedef enum { PP_URLREQUESTPROPERTY_RECORDUPLOADPROGRESS } PP_URLRequestProperty; PP_COMPILE_ASSERT_SIZE_IN_BYTES(PP_URLRequestProperty, 4); +/** + * @} + */ #define PPB_URLREQUESTINFO_INTERFACE "PPB_URLRequestInfo;0.2" +/** + * + * @addtogroup Interfaces + * @{ + */ struct PPB_URLRequestInfo { // Create a new URLRequestInfo object. Returns 0 if the module is invalid. PP_Resource (*Create)(PP_Instance instance); @@ -83,6 +101,9 @@ struct PPB_URLRequestInfo { int64_t number_of_bytes, PP_Time expected_last_modified_time); }; +/** + * @} + */ #endif /* PPAPI_C_PPB_URL_REQUEST_INFO_H_ */ diff --git a/ppapi/c/ppb_url_response_info.h b/ppapi/c/ppb_url_response_info.h index c0d8675..48ab33e 100644 --- a/ppapi/c/ppb_url_response_info.h +++ b/ppapi/c/ppb_url_response_info.h @@ -10,6 +10,11 @@ #include "ppapi/c/pp_resource.h" #include "ppapi/c/pp_var.h" +/** + * + * @addtogroup Enums + * @{ + */ typedef enum { PP_URLRESPONSEPROPERTY_URL, // string PP_URLRESPONSEPROPERTY_REDIRECTURL, // string @@ -19,9 +24,22 @@ typedef enum { PP_URLRESPONSEPROPERTY_HEADERS // string, \n-delim } PP_URLResponseProperty; PP_COMPILE_ASSERT_SIZE_IN_BYTES(PP_URLResponseProperty, 4); +/** + * @} + */ #define PPB_URLRESPONSEINFO_INTERFACE "PPB_URLResponseInfo;0.1" +/** + * @file + * Defines the API ... + */ + +/** + * + * @addtogroup Interfaces + * @{ + */ struct PPB_URLResponseInfo { // Returns PP_TRUE if the given resource is an URLResponseInfo. Returns // PP_FALSE if the resource is invalid or some type other than an @@ -41,6 +59,9 @@ struct PPB_URLResponseInfo { // requested or if the URLLoader has not been opened yet. PP_Resource (*GetBodyAsFileRef)(PP_Resource response); }; +/** + * @} + */ #endif /* PPAPI_C_PPB_URL_RESPONSE_INFO_H_ */ diff --git a/ppapi/c/ppb_var.h b/ppapi/c/ppb_var.h index 4cfe3a6..8d84bf3 100644 --- a/ppapi/c/ppb_var.h +++ b/ppapi/c/ppb_var.h @@ -16,16 +16,18 @@ #define PPB_VAR_INTERFACE "PPB_Var;0.4" /** + * + * @addtogroup Enums + * @{ + */ + +/** * @file * Defines the PPB_Var struct. * See http://code.google.com/p/ppapi/wiki/InterfacingWithJavaScript * for general information on using this interface. * {PENDING: Should the generated doc really be pointing to methods?} - * - * @addtogroup PPB - * @{ */ - enum PP_ObjectProperty_Modifier { PP_OBJECTPROPERTY_MODIFIER_NONE = 0, PP_OBJECTPROPERTY_MODIFIER_READONLY = 1 << 0, @@ -34,7 +36,14 @@ enum PP_ObjectProperty_Modifier { PP_OBJECTPROPERTY_MODIFIER_HASVALUE = 1 << 3 }; PP_COMPILE_ASSERT_ENUM_SIZE_IN_BYTES(PP_ObjectProperty_Modifier, 4); +/** + * @} + */ +/** + * @addtogroup Structs + * @{ + */ struct PP_ObjectProperty { struct PP_Var name; struct PP_Var value; @@ -51,6 +60,14 @@ struct PP_ObjectProperty { int32_t padding; }; PP_COMPILE_ASSERT_STRUCT_SIZE_IN_BYTES(PP_ObjectProperty, 72); +/** + * @} + */ + +/** + * @addtogroup Interfaces + * @{ + */ /** * PPB_Var API @@ -81,6 +98,7 @@ PP_COMPILE_ASSERT_STRUCT_SIZE_IN_BYTES(PP_ObjectProperty, 72); * type. * TODO(neb): Specify the exception for ill-formed PP_Vars, invalid module, * instance, resource, string and object ids. + * */ struct PPB_Var { /** @@ -290,7 +308,14 @@ struct PPB_Var { struct PP_Var* argv, struct PP_Var* exception); }; +/** + * @} + */ +/** + * @addtogroup Functions + * @{ + */ PP_INLINE struct PP_ObjectProperty PP_MakeSimpleProperty(struct PP_Var name, struct PP_Var value) { struct PP_ObjectProperty result; @@ -301,10 +326,9 @@ PP_INLINE struct PP_ObjectProperty PP_MakeSimpleProperty(struct PP_Var name, result.modifiers = PP_OBJECTPROPERTY_MODIFIER_HASVALUE; return result; } - /** * @} - * End addtogroup PPB */ + #endif /* PPAPI_C_PPB_VAR_H_ */ diff --git a/ppapi/c/ppp.h b/ppapi/c/ppp.h index 2f3a19a..173f8fa 100644 --- a/ppapi/c/ppp.h +++ b/ppapi/c/ppp.h @@ -20,8 +20,6 @@ * Defines the API ... * * {PENDING: undefine PP_EXPORT?} - * @addtogroup PPP - * @{ */ /* We don't want name mangling for these external functions. We only need @@ -32,31 +30,52 @@ extern "C" { #endif /** + * @addtogroup Functions + * @{ + */ + +/** * Entrypoint for the module. * * Returns PP_OK on success, any other value on failure. Failure indicates to * the browser that this plugin can not be used. In this case, the plugin will * be unloaded and ShutdownModule will NOT be called. - */ + * +*/ PP_EXPORT int32_t PPP_InitializeModule(PP_Module module, PPB_GetInterface get_browser_interface); +/** + * @} + */ + +/** + * @addtogroup Functions + * @{ + */ /** Called before the plugin module is unloaded. */ PP_EXPORT void PPP_ShutdownModule(); +/** + * @} + */ + +/** + * @addtogroup Functions + * @{ + */ /** * Returns an interface pointer for the interface of the given name, or NULL * if the interface is not supported. Interface names should be ASCII. */ PP_EXPORT const void* PPP_GetInterface(const char* interface_name); +/** + * @} + */ #ifdef __cplusplus } /* extern "C" */ #endif -/** - * @} - * End addtogroup PPP - */ #endif /* PPAPI_C_PPP_H_ */ diff --git a/ppapi/c/ppp_instance.h b/ppapi/c/ppp_instance.h index f32fbde..ff1eff2 100644 --- a/ppapi/c/ppp_instance.h +++ b/ppapi/c/ppp_instance.h @@ -19,7 +19,7 @@ struct PP_Var; * @file * Defines the API ... * - * @addtogroup PPP + * @addtogroup Interfaces * @{ */ @@ -126,10 +126,9 @@ struct PPP_Instance { */ struct PP_Var (*GetInstanceObject)(PP_Instance instance); }; - /** * @} - * End addtogroup PPP */ + #endif /* PPAPI_C_PPP_INSTANCE_H_ */ |