aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/SkIPoint16_Reference.bmh
diff options
context:
space:
mode:
authorGravatar Cary Clark <caryclark@skia.org>2018-01-22 07:55:48 -0500
committerGravatar Skia Commit-Bot <skia-commit-bot@chromium.org>2018-01-22 14:04:18 +0000
commit5081eede67601e5c5c0fc343b787490603e058cc (patch)
tree607f095f636eca498e62e14e3c6d760f477052d4 /docs/SkIPoint16_Reference.bmh
parent8a67c4c2aa4debca84a68fbc25f048ce55118916 (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/SkIPoint16_Reference.bmh')
-rw-r--r--docs/SkIPoint16_Reference.bmh33
1 files changed, 22 insertions, 11 deletions
diff --git a/docs/SkIPoint16_Reference.bmh b/docs/SkIPoint16_Reference.bmh
index b5c3cfee99..4f3d53b28b 100644
--- a/docs/SkIPoint16_Reference.bmh
+++ b/docs/SkIPoint16_Reference.bmh
@@ -3,7 +3,7 @@
#Struct SkIPoint16
-SkIPoint holds two 16 bit integer coordinates
+SkIPoint holds two 16 bit integer coordinates.
#Topic Overview
@@ -11,31 +11,42 @@ SkIPoint holds two 16 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 ##
#Table ##
-##
+#Subtopic ##
+
+#Subtopic Constructors
+#Table
+#Legend
+# name # description ##
+#Legend ##
+# Make # constructs from integer inputs ##
+#Table ##
+#Subtopic ##
#Subtopic Member_Functions
#Table
#Legend
-# description # function ##
+# name # description ##
#Legend ##
-# Make # Constructs from integer inputs. ##
-# set() # Sets to integer input. ##
-# x() # Returns fX. ##
-# y() # Returns fY. ##
+# Make # constructs from integer inputs ##
+# set() # sets to integer input ##
+# x() # returns fX ##
+# y() # returns fY ##
#Table ##
#Subtopic ##
-#Topic ##
+#Topic Overview ##
#Member int16_t fX
-x-axis value used by IPoint16.
+x-axis value used by IPoint16
##
#Member int16_t fY
-y-axis value used by IPoint16.
+y-axis value used by IPoint16
##
# ------------------------------------------------------------------------------