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>
diff --git a/docs/SkIRect_Reference.bmh b/docs/SkIRect_Reference.bmh
index 578949a..4fcb26a 100644
--- a/docs/SkIRect_Reference.bmh
+++ b/docs/SkIRect_Reference.bmh
@@ -2,19 +2,17 @@
#Alias IRects
#Alias IRect_Reference
-#Subtopic Overview
- #Subtopic Subtopic
- #Populate
- ##
-##
-
#Struct SkIRect
-SkIRect holds four 32 bit integer coordinates describing the upper and
-lower bounds of a rectangle. SkIRect may be created from outer bounds or
+SkIRect holds four 32-bit integer coordinates describing the upper and
+lower bounds of a rectangle. SkIRect may be created from outer bounds or
from position, width, and height. SkIRect describes an area; if its right
is less than or equal to its left, or if its bottom is less than or equal to
-its top, it is considered empty.
+its top, it is considered empty.
+
+#Subtopic Overview
+#Populate
+##
#Subtopic Related_Function
#Populate
@@ -126,7 +124,7 @@
#In Constructor
#Line # constructs from ISize returning (0, 0, width, height) ##
-Returns constructed IRect set to (0, 0, size.width(), size.height()).
+Returns constructed IRect set to (0, 0, size.width(), size.height()).
Does not validate input; size.width() or size.height() may be negative.
#Param size values for IRect width and height ##
@@ -145,7 +143,7 @@
##
##
-#SeeAlso MakeWH MakeXYWH SkRect::Make SkRect::MakeIWH
+#SeeAlso MakeWH MakeXYWH SkRect::Make SkRect::MakeIWH
##
@@ -590,7 +588,7 @@
#In Operator
#Line # returns true if members are equal ##
-Returns true if all members in a: fLeft, fTop, fRight, and fBottom; are
+Returns true if all members in a: fLeft, fTop, fRight, and fBottom; are
identical to corresponding members in b.
#Param a IRect to compare ##
@@ -617,7 +615,7 @@
#In Operator
#Line # returns true if members are unequal ##
-Returns true if any member in a: fLeft, fTop, fRight, and fBottom; is not
+Returns true if any member in a: fLeft, fTop, fRight, and fBottom; is not
identical to the corresponding member in b.
#Param a IRect to compare ##
@@ -787,7 +785,7 @@
If dx is negative, IRect returned is moved to the left.
If dx is positive, IRect returned is moved to the right.
If dy is negative, IRect returned is moved upward.
-If dy is positive, IRect returned is moved downward.
+If dy is positive, IRect returned is moved downward.
#Param dx offset added to fLeft and fRight ##
#Param dy offset added to fTop and fBottom ##
@@ -822,7 +820,7 @@
If dx is negative, IRect returned is wider.
If dx is positive, IRect returned is narrower.
If dy is negative, IRect returned is taller.
-If dy is positive, IRect returned is shorter.
+If dy is positive, IRect returned is shorter.
#Param dx offset added to fLeft and subtracted from fRight ##
#Param dy offset added to fTop and subtracted from fBottom ##
@@ -857,7 +855,7 @@
If dx is negative, IRect returned is narrower.
If dx is positive, IRect returned is wider.
If dy is negative, IRect returned is shorter.
-If dy is positive, IRect returned is taller.
+If dy is positive, IRect returned is taller.
#Param dx offset subtracted to fLeft and added from fRight ##
#Param dy offset subtracted to fTop and added from fBottom ##
@@ -892,7 +890,7 @@
If dx is negative, moves IRect returned to the left.
If dx is positive, moves IRect returned to the right.
If dy is negative, moves IRect returned upward.
-If dy is positive, moves IRect returned downward.
+If dy is positive, moves IRect returned downward.
#Param dx offset added to fLeft and fRight ##
#Param dy offset added to fTop and fBottom ##
@@ -921,7 +919,7 @@
If delta.fX is negative, moves IRect returned to the left.
If delta.fX is positive, moves IRect returned to the right.
If delta.fY is negative, moves IRect returned upward.
-If delta.fY is positive, moves IRect returned downward.
+If delta.fY is positive, moves IRect returned downward.
#Param delta offset added to IRect ##
@@ -1024,9 +1022,9 @@
#Subtopic Inset_Outset_Offset ##
#Subtopic Intersection
-#Line # set to shared bounds ##
+#Line # sets to shared bounds ##
-IRects intersect when they enclose a common area. To intersect, each of the pair
+IRects intersect when they enclose a common area. To intersect, each of the pair
must describe area; fLeft is less than fRight, and fTop is less than fBottom;
empty() returns false. The intersection of IRect pair can be described by:
@@ -1295,11 +1293,11 @@
SkIRect leftRect = { 10, 40, 50, 80 };
SkIRect rightRect = { 30, 60, 70, 90 };
SkDebugf("%s intersection: ", leftRect.intersect(rightRect) ? "" : "no ");
- SkDebugf("%d, %d, %d, %d\n", leftRect.left(), leftRect.top(),
+ SkDebugf("%d, %d, %d, %d\n", leftRect.left(), leftRect.top(),
leftRect.right(), leftRect.bottom());
#StdOut
intersection: 30, 60, 50, 80
-##
+##
##
#SeeAlso Intersects intersectNoEmptyCheck join SkRect::intersect
@@ -1328,7 +1326,7 @@
result.left(), result.top(), result.right(), result.bottom());
#StdOut
intersection: 30, 60, 50, 80
-##
+##
##
#SeeAlso Intersects intersectNoEmptyCheck join SkRect::intersect
@@ -1359,7 +1357,7 @@
}
#StdOut
intersection: 30, 60, 50, 80
-##
+##
##
#SeeAlso Intersects intersect join SkRect::intersect
@@ -1394,11 +1392,11 @@
##
SkIRect leftRect = { 10, 40, 50, 80 };
SkDebugf("%s intersection: ", leftRect.intersect(30, 60, 70, 90) ? "" : "no ");
- SkDebugf("%d, %d, %d, %d\n", leftRect.left(), leftRect.top(),
+ SkDebugf("%d, %d, %d, %d\n", leftRect.left(), leftRect.top(),
leftRect.right(), leftRect.bottom());
#StdOut
intersection: 30, 60, 50, 80
-##
+##
##
#SeeAlso intersectNoEmptyCheck Intersects join SkRect::intersect
@@ -1423,7 +1421,7 @@
SkDebugf("%s intersection", SkIRect::Intersects({10, 40, 50, 80}, {30, 60, 70, 90}) ? "" : "no ");
#StdOut
intersection
-##
+##
##
#SeeAlso IntersectsNoEmptyCheck intersect SkRect::intersect
@@ -1449,7 +1447,7 @@
{10, 40, 50, 80}, {30, 60, 70, 90}) ? "" : "no ");
#StdOut
intersection
-##
+##
##
#SeeAlso Intersects intersect SkRect::intersect
@@ -1461,7 +1459,7 @@
# ------------------------------------------------------------------------------
#Subtopic Join
-#Line # set to union of bounds ##
+#Line # sets to union of bounds ##
#Populate
##
@@ -1488,7 +1486,7 @@
SkDebugf("join: %d, %d, %d, %d\n", rect.fLeft, rect.fTop, rect.fRight, rect.fBottom);
#StdOut
join: 10, 20, 55, 65
-##
+##
##
#SeeAlso set SkRect::join
@@ -1512,7 +1510,7 @@
SkDebugf("join: %d, %d, %d, %d\n", rect.fLeft, rect.fTop, rect.fRight, rect.fBottom);
#StdOut
join: 10, 20, 55, 65
-##
+##
##
#SeeAlso set SkRect::join
@@ -1555,7 +1553,7 @@
#In Sorting
#In Constructor
-#Line # constructs, ordering sides from smaller to larger ##
+#Line # constructs IRect, ordering sides from smaller to larger ##
Returns IRect with fLeft and fRight swapped if fLeft is greater than fRight; and
with fTop and fBottom swapped if fTop is greater than fBottom. Result may be empty;
and width() and height() will be zero or positive.