docs with more pop
Replace a hunk of documentation in docs/*.bmh
with #Populate, which instructs bookmaker to
retrieve the documentation from include/core.
Check spelling for all documentation retrieved
from include/core against Skia declarations
and a list of words in spelling.txt.
TBR=caryclark@google.com
Docs-Preview: https://skia.org/?cl=163491
Bug: skia:
Change-Id: If057c3a1336e312ad59c084a3a130f0276802496
Reviewed-on: https://skia-review.googlesource.com/c/163491
Commit-Queue: Cary Clark <caryclark@skia.org>
Reviewed-by: Cary Clark <caryclark@skia.org>
Auto-Submit: Cary Clark <caryclark@skia.org>
diff --git a/docs/undocumented.bmh b/docs/undocumented.bmh
index a6bf6ee..3eda4eb 100644
--- a/docs/undocumented.bmh
+++ b/docs/undocumented.bmh
@@ -7,14 +7,16 @@
API
BMP GIF HEIF ICO JPEG PNG WBMP WebP
CPU
- GPU GPU-backed OpenGL Vulkan I/O MSAA
+ GPU GPU-backed OpenGL Vulkan VkDevice I/O MSAA
PDF XPS
RFC
NaN NaNs
- U16CPU
-
+ U16CPU int int8_t int16_t int32_t int64_t uint8_t uint16_t uint32_t uint64_t size_t
+ nullptr
+ malloc() calloc() assert() std::move()
C C++ SIZE_MAX C_FILE
CSS HTML
+ affine destructor multitexturing representable subclasses descenders grayscale kerning unhinted
Sa Da Sc Dc max min # temporary until figure out what to do
@@ -47,38 +49,6 @@
#External ##
-# this jargon requires a substitute to lower-case the word. The word is uppercase because
-# it is not a dictionary word. An alternative would be to put this in an exception list
-# in the spell checker
-#Topic Destructor
-#Substitute destructor
-##
-
-# see comment for Destructor above
-#Topic Subclasses
-#Substitute subclasses
-##
-
-# see comment for Destructor above
-#Topic Descenders
-#Substitute descenders
-##
-
-# see comment for Destructor above
-#Topic Grayscale
-#Substitute grayscale
-##
-
-# see comment for Destructor above
-#Topic Kerning
-#Substitute kerning
-##
-
-# see comment for Destructor above
-#Topic Unhinted
-#Substitute unhinted
-##
-
# this jargon requires a substitute to space the phrase.
#Topic Little_Endian
#Substitute little endian
@@ -260,6 +230,14 @@
#Topic Deserial_Procs
#Struct SkDeserialProcs
+#Member SkDeserialPictureProc fPictureProc
+##
+#Member void* fPictureCtx
+##
+#Member SkDeserialTypefaceProc fTypefaceProc
+##
+#Member void* fTypefaceCtx
+##
##
##
@@ -413,6 +391,10 @@
#Topic ISize
#Struct SkISize
+#Method int32_t width() const
+##
+#Method int32_t height() const
+##
##
##
@@ -444,6 +426,9 @@
#Topic ##
# to be in Topic Math
+ #Method float sqrt(float x)
+ # this permits using sqrt(x) in documentation
+ ##
#Method static inline bool sk_64_isS32(int64_t value)
##
#Method SkIntToScalar(x)
@@ -478,11 +463,10 @@
#Topic Nine_Patch
##
-# to be in Topic Number_Types
+# to be in Topic Number_Types ?
#Typedef uint16_t SkGlyphID
#Typedef ##
#Topic Scalar
- #Alias Scalar ##
#Alias Scalars ##
#Typedef float SkScalar
#Typedef ##
@@ -638,9 +622,11 @@
# end of Topic Rasterizer
#Topic Reference_Count
-#Substitute SkRefCnt
#Class SkRefCnt
#Class ##
+##
+
+#Topic Smart_Pointer
#Class sk_sp
#Class ##
#Topic ##
@@ -655,11 +641,27 @@
#Topic RSXform
#Struct SkRSXform
+#Member SkScalar fSCos
+##
+#Member SkScalar fSSin
+##
+#Member SkScalar fTx
+##
+#Member SkScalar fTy
+##
##
##
#Topic Serial_Procs
#Struct SkSerialProcs
+#Member SkSerialPictureProc fPictureProc
+##
+#Member void* fPictureCtx
+##
+#Member SkSerialTypefaceProc fTypefaceProc
+##
+#Member void* fTypefaceCtx
+##
##
##
@@ -684,6 +686,10 @@
#Topic Size
#Struct SkSize
+#Method int32_t width() const
+##
+#Method int32_t height() const
+##
##
##
@@ -725,6 +731,9 @@
##
#Subtopic Arc
##
+#Subtopic Sweep_Flag
+#Substitute SVG sweep-flag
+##
##
#Topic Text
@@ -815,7 +824,3 @@
#Class SkXfermodeImageFilter
##
##
-
-# temporary while ref is separated from overview
-#Topic Zero_Length_Contour
-##