diff options
| author |  Cary Clark <caryclark@skia.org> | 2018-02-20 12:50:35 -0500 |
|---|---|---|
| committer |  Skia Commit-Bot <skia-commit-bot@chromium.org> | 2018-02-20 18:10:33 +0000 |
| commit | 300cc5b5c1e11ecaaeb3e6937605da09fb3555e5 (patch) | |
| tree | 281b8e942e086a871c19c7e3ec54de681e61c868 /docs/SkIRect_Reference.bmh | |
| parent | 24889c90d2c53adba9b51ed354b846d42737529c (diff) | |
fix IRect doc
Florin pointed out docs that used SkPoint where
SkIPoint was intended. This was caused by the
original documentation guessing that 'points'
referred to one and not the other.
For now, use IPoint explicitly in the documentation
to get around this.
Docs-Preview: https://skia.org/?cl=108569
Bug: skia:6898
Change-Id: I12bac1d4cf82a614bee98895f12e4f99add2dbd7
Reviewed-on: https://skia-review.googlesource.com/108569
Reviewed-by: Florin Malita <fmalita@chromium.org>
Commit-Queue: Cary Clark <caryclark@skia.org>
Diffstat (limited to 'docs/SkIRect_Reference.bmh')
| -rw-r--r-- | docs/SkIRect_Reference.bmh | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/SkIRect_Reference.bmh b/docs/SkIRect_Reference.bmh index bdaa4a69d4..0d7924ce07 100644 --- a/docs/SkIRect_Reference.bmh +++ b/docs/SkIRect_Reference.bmh @@ -1182,7 +1182,7 @@ rect (7, 11, 13, 17) test(12, 16, 14, 18) quickReject false; intersects true #Method bool contains(int32_t x, int32_t y) const #In Intersection -#Line # returns true if points are equal or inside ## +#Line # returns true if IPoint (x, y) is equal or inside ## Returns true if: #Formula fLeft <= x < fRight && fTop <= y < fBottom @@ -1197,8 +1197,8 @@ Considers input to describe constructed IRect: and returns true if constructed area is completely enclosed by IRect area. -#Param x test Point x-coordinate ## -#Param y test Point y-coordinate ## +#Param x test IPoint x-coordinate ## +#Param y test IPoint y-coordinate ## #Return true if (x, y) is inside IRect ## @@ -1334,7 +1334,7 @@ rect: (30, 50, 40, 60) does not contain (29, 59, 30, 60) #Method bool containsNoEmptyCheck(int32_t left, int32_t top, int32_t right, int32_t bottom) const #In Intersection -#Line # returns true if points are equal or inside skips empty check ## +#Line # returns true if contains unsorted IRect ## Constructs IRect from (left, top, right, bottom). Does not sort construction. |