Updating documentation

ppapi/c/pp_rect.h

Index: ppapi/c/pp_rect.h
===================================================================
--- ppapi/c/pp_rect.h	(revision 73626)
+++ 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 upper left corner of the rectangle. */

[dmichael(do not use this one), 2011/02/03 17:42:00]

Sorry, I think I meant 'the x and y coordinates of the upper left corner' (or
similar)

[jond, 2011/02/03 18:03:14]

Done.

[jond, 2011/02/03 18:03:14]

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() creates a PP_Rect given x and y coordinates and w
+ * and h dimensions as int32_t values.

[dmichael(do not use this one), 2011/02/03 17:42:00]

w->width
h->height

[jond, 2011/02/03 18:03:14]

Done.

+ * @param[in] x An int32_t value representing a horizontal coordinate of a
+ * point, starting with 0 as the left-most coordinate.
+ * @param[in] y An int32_t value representing a vertical coordinate of a point,
+ * starting with 0 as the top-most coordinate.
+ * @param[in] w An int32_t value representing a width.
+ * @param[in] h An int32_t 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;