update generated includes

This fixes all comments in generated includes
to fit in 100 columns.

TBR=reed@google.com

Bug: skia:6898
Change-Id: I6d28a24d4e2d079e4a9284d4b2a25326dc5f2dc6
Reviewed-on: https://skia-review.googlesource.com/154440
Commit-Queue: Cary Clark <caryclark@skia.org>
Auto-Submit: Cary Clark <caryclark@skia.org>
Reviewed-by: Cary Clark <caryclark@skia.org>
This commit is contained in:
Cary Clark 2018-09-13 14:08:12 -04:00 committed by Skia Commit-Bot
parent 30cac1ecff
commit 9bb34b74f3
6 changed files with 55 additions and 43 deletions

View File

@ -6,7 +6,7 @@
*/
/* Generated by tools/bookmaker from include/core/SkBitmap.h and docs/SkBitmap_Reference.bmh
on 2018-07-13 08:15:10. Additional documentation and examples can be found at:
on 2018-09-13 13:59:55. Additional documentation and examples can be found at:
https://skia.org/user/api/SkBitmap_Reference
You may edit either file directly. Structural changes to public interfaces require
@ -122,7 +122,7 @@ public:
*/
const SkImageInfo& info() const { return fPixmap.info(); }
/** Returns pixel count in each row. Should be equal or less than:
/** Returns pixel count in each row. Should be equal or less than
rowBytes() / info().bytesPerPixel().
May be less than pixelRef().width(). Will not exceed pixelRef().width() less
@ -226,7 +226,7 @@ public:
}
/** Returns row bytes, the interval from one pixel row to the next. Row bytes
is at least as large as width() * info().bytesPerPixel().
is at least as large as: width() * info().bytesPerPixel().
Returns zero if colorType() is kUnknown_SkColorType, or if row bytes supplied to
setInfo() is not large enough to hold a row of pixels.

View File

@ -6,7 +6,7 @@
*/
/* Generated by tools/bookmaker from include/core/SkMatrix.h and docs/SkMatrix_Reference.bmh
on 2018-07-13 08:15:11. Additional documentation and examples can be found at:
on 2018-09-13 13:59:55. Additional documentation and examples can be found at:
https://skia.org/user/api/SkMatrix_Reference
You may edit either file directly. Structural changes to public interfaces require
@ -920,7 +920,8 @@ public:
*/
void postScale(SkScalar sx, SkScalar sy);
/** Sets SkMatrix to SkMatrix constructed from scaling by (1/divx, 1/divy) about pivot point (px, py), multiplied by SkMatrix.
/** Sets SkMatrix to SkMatrix constructed from scaling by (1/divx, 1/divy),
about pivot point (px, py), multiplied by SkMatrix.
Returns false if either divx or divy is zero.
@ -1608,8 +1609,7 @@ public:
unchanged if SkMatrix contains perspective; scale factors are not finite, or
are nearly zero.
On success
Matrix = scale * Remaining.
On success: Matrix = scale * Remaining.
@param scale axes scaling factors; may be nullptr
@param remaining SkMatrix without scaling; may be nullptr

View File

@ -6,7 +6,7 @@
*/
/* Generated by tools/bookmaker from include/core/SkPath.h and docs/SkPath_Reference.bmh
on 2018-08-15 15:11:20. Additional documentation and examples can be found at:
on 2018-09-13 13:59:55. Additional documentation and examples can be found at:
https://skia.org/user/api/SkPath_Reference
You may edit either file directly. Structural changes to public interfaces require
@ -140,7 +140,8 @@ public:
/** Interpolates between SkPath with SkPoint array of equal size.
Copy verb array and weights to out, and set out SkPoint array to a weighted
average of this SkPoint array and ending SkPoint array, using the formula: (Path Point * weight) + ending Point * (1 - weight).
average of this SkPoint array and ending SkPoint array, using the formula:
(Path Point * weight) + ending Point * (1 - weight).
weight is most useful when between zero (ending SkPoint array) and
one (this Point_Array); will work with values outside of this
@ -549,7 +550,8 @@ public:
*/
void incReserve(unsigned extraPtCount);
/** Shrinks the verb and point array allocation to discard unused capacity.
/** Shrinks SkPath verb array and SkPoint array storage to discard unused capacity.
May reduce the heap overhead for SkPath known to be fully constructed.
*/
void shrinkToFit();
@ -897,14 +899,16 @@ public:
SkPath& arcTo(SkScalar rx, SkScalar ry, SkScalar xAxisRotate, ArcSize largeArc,
Direction sweep, SkScalar x, SkScalar y);
/** Appends arc to SkPath. Arc is implemented by one or more conic weighted to describe part of oval
with radii (r.fX, r.fY) rotated by xAxisRotate degrees. Arc curves from last SkPath SkPoint to
(xy.fX, xy.fY), choosing one of four possible routes: clockwise or counterclockwise,
/** Appends arc to SkPath. Arc is implemented by one or more conic weighted to describe
part of oval with radii (r.fX, r.fY) rotated by xAxisRotate degrees. Arc curves
from last SkPath SkPoint to (xy.fX, xy.fY), choosing one of four possible routes:
clockwise or counterclockwise,
and smaller or larger.
Arc sweep is always less than 360 degrees. arcTo() appends line to xy if either radii are zero,
or if last SkPath SkPoint equals (x, y). arcTo() scales radii r to fit last SkPath SkPoint and
xy if both are greater than zero but too small to describe an arc.
Arc sweep is always less than 360 degrees. arcTo() appends line to xy if either
radii are zero, or if last SkPath SkPoint equals (x, y). arcTo() scales radii r to fit
last SkPath SkPoint and xy if both are greater than zero but too small to describe
an arc.
arcTo() appends up to four conic curves.
arcTo() implements the functionality of svg arc, although SVG "sweep-flag" value is
@ -999,7 +1003,8 @@ public:
Quad array is stored in pts; this storage is supplied by caller.
Maximum quad count is 2 to the pow2.
Every third point in array shares last SkPoint of previous quad and first SkPoint of
next quad. Maximum pts storage size is given by: (1 + 2 * (1 << pow2)) * sizeof(SkPoint).
next quad. Maximum pts storage size is given by:
(1 + 2 * (1 << pow2)) * sizeof(SkPoint).
Returns quad count used the approximation, which may be smaller
than the number requested.

View File

@ -6,7 +6,7 @@
*/
/* Generated by tools/bookmaker from include/core/SkPoint.h and docs/SkPoint_Reference.bmh
on 2018-07-13 08:15:11. Additional documentation and examples can be found at:
on 2018-09-13 13:59:55. Additional documentation and examples can be found at:
https://skia.org/user/api/SkPoint_Reference
You may edit either file directly. Structural changes to public interfaces require
@ -142,7 +142,8 @@ struct SkIPoint {
return { Sk32_sat_sub(a.fX, b.fX), Sk32_sat_sub(a.fY, b.fY) };
}
/** Returns SkIPoint resulting from SkIPoint a offset by ivector b, computed as: (a.fX + b.fX, a.fY + b.fY).
/** Returns SkIPoint resulting from SkIPoint a offset by ivector b, computed as:
(a.fX + b.fX, a.fY + b.fY).
Can also be used to offset SkIPoint b by ivector a, returning SkIPoint.
Can also be used to add ivector to ivector, returning ivector.
@ -461,7 +462,8 @@ struct SK_API SkPoint {
return {a.fX - b.fX, a.fY - b.fY};
}
/** Returns SkPoint resulting from SkPoint a offset by vector b, computed as: (a.fX + b.fX, a.fY + b.fY).
/** Returns SkPoint resulting from SkPoint a offset by vector b, computed as:
(a.fX + b.fX, a.fY + b.fY).
Can also be used to offset SkPoint b by vector a, returning SkPoint.
Can also be used to add vector to vector, returning vector.

View File

@ -6,7 +6,7 @@
*/
/* Generated by tools/bookmaker from include/core/SkRect.h and docs/SkRect_Reference.bmh
on 2018-07-13 08:15:11. Additional documentation and examples can be found at:
on 2018-09-13 13:59:55. Additional documentation and examples can be found at:
https://skia.org/user/api/SkRect_Reference
You may edit either file directly. Structural changes to public interfaces require
@ -94,8 +94,8 @@ struct SK_API SkIRect {
return SkIRect{l, t, r, b};
}
/** Returns constructed SkIRect set to: (x, y, x + w, y + h). Does not validate input;
w or h may be negative.
/** Returns constructed SkIRect set to: (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
@ -268,8 +268,8 @@ struct SK_API SkIRect {
this->set(left, top, right, bottom);
}
/** Sets SkIRect to: (x, y, x + width, y + height). Does not validate input;
width or height may be negative.
/** Sets SkIRect to: (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
@ -764,8 +764,8 @@ struct SK_API SkRect {
return SkRect {l, t, r, b};
}
/** Returns constructed SkRect set to (x, y, x + w, y + h). Does not validate input;
w or h may be negative.
/** Returns constructed SkRect set to (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
@ -1110,8 +1110,8 @@ struct SK_API SkRect {
fBottom = SkMaxScalar(p0.fY, p1.fY);
}
/** Sets SkRect to (x, y, x + width, y + height). Does not validate input;
width or height may be negative.
/** Sets SkRect to (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
@ -1456,8 +1456,9 @@ public:
SkScalarRoundToInt(fRight), SkScalarRoundToInt(fBottom));
}
/** Sets SkIRect by discarding the fractional portion of fLeft and fTop; and
rounding up fRight and fBottom, using (SkScalarFloorToInt(fLeft), SkScalarFloorToInt(fTop),
/** Sets SkIRect by discarding the fractional portion of fLeft and fTop; and rounding
up fRight and fBottom, using
(SkScalarFloorToInt(fLeft), SkScalarFloorToInt(fTop),
SkScalarCeilToInt(fRight), SkScalarCeilToInt(fBottom)).
@param dst storage for SkIRect
@ -1468,8 +1469,9 @@ public:
SkScalarCeilToInt(fRight), SkScalarCeilToInt(fBottom));
}
/** Sets SkRect by discarding the fractional portion of fLeft and fTop; and
rounding up fRight and fBottom, using (SkScalarFloorToInt(fLeft), SkScalarFloorToInt(fTop),
/** Sets SkRect by discarding the fractional portion of fLeft and fTop; and rounding
up fRight and fBottom, using
(SkScalarFloorToInt(fLeft), SkScalarFloorToInt(fTop),
SkScalarCeilToInt(fRight), SkScalarCeilToInt(fBottom)).
@param dst storage for SkRect
@ -1481,8 +1483,8 @@ public:
SkScalarCeilToScalar(fBottom));
}
/** Sets SkRect by rounding up fLeft and fTop; and
discarding the fractional portion of fRight and fBottom, using
/** Sets SkRect by rounding up fLeft and fTop; and discarding the fractional portion
of fRight and fBottom, using
(SkScalarCeilToInt(fLeft), SkScalarCeilToInt(fTop),
SkScalarFloorToInt(fRight), SkScalarFloorToInt(fBottom)).
@ -1506,8 +1508,9 @@ public:
return ir;
}
/** Sets SkIRect by discarding the fractional portion of fLeft and fTop; and
rounding up fRight and fBottom, using (SkScalarFloorToInt(fLeft), SkScalarFloorToInt(fTop),
/** Sets SkIRect by discarding the fractional portion of fLeft and fTop; and rounding
up fRight and fBottom, using
(SkScalarFloorToInt(fLeft), SkScalarFloorToInt(fTop),
SkScalarCeilToInt(fRight), SkScalarCeilToInt(fBottom)).
@return rounded SkIRect

View File

@ -6,7 +6,7 @@
*/
/* Generated by tools/bookmaker from include/core/SkSurface.h and docs/SkSurface_Reference.bmh
on 2018-07-13 08:15:11. Additional documentation and examples can be found at:
on 2018-09-13 13:59:55. Additional documentation and examples can be found at:
https://skia.org/user/api/SkSurface_Reference
You may edit either file directly. Structural changes to public interfaces require
@ -608,7 +608,8 @@ public:
/** Copies SkRect of pixels from the src SkPixmap to the SkSurface.
Source SkRect corners are (0, 0) and (src.width(), src.height()).
Destination SkRect corners are (dstX, dstY) and (dstX + Surface width(), dstY + Surface height()).
Destination SkRect corners are (dstX, dstY) and
(dstX + Surface width(), dstY + Surface height()).
Copies each readable pixel intersecting both rectangles, without scaling,
converting to SkSurface colorType() and SkSurface alphaType() if required.
@ -622,7 +623,8 @@ public:
/** Copies SkRect of pixels from the src SkBitmap to the SkSurface.
Source SkRect corners are (0, 0) and (src.width(), src.height()).
Destination SkRect corners are (dstX, dstY) and (dstX + Surface width(), dstY + Surface height()).
Destination SkRect corners are (dstX, dstY) and
(dstX + Surface width(), dstY + Surface height()).
Copies each readable pixel intersecting both rectangles, without scaling,
converting to SkSurface colorType() and SkSurface alphaType() if required.