aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/SkPoint_Reference.bmh
diff options
context:
space:
mode:
authorGravatar Cary Clark <caryclark@skia.org>2018-05-16 07:07:07 -0400
committerGravatar Skia Commit-Bot <skia-commit-bot@chromium.org>2018-05-16 11:35:24 +0000
commit682c58da482155213e8cd2834b57bc6541e510a0 (patch)
tree63d666ea9ec0c2e765557e61e9ec5fc78ad9747f /docs/SkPoint_Reference.bmh
parent4c2a34e4804e5affa8447b590578a359bad2caf8 (diff)
Documentation refresh
- add links to types within methods - add check to see that all references and definitions match - add style to tables to make them easier to read - use https everywhere - remove trailing spaces - move overview inside class - split class and struct in summary tables - add missing #Line - clean up SkImageInfo constant documentation - work on SkColor documentation - allow common phrases to take different parameters - add more flexibility to generated tables - tighten token parent requirements - generalize deprecated and example interfaces - detect inner constructors R=caryclark@google.com Docs-Preview: https://skia.org/?cl=121799 Bug: skia:6898 Change-Id: Ia75a23740b80259460916890b310e2a9f024962a Reviewed-on: https://skia-review.googlesource.com/121799 Commit-Queue: Cary Clark <caryclark@skia.org> Auto-Submit: Cary Clark <caryclark@skia.org> Reviewed-by: Cary Clark <caryclark@skia.org>
Diffstat (limited to 'docs/SkPoint_Reference.bmh')
-rw-r--r--docs/SkPoint_Reference.bmh33
1 files changed, 20 insertions, 13 deletions
diff --git a/docs/SkPoint_Reference.bmh b/docs/SkPoint_Reference.bmh
index ff7710e781..0f98f19326 100644
--- a/docs/SkPoint_Reference.bmh
+++ b/docs/SkPoint_Reference.bmh
@@ -2,15 +2,13 @@
#Alias Points
#Alias Point_Reference
-#Subtopic Overview
- #Subtopic Subtopic
- #Populate
- ##
-##
-
#Struct SkPoint
-SkPoint holds two 32 bit floating point coordinates.
+SkPoint holds two 32-bit floating point coordinates.
+
+#Subtopic Overview
+#Populate
+##
#Subtopic Related_Function
#Populate
@@ -174,9 +172,9 @@ pt1 == pt2
#Line # sets to integer input ##
Sets fX to x and fY to y, promoting integers to SkScalar values.
-Assigning a large integer value directly to fX or fY may cause a compiler
+Assigning a large integer value directly to fX or fY may cause a compiler
error, triggered by narrowing conversion of int to SkScalar. This safely
-casts x and y to avoid the error.
+casts x and y to avoid the error.
#Param x new value for fX ##
#Param y new value for fY ##
@@ -199,7 +197,7 @@ Sets fX to p.fX and fY to p.fY, promoting integers to SkScalar values.
Assigning an IPoint containing a large integer value directly to fX or fY may
cause a compiler error, triggered by narrowing conversion of int to SkScalar.
-This safely casts p.fX and p.fY to avoid the error.
+This safely casts p.fX and p.fY to avoid the error.
#Param p IPoint members promoted to SkScalar ##
@@ -245,7 +243,7 @@ pt: nan, -nan abs: nan, nan
##
##
-#SeeAlso set Make negate
+#SeeAlso set Make negate
#Method ##
@@ -1258,12 +1256,21 @@ Returns the dot product of Vector and Vector vec.
#Struct SkPoint ##
-#Topic Point ##
# ------------------------------------------------------------------------------
-#Topic Vector
+#Subtopic Vector
+#Line # alias for Point ##
+ #Alias Vector
#Alias Vectors
#Typedef SkPoint SkVector
+ #Line # alias for Point ##
+ #Code
+ typedef SkPoint SkVector;
+ ##
+ SkVector provides an alternative name for SkPoint. SkVector and SkPoint can
+ be used interchangably for all purposes.
#Typedef ##
##
+
+#Topic Point ##