generate tables instead of manual entry
- make descriptions of table entries phrases instead of sentences;
lower case start, no ending period (not enforced, yet)
- add #Line markup to move one line descriptions to the #Method
body. Later, will generate tables like Member_Functions from this
- add #In markup to associate a #Method with a #Subtopic. Later, will
generate tables of related methods from this
- remove return type from operator overloads in tables
- add new colorTypes to examples that index into arrays of strings
to name them
Docs-Preview: https://skia.org/?cl=100422
TBR=caryclark@google.com
Bug: skia:6898
Change-Id: I8558048866369f419f1944832b99c05da3fd52bb
Reviewed-on: https://skia-review.googlesource.com/100422
Reviewed-by: Cary Clark <caryclark@skia.org>
Commit-Queue: Cary Clark <caryclark@skia.org>
diff --git a/docs/SkIPoint_Reference.bmh b/docs/SkIPoint_Reference.bmh
index 3a431de..857c25d 100644
--- a/docs/SkIPoint_Reference.bmh
+++ b/docs/SkIPoint_Reference.bmh
@@ -32,15 +32,15 @@
#Subtopic Operators
#Table
#Legend
-# name # description ##
+# name # description ##
#Legend ##
-# SkIPoint operator+(const SkIPoint& a, const SkIVector& b) # returns IPoint offset by IVector ##
-# SkIPoint operator-()_const # reverses sign of IPoint ##
-# SkIVector operator-(const SkIPoint& a, const SkIPoint& b) # returns IVector between IPoints ##
-# bool operator!=(const SkIPoint& a, const SkIPoint& b) # returns true if IPoints are unequal ##
-# bool operator==(const SkIPoint& a, const SkIPoint& b) # returns true if IPoints are equal ##
-# void operator+=(const SkIVector& v) # adds IVector to IPoint ##
-# void operator-=(const SkIVector& v) # subtracts IVector from IPoint ##
+# operator+(const SkIPoint& a, const SkIVector& b) # returns IPoint offset by IVector ##
+# operator-()_const # reverses sign of IPoint ##
+# operator-(const SkIPoint& a, const SkIPoint& b) # returns IVector between IPoints ##
+# operator!=(const SkIPoint& a, const SkIPoint& b) # returns true if IPoints are unequal ##
+# operator==(const SkIPoint& a, const SkIPoint& b) # returns true if IPoints are equal ##
+# operator+=(const SkIVector& v) # adds IVector to IPoint ##
+# operator-=(const SkIVector& v) # subtracts IVector from IPoint ##
#Table ##
#Subtopic ##
@@ -72,6 +72,7 @@
#Method static constexpr SkIPoint Make(int32_t x, int32_t y)
+#Line # constructs from integer inputs ##
Sets fX to x, fY to y.
#Param x integer x-axis value of constructed IPoint ##
@@ -96,6 +97,7 @@
#Method int32_t x() const
+#Line # returns fX ##
Returns x-axis value of IPoint.
#Return fX ##
@@ -116,6 +118,7 @@
#Method int32_t y() const
+#Line # returns fY ##
Returns y-axis value of IPoint.
#Return fY ##
@@ -136,6 +139,7 @@
#Method bool isZero() const
+#Line # returns true if both members equal zero ##
Returns true if fX and fY are both zero.
#Return true if fX is zero and fY is zero ##
@@ -156,6 +160,7 @@
#Method void set(int32_t x, int32_t y)
+#Line # sets to integer input ##
Sets fX to x and fY to y.
#Param x new value for fX ##
@@ -178,6 +183,7 @@
#Method SkIPoint operator-()_const
+#Line # reverses sign of IPoint ##
Returns IPoint changing the signs of fX and fY.
#Return IPoint as (-fX, -fY) ##
@@ -206,6 +212,7 @@
#Method void operator+=(const SkIVector& v)
+#Line # adds IVector to IPoint ##
Offsets IPoint by IVector v. Sets IPoint to
#Formula
(fX + v.fX, fY + v.fY)
@@ -244,6 +251,7 @@
#Method void operator-=(const SkIVector& v)
+#Line # subtracts IVector from IPoint ##
Subtracts IVector v from IPoint. Sets IPoint to:
#Formula
(fX - v.fX, fY - v.fY)
@@ -282,6 +290,7 @@
#Method bool equals(int32_t x, int32_t y) const
+#Line # returns true if members are equal ##
Returns true if IPoint is equivalent to IPoint constructed from (x, y).
#Param x value compared with fX ##
@@ -310,6 +319,7 @@
#Method bool operator==(const SkIPoint& a, const SkIPoint& b)
+#Line # returns true if IPoints are equal ##
Returns true if a is equivalent to b.
#Param a IPoint to compare ##
@@ -338,6 +348,7 @@
#Method bool operator!=(const SkIPoint& a, const SkIPoint& b)
+#Line # returns true if IPoints are unequal ##
Returns true if a is not equivalent to b.
#Param a IPoint to compare ##
@@ -366,6 +377,7 @@
#Method SkIVector operator-(const SkIPoint& a, const SkIPoint& b)
+#Line # returns IVector between IPoints ##
Returns IVector from b to a; computed as
#Formula
(a.fX - b.fX, a.fY - b.fY)
@@ -409,6 +421,7 @@
#Method SkIPoint operator+(const SkIPoint& a, const SkIVector& b)
+#Line # returns IPoint offset by IVector ##
Returns IPoint resulting from IPoint a offset by IVector b, computed as:
#Formula
(a.fX + b.fX, a.fY + b.fY)