From ab5c9af442382fd05215a09f1814686710108880 Mon Sep 17 00:00:00 2001 From: Cary Clark Date: Thu, 12 Jul 2018 16:24:53 -0400 Subject: fix include generation Over zealous requirement to have periods at end of every sentence relaxed. Removed ancient comments from SkRRect.h. Add support for understanding " = default". TBR=caryclark@google.com Docs-Preview: https://skia.org/?cl=141120 Bug: skia:6818 Change-Id: I184533539803238ed386863f9029cb68a27e1d6a Reviewed-on: https://skia-review.googlesource.com/141120 Commit-Queue: Cary Clark Reviewed-by: Cary Clark --- docs/SkBitmap_Reference.bmh | 6 ------ docs/SkCanvas_Reference.bmh | 5 ----- docs/SkMatrix_Reference.bmh | 47 -------------------------------------------- docs/SkRRect_Reference.bmh | 18 ----------------- docs/SkSurface_Reference.bmh | 3 --- docs/status.json | 12 +++++------ 6 files changed, 6 insertions(+), 85 deletions(-) (limited to 'docs') diff --git a/docs/SkBitmap_Reference.bmh b/docs/SkBitmap_Reference.bmh index d57f0b85b8..1fd2b520de 100644 --- a/docs/SkBitmap_Reference.bmh +++ b/docs/SkBitmap_Reference.bmh @@ -1404,7 +1404,6 @@ Calls reset() and returns false if: # imageInfo.height() is negative ## # rowBytes is positive and less than imageInfo.width() times imageInfo.bytesPerPixel ## ## -. #Param imageInfo contains width, height, Alpha_Type, Color_Type, Color_Space ## #Param rowBytes imageInfo.minRowBytes or larger; or zero ## @@ -2573,7 +2572,6 @@ Input is not validated. Triggers an assert() if built with SK_DEBUG defined and: # x is negative, or not less than width() ## # y is negative, or not less than height() ## ## -. #Param x column index, zero or greater, and less than width() ## #Param y row index, zero or greater, and less than height() ## @@ -2609,7 +2607,6 @@ Input is not validated. Triggers an assert() if built with SK_DEBUG defined and: # x is negative, or not less than width() ## # y is negative, or not less than height() ## ## -. #Param x column index, zero or greater, and less than width() ## #Param y row index, zero or greater, and less than height() ## @@ -2651,7 +2648,6 @@ Input is not validated. Triggers an assert() if built with SK_DEBUG defined and: # x is negative, or not less than width() ## # y is negative, or not less than height() ## ## -. #Param x column index, zero or greater, and less than width() ## #Param y row index, zero or greater, and less than height() ## @@ -2697,7 +2693,6 @@ Return false if: # Pixel_Ref is nullptr ## # subset does not intersect bounds() ## ## -. #Param dst Bitmap set to subset ## #Param subset rectangle of pixels to reference ## @@ -2763,7 +2758,6 @@ row to the next. Returns true if pixels are copied. Returns false if: # dstRowBytes is less than dstInfo.minRowBytes ## # Pixel_Ref is nullptr ## ## -. Pixels are copied only if pixel conversion is possible. If Bitmap colorType is kGray_8_SkColorType, or kAlpha_8_SkColorType; dstInfo.colorType must match. diff --git a/docs/SkCanvas_Reference.bmh b/docs/SkCanvas_Reference.bmh index e91aee56da..32dee8193f 100644 --- a/docs/SkCanvas_Reference.bmh +++ b/docs/SkCanvas_Reference.bmh @@ -943,7 +943,6 @@ Does not copy, and returns false if: # Canvas pixels are not readable; for instance, Canvas is document-based. ## # dstRowBytes is too small to contain one row of pixels. ## ## -. #Param dstInfo width, height, Color_Type, and Alpha_Type of dstPixels ## #Param dstPixels storage for pixels; dstInfo.height() times dstRowBytes, or larger ## @@ -1037,7 +1036,6 @@ Does not copy, and returns false if: # Pixmap pixels could not be allocated. ## # pixmap.rowBytes() is too small to contain one row of pixels. ## ## -. #Param pixmap storage for pixels copied from Canvas ## #Param srcX offset into readable pixels on x-axis; may be negative ## @@ -1101,7 +1099,6 @@ Does not copy, and returns false if: # bitmap pixels could not be allocated. ## # bitmap.rowBytes() is too small to contain one row of pixels. ## ## -. #Param bitmap storage for pixels copied from Canvas ## #Param srcX offset into readable pixels on x-axis; may be negative ## @@ -1165,7 +1162,6 @@ Does not copy, and returns false if: # Canvas pixels are not writable; for instance, Canvas is document-based. ## # rowBytes is too small to contain one row of pixels. ## ## -. #Param info width, height, Color_Type, and Alpha_Type of pixels ## #Param pixels pixels to copy, of size info.height() times rowBytes, or larger ## @@ -1225,7 +1221,6 @@ Does not copy, and returns false if: # Canvas pixels are not writable; for instance, Canvas is document based. ## # bitmap pixels are inaccessible; for instance, bitmap wraps a texture. ## ## -. #Param bitmap contains pixels copied to Canvas ## #Param x offset into Canvas writable pixels in x; may be negative ## diff --git a/docs/SkMatrix_Reference.bmh b/docs/SkMatrix_Reference.bmh index 6f37e7856a..7a17e42eda 100644 --- a/docs/SkMatrix_Reference.bmh +++ b/docs/SkMatrix_Reference.bmh @@ -44,7 +44,6 @@ Sets Matrix to scale by (sx, sy). Returned matrix is: | 0 sy 0 | | 0 0 1 | ## -. #Param sx horizontal scale factor ## #Param sy vertical scale factor ## @@ -73,7 +72,6 @@ Sets Matrix to scale by (scale, scale). Returned matrix is: | 0 scale 0 | | 0 0 1 | ## -. #Param scale horizontal and vertical scale factor ## @@ -102,7 +100,6 @@ Sets Matrix to translate by (dx, dy). Returned matrix is: | 0 1 dy | | 0 0 1 | ## -. #Param dx horizontal translation ## #Param dy vertical translation ## @@ -139,7 +136,6 @@ Sets Matrix to: | skewY scaleY transY | | pers0 pers1 pers2 | ## -. #Param scaleX horizontal scale factor ## #Param skewX horizontal skew factor ## @@ -292,7 +288,6 @@ Returns true if Matrix is identity. Identity matrix is: | 0 1 0 | | 0 0 1 | ## -. #Return true if Matrix has no effect ## @@ -326,7 +321,6 @@ contain only scale elements, only translate elements, or both. Matrix form is: | 0 scale-y translate-y | | 0 0 1 | ## -. #Return true if Matrix is identity; or scales, translates, or both ## @@ -363,7 +357,6 @@ Returns true if Matrix is identity, or translates. Matrix form is: | 0 1 translate-y | | 0 0 1 | ## -. #Return true if Matrix is identity, or translates ## @@ -1315,7 +1308,6 @@ Sets all values from parameters. Sets matrix to: | skewY scaleY transY | | persp0 persp1 persp2 | ## -. #Param scaleX horizontal scale factor to store ## #Param skewX horizontal skew factor to store ## @@ -1394,7 +1386,6 @@ Sets matrix to: | buffer[3] buffer[4] buffer[5] | | buffer[6] buffer[7] buffer[8] | ## -. In the future, set9 followed by get9 may not return the same values. Since Matrix maps non-homogeneous coordinates, scaling all nine values produces an equivalent @@ -1429,7 +1420,6 @@ Sets Matrix to identity; which has no effect on mapped Points. Sets Matrix to: | 0 1 0 | | 0 0 1 | ## -. Also called setIdentity(); use the one that provides better inline documentation. @@ -1461,7 +1451,6 @@ Sets Matrix to identity; which has no effect on mapped Points. Sets Matrix to: | 0 1 0 | | 0 0 1 | ## -. Also called reset(); use the one that provides better inline documentation. @@ -1853,7 +1842,6 @@ sets Matrix to: a * b = | D E F | * | M N O | = | DJ+EM+FP DK+EN+FQ DL+EO+FR | | G H I | | P Q R | | GJ+HM+IP GK+HN+IQ GL+HO+IR | ## -. #Param a Matrix on left side of multiply expression ## #Param b Matrix on right side of multiply expression ## @@ -1904,7 +1892,6 @@ sets Matrix to: Matrix * T(dx, dy) = | D E F | | 0 1 dy | = | D E D*dx+E*dy+F | | G H I | | 0 0 1 | | G H G*dx+H*dy+I | ## -. #Param dx x-axis translation before applying Matrix ## #Param dy y-axis translation before applying Matrix ## @@ -1972,7 +1959,6 @@ sets Matrix to: Matrix * S(sx, sy, px, py) = | D E F | | 0 sy dy | = | D*sx E*sy D*dx+E*dy+F | | G H I | | 0 0 1 | | G*sx H*sy G*dx+H*dy+I | ## -. #Param sx horizontal scale factor ## #Param sy vertical scale factor ## @@ -2020,7 +2006,6 @@ sets Matrix to: Matrix * S(sx, sy) = | D E F | | 0 sy 0 | = | D*sx E*sy F | | G H I | | 0 0 1 | | G*sx H*sy I | ## -. #Param sx horizontal scale factor ## #Param sy vertical scale factor ## @@ -2079,7 +2064,6 @@ sets Matrix to: Matrix * R(degrees, px, py) = | D E F | | s c dy | = | Dc+Es -Ds+Ec D*dx+E*dy+F | | G H I | | 0 0 1 | | Gc+Hs -Gs+Hc G*dx+H*dy+I | ## -. #Param degrees angle of axes relative to upright axes ## #Param px pivot x ## @@ -2135,7 +2119,6 @@ sets Matrix to: Matrix * R(degrees, px, py) = | D E F | | s c 0 | = | Dc+Es -Ds+Ec F | | G H I | | 0 0 1 | | Gc+Hs -Gs+Hc I | ## -. #Param degrees angle of axes relative to upright axes ## @@ -2189,7 +2172,6 @@ sets Matrix to: Matrix * K(kx, ky, px, py) = | D E F | | ky 1 dy | = | D+E*ky D*kx+E D*dx+E*dy+F | | G H I | | 0 0 1 | | G+H*ky G*kx+H G*dx+H*dy+I | ## -. #Param kx horizontal skew factor ## #Param ky vertical skew factor ## @@ -2236,7 +2218,6 @@ sets Matrix to: Matrix * K(kx, ky) = | D E F | | ky 1 0 | = | D+E*ky D*kx+E F | | G H I | | 0 0 1 | | G+H*ky G*kx+H I | ## -. #Param kx horizontal skew factor ## #Param ky vertical skew factor ## @@ -2282,7 +2263,6 @@ sets Matrix to: Matrix * other = | D E F | * | M N O | = | DJ+EM+FP DK+EN+FQ DL+EO+FR | | G H I | | P Q R | | GJ+HM+IP GK+HN+IQ GL+HO+IR | ## -. #Param other Matrix on right side of multiply expression ## @@ -2332,7 +2312,6 @@ sets Matrix to: T(dx, dy) * Matrix = | 0 1 dy | | M N O | = | M+dy*P N+dy*Q O+dy*R | | 0 0 1 | | P Q R | | P Q R | ## -. #Param dx x-axis translation after applying Matrix ## #Param dy y-axis translation after applying Matrix ## @@ -2403,7 +2382,6 @@ sets Matrix to: S(sx, sy, px, py) * Matrix = | 0 sy dy | | M N O | = | sy*M+dy*P sy*N+dy*Q sy*O+dy*R | | 0 0 1 | | P Q R | | P Q R | ## -. #Param sx horizontal scale factor ## #Param sy vertical scale factor ## @@ -2450,7 +2428,6 @@ sets Matrix to: S(sx, sy) * Matrix = | 0 sy 0 | | M N O | = | sy*M sy*N sy*O | | 0 0 1 | | P Q R | | P Q R | ## -. #Param sx horizontal scale factor ## #Param sy vertical scale factor ## @@ -2509,7 +2486,6 @@ sets Matrix to: I(divx, divy) * Matrix = | 0 sy 0 | | M N O | = | sy*M sy*N sy*O | | 0 0 1 | | P Q R | | P Q R | ## -. #Param divx integer divisor for inverse scale in x ## #Param divy integer divisor for inverse scale in y ## @@ -2570,7 +2546,6 @@ sets Matrix to: R(degrees, px, py) * Matrix = |s c dy| |M N O| = |sJ+cM+dy*P sK+cN+dy*Q sL+cO+dy*R| |0 0 1| |P Q R| | P Q R| ## -. #Param degrees angle of axes relative to upright axes ## #Param px pivot x ## @@ -2626,7 +2601,6 @@ sets Matrix to: R(degrees, px, py) * Matrix = | s c dy | | M N O | = | sJ+cM sK+cN sL+cO | | 0 0 1 | | P Q R | | P Q R | ## -. #Param degrees angle of axes relative to upright axes ## @@ -2680,7 +2654,6 @@ sets Matrix to: K(kx, ky, px, py) * Matrix = |ky 1 dy| |M N O| = |ky*J+M+dy*P ky*K+N+dy*Q ky*L+O+dy*R| | 0 0 1| |P Q R| | P Q R| ## -. #Param kx horizontal skew factor ## #Param ky vertical skew factor ## @@ -2727,7 +2700,6 @@ sets Matrix to: K(kx, ky) * Matrix = | ky 1 0 | | M N O | = | ky*J+M ky*K+N ky*L+O | | 0 0 1 | | P Q R | | P Q R | ## -. #Param kx horizontal skew factor ## #Param ky vertical skew factor ## @@ -2773,7 +2745,6 @@ sets Matrix to: other * Matrix = | D E F | * | M N O | = | DJ+EM+FP DK+EN+FQ DL+EO+FR | | G H I | | P Q R | | GJ+HM+IP GK+HN+IQ GL+HO+IR | ## -. #Param other Matrix on left side of multiply expression ## @@ -2880,7 +2851,6 @@ Returns true if dst is empty, and sets Matrix to: | 0 0 0 | | 0 0 1 | ## -. #Param src Rect to map from ## #Param dst Rect to map to ## @@ -2936,7 +2906,6 @@ empty, returns Matrix set to: | 0 0 0 | | 0 0 1 | ## -. #Param src Rect to map from ## #Param dst Rect to map to ## @@ -3076,7 +3045,6 @@ Sets affine to: | 1 0 0 | | 0 1 0 | ## -. Affine 3x2 matrices in column major order are used by OpenGL and XPS. @@ -3111,7 +3079,6 @@ Fills affine in column major order. Sets affine to: | scale-x skew-x translate-x | | skew-y scale-y translate-y | ## -. If Matrix contains perspective, returns false and leaves affine unchanged. @@ -3162,7 +3129,6 @@ Matrix is set, row, then column, to: | skew-y scale-y translate-y | | 0 0 1 | ## -. #Param affine 3x2 affine matrix ## @@ -3227,7 +3193,6 @@ each dst Point is computed as: Matrix * pt = |D E F| |y| = |Ax+By+C Dx+Ey+F Gx+Hy+I| = ------- , ------- |G H I| |1| Gx+Hy+I Gx+Hy+I ## -. src and dst may point to the same storage. @@ -3287,7 +3252,6 @@ each resulting pts Point is computed as: Matrix * pt = |D E F| |y| = |Ax+By+C Dx+Ey+F Gx+Hy+I| = ------- , ------- |G H I| |1| Gx+Hy+I Gx+Hy+I ## -. #Param pts storage for mapped Points ## #Param count number of Points to transform ## @@ -3333,7 +3297,6 @@ each resulting dst Point is computed as: Matrix * src = |D E F| |y| = |Ax+By+Cz Dx+Ey+Fz Gx+Hy+Iz| |G H I| |z| ## -. #Param dst storage for mapped Point3 array ## #Param src Point3 array to transform ## @@ -3391,7 +3354,6 @@ result is computed as: Matrix * pt = |D E F| |y| = |Ax+By+C Dx+Ey+F Gx+Hy+I| = ------- , ------- |G H I| |1| Gx+Hy+I Gx+Hy+I ## -. #Param x x-axis value of Point to map ## #Param y y-axis value of Point to map ## @@ -3437,7 +3399,6 @@ result is computed as: Matrix * pt = |D E F| |y| = |Ax+By+C Dx+Ey+F Gx+Hy+I| = ------- , ------- |G H I| |1| Gx+Hy+I Gx+Hy+I ## -. #Param x x-axis value of Point to map ## #Param y y-axis value of Point to map ## @@ -3561,7 +3522,6 @@ each result Vector is computed as: Matrix * vec = |D E 0| |y| = |Ax+By Dx+Ey Gx+Hy+I| = ------- , ------- |G H I| |1| Gx+Hy+I Gx+Hy+I ## -. #Param vecs Vectors to transform, and storage for mapped Vectors ## #Param count number of Vectors to transform ## @@ -3610,7 +3570,6 @@ each result Vector is computed as: Matrix * vec = |D E 0| |dy| = |A*dx+B*dy D*dx+E*dy G*dx+H*dy+I| = ----------- , ----------- |G H I| | 1| G*dx+H*dy+I G*dx+*dHy+I ## -. #Param dx x-axis value of Vector to map ## #Param dy y-axis value of Vector to map ## @@ -3660,7 +3619,6 @@ each result Vector is computed as: Matrix * vec = |D E 0| |dy| = |A*dx+B*dy D*dx+E*dy G*dx+H*dy+I| = ----------- , ----------- |G H I| | 1| G*dx+H*dy+I G*dx+*dHy+I ## -. #Param dx x-axis value of Vector to map ## #Param dy y-axis value of Vector to map ## @@ -3810,7 +3768,6 @@ each dst Point is computed as: Matrix * pt = |D E F| |y| = |Ax+By+C Dx+Ey+F Gx+Hy+I| = ------- , ------- |G H I| |1| Gx+Hy+I Gx+Hy+I ## -. #Param dst storage for mapped corner Points ## #Param rect Rect to map ## @@ -4302,7 +4259,6 @@ Returns reference to const identity Matrix. Returned Matrix is set to: | 0 1 0 | | 0 0 1 | ## -. #Return const identity Matrix ## @@ -4337,7 +4293,6 @@ to: | SK_ScalarMax SK_ScalarMax SK_ScalarMax | | SK_ScalarMax SK_ScalarMax SK_ScalarMax | ## -. #Return const invalid Matrix ## @@ -4376,7 +4331,6 @@ sets Matrix to: a * b = | D E F | * | M N O | = | DJ+EM+FP DK+EN+FQ DL+EO+FR | | G H I | | P Q R | | GJ+HM+IP GK+HN+IQ GL+HO+IR | ## -. #Param a Matrix on left side of multiply expression ## #Param b Matrix on right side of multiply expression ## @@ -4449,7 +4403,6 @@ Initializes Matrix with scale and translate elements. | 0 sy ty | | 0 0 1 | ## -. #Param sx horizontal scale factor to store ## #Param sy vertical scale factor to store ## diff --git a/docs/SkRRect_Reference.bmh b/docs/SkRRect_Reference.bmh index 638e356a6b..4b1a403e14 100644 --- a/docs/SkRRect_Reference.bmh +++ b/docs/SkRRect_Reference.bmh @@ -4,24 +4,6 @@ #Class SkRRect -#Private -Path forward: - core work - add contains(SkRect&) - for clip stack - add contains(SkRRect&) - for clip stack - add heart rect computation (max rect inside RR) - add 9patch rect computation - add growToInclude(SkPath&) - analysis - use growToInclude to fit skp round rects & generate stats (RRs vs. real paths) - check on # of rectorus's the RRs could handle - rendering work - update SkPath.addRRect() to only use quads - add GM and bench - further out - detect and triangulate RRectorii rather than falling back to SW in Ganesh -## - SkRRect describes a rounded rectangle with a bounds and a pair of radii for each corner. The bounds and radii can be set so that SkRRect describes a rectangle with sharp corners, a Circle, an Oval, or a rectangle with one or more rounded corners. diff --git a/docs/SkSurface_Reference.bmh b/docs/SkSurface_Reference.bmh index a84a6dd1c2..1fc212264f 100644 --- a/docs/SkSurface_Reference.bmh +++ b/docs/SkSurface_Reference.bmh @@ -1250,7 +1250,6 @@ Does not copy, and returns false if: # Pixmap pixels could not be allocated. ## # dst.rowBytes() is too small to contain one row of pixels. ## ## -. #Param dst storage for pixels copied from Surface ## #Param srcX offset into readable pixels on x-axis; may be negative ## @@ -1310,7 +1309,6 @@ Does not copy, and returns false if: # Surface pixels could not be converted to dstInfo.colorType() or dstInfo.alphaType(). ## # dstRowBytes is too small to contain one row of pixels. ## ## -. #Param dstInfo width, height, Color_Type, and Alpha_Type of dstPixels ## #Param dstPixels storage for pixels; dstInfo.height() times dstRowBytes, or larger ## @@ -1377,7 +1375,6 @@ Does not copy, and returns false if: # dst pixels could not be allocated. ## # dst.rowBytes() is too small to contain one row of pixels. ## ## -. #Param dst storage for pixels copied from Surface ## #Param srcX offset into readable pixels on x-axis; may be negative ## diff --git a/docs/status.json b/docs/status.json index 2cdd6a5b05..6814f9cf88 100644 --- a/docs/status.json +++ b/docs/status.json @@ -3,6 +3,7 @@ "include": { "core": [ "SkBitmap.h", + "SkBlendMode.h", "SkCanvas.h", "SkColor.h", "SkImage.h", @@ -10,14 +11,17 @@ "SkMatrix.h", "SkPaint.h", "SkPath.h", + "SkPicture.h", "SkPixmap.h", "SkPoint.h", + "SkRRect.h", "SkRect.h", "SkSurface.h" ] }, "docs": [ "SkAutoCanvasRestore_Reference.bmh", + "SkBlendMode_Reference.bmh", "SkCanvas_Reference.bmh", "SkColor_Reference.bmh", "SkColor4f_Reference.bmh", @@ -27,6 +31,8 @@ "SkImage_Reference.bmh", "SkImageInfo_Reference.bmh", "SkPath_Reference.bmh", + "SkPicture_Reference.bmh", + "SkRRect_Reference.bmh", "SkRect_Reference.bmh", "SkBitmap_Reference.bmh", "SkIPoint_Reference.bmh", @@ -40,15 +46,9 @@ "InProgress": { "include": { "core": [ - "SkBlendMode.h", - "SkPicture.h", - "SkRRect.h" ] }, "docs": [ - "SkBlendMode_Reference.bmh", - "SkPicture_Reference.bmh", - "SkRRect_Reference.bmh", "overview.bmh", "usingBookmaker.bmh" ] -- cgit v1.2.3