5081eede67
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>
146 lines
2.8 KiB
Plaintext
146 lines
2.8 KiB
Plaintext
#Topic IPoint16
|
|
#Alias IPoint16_Reference
|
|
|
|
#Struct SkIPoint16
|
|
|
|
SkIPoint holds two 16 bit integer coordinates.
|
|
|
|
#Topic Overview
|
|
|
|
#Subtopic Subtopics
|
|
#ToDo manually add subtopics ##
|
|
#Table
|
|
#Legend
|
|
# 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
|
|
# name # description ##
|
|
#Legend ##
|
|
# Make # constructs from integer inputs ##
|
|
# set() # sets to integer input ##
|
|
# x() # returns fX ##
|
|
# y() # returns fY ##
|
|
#Table ##
|
|
#Subtopic ##
|
|
|
|
#Topic Overview ##
|
|
|
|
#Member int16_t fX
|
|
x-axis value used by IPoint16
|
|
##
|
|
|
|
#Member int16_t fY
|
|
y-axis value used by IPoint16
|
|
##
|
|
|
|
# ------------------------------------------------------------------------------
|
|
|
|
#Method static constexpr SkIPoint16 Make(int x, int y)
|
|
|
|
Sets fX to x, fY to y. If SK_DEBUG is defined, asserts
|
|
if x or y does not fit in 16 bits.
|
|
|
|
#Param x integer x-axis value of constructed IPoint ##
|
|
#Param y integer y-axis value of constructed IPoint ##
|
|
|
|
#Return IPoint16 (x, y) ##
|
|
|
|
#Example
|
|
SkIPoint16 pt1 = {45, 66};
|
|
SkIPoint16 pt2 = SkIPoint16::Make(45, 66);
|
|
SkDebugf("pt1.fX %c= pt2.fX\n", pt1.fX == pt2.fX ? '=' : '!');
|
|
SkDebugf("pt1.fY %c= pt2.fY\n", pt1.fY == pt2.fY ? '=' : '!');
|
|
#StdOut
|
|
pt1.fX == pt2.fX
|
|
pt1.fY == pt2.fY
|
|
##
|
|
##
|
|
|
|
#SeeAlso set() SkPoint::iset() SkIPoint::Make
|
|
|
|
#Method ##
|
|
|
|
# ------------------------------------------------------------------------------
|
|
|
|
#Method int16_t x() const
|
|
|
|
Returns x-axis value of IPoint16.
|
|
|
|
#Return fX ##
|
|
|
|
#Example
|
|
SkIPoint16 pt1 = {45, 66};
|
|
SkDebugf("pt1.fX %c= pt1.x()\n", pt1.fX == pt1.x() ? '=' : '!');
|
|
#StdOut
|
|
pt1.fX == pt1.x()
|
|
##
|
|
##
|
|
|
|
#SeeAlso y() SkIPoint::x()
|
|
|
|
#Method ##
|
|
|
|
# ------------------------------------------------------------------------------
|
|
|
|
#Method int16_t y() const
|
|
|
|
Returns y-axis value of IPoint.
|
|
|
|
#Return fY ##
|
|
|
|
#Example
|
|
SkIPoint16 pt1 = {45, 66};
|
|
SkDebugf("pt1.fY %c= pt1.y()\n", pt1.fY == pt1.y() ? '=' : '!');
|
|
#StdOut
|
|
pt1.fY == pt1.y()
|
|
##
|
|
##
|
|
|
|
#SeeAlso x() SkPoint::y() SkIPoint::y()
|
|
|
|
#Method ##
|
|
|
|
# ------------------------------------------------------------------------------
|
|
|
|
#Method void set(int x, int y)
|
|
|
|
Sets fX to x and fY to y.
|
|
|
|
#Param x new value for fX ##
|
|
#Param y new value for fY ##
|
|
|
|
#Example
|
|
SkIPoint16 pt1, pt2 = { SK_MinS16, SK_MaxS16 };
|
|
pt1.set(SK_MinS16, SK_MaxS16);
|
|
SkDebugf("pt1.fX %c= pt2.fX\n", pt1.fX == pt2.fX ? '=' : '!');
|
|
SkDebugf("pt1.fY %c= pt2.fY\n", pt1.fY == pt2.fY ? '=' : '!');
|
|
#StdOut
|
|
pt1.fX == pt2.fX
|
|
pt1.fY == pt2.fY
|
|
##
|
|
##
|
|
|
|
#SeeAlso Make SkPoint::set
|
|
|
|
#Method ##
|
|
|
|
#Struct SkIPoint16 ##
|
|
|
|
#Topic IPoint16 ##
|