Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(790)

Unified Diff: ppapi/c/pp_point.h

Issue 6312098: Updating documentation (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src/
Patch Set: '' Created 9 years, 11 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 side-by-side diff with in-line comments
Download patch
Index: ppapi/c/pp_point.h
===================================================================
--- ppapi/c/pp_point.h (revision 73518)
+++ ppapi/c/pp_point.h (working copy)
@@ -7,7 +7,8 @@
/**
* @file
- * Defines the API ...
+ * This file defines the APIs to create a 2 dimensional point on the screen.
dmichael(do not use this one) 2011/02/02 23:36:51 s/APIs/API s/create/represent s/on the screen/in t
jond 2011/02/03 17:28:11 Done.
+ * 0,0 is the upper-left corner of the screen.
dmichael(do not use this one) 2011/02/02 23:36:51 s/screen/drawing window (???)
jond 2011/02/03 17:28:11 Done.
*/
#include "ppapi/c/pp_macros.h"
@@ -18,8 +19,18 @@
* @addtogroup Structs
* @{
*/
+
+/**
+ * The PP_Point structure defines the x and y coordinates of a point on the
+ * screen.
+ */
dmichael(do not use this one) 2011/02/02 23:36:51 Not 'on the screen'
jond 2011/02/03 17:28:11 Done.
struct PP_Point {
+ /** This value represents the horizontal coordinate of a point on the
+ * screen.
dmichael(do not use this one) 2011/02/02 23:36:51 not 'on the screen', counting from 0 on the left.
jond 2011/02/03 17:28:11 Done.
+ */
int32_t x;
+
+ /* This value represents the vertical coordinate of a point on the screen. */
dmichael(do not use this one) 2011/02/02 23:36:51 not 'on the screen', counting from 0 at the top.
jond 2011/02/03 17:28:11 Done.
int32_t y;
};
PP_COMPILE_ASSERT_STRUCT_SIZE_IN_BYTES(PP_Point, 8);
@@ -31,6 +42,15 @@
* @addtogroup Functions
* @{
*/
+
+/**
+ * PP_MakePoint() places two 32 bit integers inside a PP_Point structure.
dmichael(do not use this one) 2011/02/02 23:36:51 I'd rather wording like: 'creates a PP_Point given
jond 2011/02/03 17:28:11 Done.
jond 2011/02/03 17:28:11 Done.
+ * @param[in] x A 32 bit value representing a horizontal coordinate on the
+ * screen.
+ * @param[in] y A 32 bit value representing a vertical coordinate on the
+ * screen.
+ * @return A PP_Point structure.
+ */
PP_INLINE struct PP_Point PP_MakePoint(int32_t x, int32_t y) {
struct PP_Point ret;
ret.x = x;

Powered by Google App Engine
This is Rietveld 408576698