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>

1 files changed, 31 insertions, 19 deletions

diff --git a/docs/SkIPoint_Reference.bmh b/docs/SkIPoint_Reference.bmh
index ed37167a12..3a431dee10 100644
--- a/docs/SkIPoint_Reference.bmh
+++ b/docs/SkIPoint_Reference.bmh
@@ -4,7 +4,7 @@
 
 #Struct SkIPoint
 
-SkIPoint holds two 32 bit integer coordinates
+SkIPoint holds two 32 bit integer coordinates.
 
 #Topic Overview
 
@@ -12,41 +12,53 @@ SkIPoint holds two 32 bit integer coordinates
 #ToDo manually add subtopics ##
 #Table
 #Legend
-# topics # description ##
+# name             # description                          ##
 #Legend ##
+# Constructors     # functions that construct SkIPoint16  ##
+# Member_Functions # static functions and member methods  ##
+# Operators        # operator overloading methods         ##
 #Table ##
-##
+#Subtopic ##
+
+#Subtopic Constructors
+#Table
+#Legend
+# name  # description                    ##
+#Legend ##
+# Make  # constructs from integer inputs ##
+#Table ##
+#Subtopic ##
 
 #Subtopic Operators
 #Table
 #Legend
-# description                                               # function                             ##
+# name                                                      # description                         ##
 #Legend ##
-# SkIPoint operator-()_const                                # Reverses sign of IPoint.             ##
-# SkIPoint operator+(const SkIPoint& a, const SkIVector& b) # Returns IPoint offset by IVector.    ##
-# SkIVector operator-(const SkIPoint& a, const SkIPoint& b) # Returns IVector between IPoints.     ##
-# bool operator!=(const SkIPoint& a, const SkIPoint& b)     # Returns true if IPoints are unequal. ##
-# bool operator==(const SkIPoint& a, const SkIPoint& b)     # Returns true if IPoints are equal.   ##
-# void operator+=(const SkIVector& v)                       # Adds IVector to IPoint.              ##
-# void operator-=(const SkIVector& v)                       # Subtracts IVector from IPoint.       ##
+# SkIPoint operator+(const SkIPoint& a, const SkIVector& b) # returns IPoint offset by IVector    ##
+# SkIPoint operator-()_const                                # reverses sign of IPoint             ##
+# SkIVector operator-(const SkIPoint& a, const SkIPoint& b) # returns IVector between IPoints     ##
+# bool operator!=(const SkIPoint& a, const SkIPoint& b)     # returns true if IPoints are unequal ##
+# bool operator==(const SkIPoint& a, const SkIPoint& b)     # returns true if IPoints are equal   ##
+# void operator+=(const SkIVector& v)                       # adds IVector to IPoint              ##
+# void operator-=(const SkIVector& v)                       # subtracts IVector from IPoint       ##
 #Table ##
 #Subtopic ##
 
 #Subtopic Member_Functions
 #Table
 #Legend
-# description  # function ##
+# name         # description                             ##
 #Legend ##
-# Make         # Constructs from integer inputs.          ##
-# equals()     # Returns true if members are equal.       ##
-# isZero       # Returns true if both members equal zero. ##
-# set()        # Sets to integer input.                   ##
-# x()          # Returns fX.                              ##
-# y()          # Returns fY.                              ##
+# Make         # constructs from integer inputs          ##
+# equals()     # returns true if members are equal       ##
+# isZero       # returns true if both members equal zero ##
+# set()        # sets to integer input                   ##
+# x()          # returns fX                              ##
+# y()          # returns fY                              ##
 #Table ##
 #Subtopic ##
 
-#Topic ##
+#Topic Overview ##
 
 #Member int32_t  fX
 x-axis value used by IPoint.