Condense embedded formulas.
Bookmaker delimits formulas and equations to allow
representing variables and symbols without tripping
up reference lookup, spell checking, and comment
generation.
Before, formulas were represented with:
some text
#Formula
(x + y, 0)
##
, and more text
This made it difficult to know when spacing should
be preserved before and after the formula. Now,
formulas are represented with:
some text #Formula # (x + y, 0) ##, and more text
The presence or absence of a space between ## and ,
is now significant (before it was not).
Also, formulas are bracketed by <code> in markdown
generation, so that variables stand out better.
See:
https://skia.org/user/api/SkBlendMode_Reference?cl=152781#Dst_Out
for an example.
Also fixed 100 column offenders and added a code
check to identify them. For the moment, 100 column
offenders are outed with SkDebugf but their presence
does not cause bookmaker to fail.
TBR=caryclark@google.com
Docs-Preview: https://skia.org/?cl=152781
Bug: skia:6898
Change-Id: If92a65a234f5d616bf4485984a8d219a6f04821a
Reviewed-on: https://skia-review.googlesource.com/152781
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/SkRect_Reference.bmh b/docs/SkRect_Reference.bmh
index e06b943..dce2588 100644
--- a/docs/SkRect_Reference.bmh
+++ b/docs/SkRect_Reference.bmh
@@ -229,12 +229,8 @@
#In Constructor
#Line # constructs from SkScalar input returning (x, y, width, height) ##
-Returns constructed Rect set to
-#Formula
-(x, y, x + w, y + h)
-##
-. Does not validate input;
-w or h may be negative.
+Returns constructed Rect set to #Formula # (x, y, x + w, y + h) ##.
+Does not validate input; w or h may be negative.
#Param x stored in fLeft ##
#Param y stored in fTop ##
@@ -1119,12 +1115,8 @@
#In Set
#Line # sets to SkScalar input (x, y, width, height) ##
-Sets Rect to
-#Formula
-(x, y, x + width, y + height)
-##
-. Does not validate input;
-width or height may be negative.
+Sets Rect to #Formula # (x, y, x + width, y + height) ##.
+Does not validate input; width or height may be negative.
#Param x stored in fLeft ##
#Param y stored in fTop ##
@@ -1507,12 +1499,8 @@
Rects 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 Rect pair can be described by:
-
-#Formula
-(max(a.fLeft, b.fLeft), max(a.fTop, b.fTop),
- min(a.fRight, b.fRight), min(a.fBottom, b.fBottom))
-##
-.
+#Formula # (max(a.fLeft, b.fLeft), max(a.fTop, b.fTop),
+ min(a.fRight, b.fRight), min(a.fBottom, b.fBottom)) ##.
The intersection is only meaningful if the resulting Rect is not empty and
describes an area: fLeft is less than fRight, and fTop is less than fBottom.
@@ -1949,12 +1937,8 @@
#In Rounding
#Line # sets members to nearest integer value ##
Sets IRect by adding 0.5 and discarding the fractional portion of Rect
-members, using
-#Formula
-(SkScalarRoundToInt(fLeft), SkScalarRoundToInt(fTop),
- SkScalarRoundToInt(fRight), SkScalarRoundToInt(fBottom))
-##
-.
+members, using #Formula # (SkScalarRoundToInt(fLeft), SkScalarRoundToInt(fTop),
+ SkScalarRoundToInt(fRight), SkScalarRoundToInt(fBottom)) ##.
#Param dst storage for IRect ##
@@ -1978,13 +1962,10 @@
#In Rounding
#Line # sets members to nearest integer value away from opposite ##
-Sets IRect by discarding the fractional portion of fLeft and fTop; and
-rounding up fRight and fBottom, using
-#Formula
-(SkScalarFloorToInt(fLeft), SkScalarFloorToInt(fTop),
- SkScalarCeilToInt(fRight), SkScalarCeilToInt(fBottom))
-##
-.
+Sets IRect by discarding the fractional portion of fLeft and fTop; and rounding
+up fRight and fBottom, using
+#Formula # (SkScalarFloorToInt(fLeft), SkScalarFloorToInt(fTop),
+ SkScalarCeilToInt(fRight), SkScalarCeilToInt(fBottom)) ##.
#Param dst storage for IRect ##
@@ -2007,13 +1988,10 @@
#Method void roundOut(SkRect* dst) const
#In Rounding
-Sets Rect by discarding the fractional portion of fLeft and fTop; and
-rounding up fRight and fBottom, using
-#Formula
-(SkScalarFloorToInt(fLeft), SkScalarFloorToInt(fTop),
- SkScalarCeilToInt(fRight), SkScalarCeilToInt(fBottom))
-##
-.
+Sets Rect by discarding the fractional portion of fLeft and fTop; and rounding
+up fRight and fBottom, using
+#Formula # (SkScalarFloorToInt(fLeft), SkScalarFloorToInt(fTop),
+ SkScalarCeilToInt(fRight), SkScalarCeilToInt(fBottom)) ##.
#Param dst storage for Rect ##
@@ -2037,14 +2015,10 @@
#In Rounding
#Line # sets members to nearest integer value towards opposite ##
-Sets Rect by rounding up fLeft and fTop; and
-discarding the fractional portion of fRight and fBottom, using
-
-#Formula
-(SkScalarCeilToInt(fLeft), SkScalarCeilToInt(fTop),
- SkScalarFloorToInt(fRight), SkScalarFloorToInt(fBottom))
-##
-.
+Sets Rect by rounding up fLeft and fTop; and discarding the fractional portion
+of fRight and fBottom, using
+#Formula # (SkScalarCeilToInt(fLeft), SkScalarCeilToInt(fTop),
+ SkScalarFloorToInt(fRight), SkScalarFloorToInt(fBottom)) ##.
#Param dst storage for IRect ##
@@ -2068,12 +2042,8 @@
#In Rounding
Returns IRect by adding 0.5 and discarding the fractional portion of Rect
-members, using
-#Formula
-(SkScalarRoundToInt(fLeft), SkScalarRoundToInt(fTop),
- SkScalarRoundToInt(fRight), SkScalarRoundToInt(fBottom))
-##
-.
+members, using #Formula # (SkScalarRoundToInt(fLeft), SkScalarRoundToInt(fTop),
+ SkScalarRoundToInt(fRight), SkScalarRoundToInt(fBottom)) ##.
#Return rounded IRect ##
@@ -2095,13 +2065,10 @@
#Method SkIRect roundOut() const
#In Rounding
-Sets IRect by discarding the fractional portion of fLeft and fTop; and
-rounding up fRight and fBottom, using
-#Formula
-(SkScalarFloorToInt(fLeft), SkScalarFloorToInt(fTop),
- SkScalarCeilToInt(fRight), SkScalarCeilToInt(fBottom))
-##
-.
+Sets IRect by discarding the fractional portion of fLeft and fTop; and rounding
+up fRight and fBottom, using
+#Formula # (SkScalarFloorToInt(fLeft), SkScalarFloorToInt(fTop),
+ SkScalarCeilToInt(fRight), SkScalarCeilToInt(fBottom)) ##.
#Return rounded IRect ##