diff options
| author |  Cary Clark <caryclark@skia.org> | 2018-01-22 07:55:48 -0500 |
|---|---|---|
| committer |  Skia Commit-Bot <skia-commit-bot@chromium.org> | 2018-01-22 14:04:18 +0000 |
| commit | 5081eede67601e5c5c0fc343b787490603e058cc (patch) | |
| tree | 607f095f636eca498e62e14e3c6d760f477052d4 /docs/SkPoint_Reference.bmh | |
| parent | 8a67c4c2aa4debca84a68fbc25f048ce55118916 (diff) | |
self check and corrections
Add self-checking code that looks to see that overview is populated
and alphabetized. Eventually, this will self-check to see if
methods are collected into subtopics and have reciprocal 'see also'
data.
Standardize phrases so that they don't start with a capital or end
with a period.
Self-check is a work in progress, so it is not yet run by the
bookmaker bots. The self-check should run cleanly, however. To run
it:
./out/skia/bookmaker -b docs -k
The expected output is doc stats. Self-check errors such as missing
methods in the overview would be reported here if there are any.
TBR=caryclark@google.com
Docs-Preview: https://skia.org/?cl=93621
Bug: skia:6898
Change-Id: I8f1f817a7b083b13138ee33d1aa090445e9304c6
Reviewed-on: https://skia-review.googlesource.com/93621
Reviewed-by: Cary Clark <caryclark@skia.org>
Commit-Queue: Cary Clark <caryclark@skia.org>
Diffstat (limited to 'docs/SkPoint_Reference.bmh')
| -rw-r--r-- | docs/SkPoint_Reference.bmh | 15 |
1 files changed, 12 insertions, 3 deletions
diff --git a/docs/SkPoint_Reference.bmh b/docs/SkPoint_Reference.bmh index 6eeb1a5703..72c73e49a4 100644 --- a/docs/SkPoint_Reference.bmh +++ b/docs/SkPoint_Reference.bmh @@ -15,15 +15,24 @@ #Table ## ## +#Subtopic Constructors +#Table +#Legend +# name # description ## +#Legend ## +# Make # Constructs from SkScalar inputs. ## +#Table ## +#Subtopic ## + #Subtopic Operators #Table #Legend -# description # function ## +# name # description ## #Legend ## # SkPoint operator*(SkScalar scale)_const # Returns Point multiplied by scale. ## +# SkPoint operator+(const SkPoint& a, const SkVector& b) # Returns Point offset by Vector. ## # SkPoint operator-()_const # Reverses sign of Point. ## # SkPoint& operator*=(SkScalar scale) # Multiplies Point by scale factor. ## -# SkPoint operator+(const SkPoint& a, const SkVector& b) # Returns Point offset by Vector. ## # SkVector operator-(const SkPoint& a, const SkPoint& b) # Returns Vector between Points. ## # bool operator!=(const SkPoint& a, const SkPoint& b) # Returns true if Point are unequal. ## # bool operator==(const SkPoint& a, const SkPoint& b) # Returns true if Point are equal. ## @@ -35,7 +44,7 @@ #Subtopic Member_Functions #Table #Legend -# description # function ## +# name # description ## #Legend ## # CrossProduct # Returns cross product. ## # Distance # Returns straight-line distance between points. ## |