Updating documentation

ppapi/c/pp_rect.h

Index: ppapi/c/pp_rect.h
===================================================================
--- ppapi/c/pp_rect.h	(revision 73518)
+++ ppapi/c/pp_rect.h	(working copy)
@@ -7,7 +7,7 @@
 
 /**
  * @file
- * Defines the API ...
+ * This file defines the APIs for creating a 2 dimensional rectangle.
  */
 
 #include "ppapi/c/pp_macros.h"
@@ -19,8 +19,16 @@
  * @addtogroup Structs
  * @{
  */
+
+/**
+ * The PP_Rect struct contains the size and location of a 2D rectangle.
+ */
 struct PP_Rect {
+
+  /** This value represents the x and y coordinates of the rectangle. */

[dmichael(do not use this one), 2011/02/02 23:36:51]

of the upper left corner of the rectangle.

[jond, 2011/02/03 17:28:11]

Done.

   struct PP_Point point;
+
+  /** This value represents the width and height of the rectangle. */
   struct PP_Size size;
 };
 PP_COMPILE_ASSERT_STRUCT_SIZE_IN_BYTES(PP_Rect, 16);
@@ -32,6 +40,18 @@
  * @addtogroup Functions
  * @{
  */
+
+/**
+ * PP_MakeRectFromXYWH() places four 32 bit integers inside a PP_Rect

[dmichael(do not use this one), 2011/02/02 23:36:51]

wording more like 'creates a PP_Rect from ...'

[jond, 2011/02/03 17:28:11]

Done.

+ * structure.
+ * @param[in] x A 32 bit value representing a horizontal coordinate on the

[dmichael(do not use this one), 2011/02/02 23:36:51]

s/'A 32 bit'/'An int32_t'

[jond, 2011/02/03 17:28:11]

Done.

+ * screen.
+ * @param[in] y A 32 bit value representing a vertical coordinate on the
+ * screen.
+ * @param[in] w A 32 bit value representing a width.
+ * @param[in] h A 32 bit value representing a height.
+ * @return A PP_Rect structure.
+ */
 PP_INLINE struct PP_Rect PP_MakeRectFromXYWH(int32_t x, int32_t y,
                                              int32_t w, int32_t h) {
   struct PP_Rect ret;