From 5081eede67601e5c5c0fc343b787490603e058cc Mon Sep 17 00:00:00 2001 From: Cary Clark Date: Mon, 22 Jan 2018 07:55:48 -0500 Subject: 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 Commit-Queue: Cary Clark --- docs/SkSurface_Reference.bmh | 75 ++++++++++++++++++++++++++++---------------- 1 file changed, 48 insertions(+), 27 deletions(-) (limited to 'docs/SkSurface_Reference.bmh') diff --git a/docs/SkSurface_Reference.bmh b/docs/SkSurface_Reference.bmh index 3ab33c7d22..164570d422 100644 --- a/docs/SkSurface_Reference.bmh +++ b/docs/SkSurface_Reference.bmh @@ -18,41 +18,62 @@ of the requested dimensions are zero, then nullptr will be returned. #Legend # topics # description ## #Legend ## +# Constructors # functions that construct SkIPoint16 ## +# Member_Functions # static functions and member methods ## #Table ## ## +#Subtopic Constructors +#Table +#Legend +# name # description ## +#Legend ## +# MakeFromBackendRenderTarget # creates Surface from GPU memory buffer ## +# MakeFromBackendTexture # creates Surface from GPU-backed texture ## +# MakeFromBackendTextureAsRenderTarget # creates Surface from GPU-backed texture ## +# MakeNull # creates Surface without backing pixels ## +# MakeRaster # creates Surface from SkImageInfo ## +# MakeRasterDirect # creates Surface from SkImageInfo and Pixel_Storage ## +# MakeRasterDirectReleaseProc # creates Surface from SkImageInfo and Pixel_Storage ## +# MakeRasterN32Premul # creates Surface from width, height matching output ## +# MakeRenderTarget # creates Surface pointing to new GPU memory buffer ## +# SkCanvas::makeSurface # creates Surface matching Canvas Image_Info, Surface_Properties ## +# makeSurface # creates a compatible Surface ## +#Table ## +#Subtopic ## + #Subtopic Member_Functions #Table #Legend # description # function ## #Legend ## -# MakeFromBackendRenderTarget # Creates Surface from GPU memory buffer. ## -# MakeFromBackendTexture # Creates Surface from GPU-backed texture. ## -# MakeFromBackendTextureAsRenderTarget # Creates Surface from GPU-backed texture. ## -# MakeNull # Creates Surface without backing pixels. ## -# MakeRaster # Creates Surface from SkImageInfo. ## -# MakeRasterDirect # Creates Surface from SkImageInfo and Pixel_Storage. ## -# MakeRasterDirectReleaseProc # Creates Surface from SkImageInfo and Pixel_Storage. ## -# MakeRasterN32Premul # Creates Surface from width, height matching output. ## -# MakeRenderTarget # Creates Surface pointing to new GPU memory buffer. ## -# characterize() # Set up Surface_Characterization for threaded pre-processing. ## -# draw() # Draws Surface contents to canvas. ## -# flush() # Resolve pending I/O. ## -# flushAndSignalSemaphores # Resolve pending I/O, and signal. ## -# generationID # Returns unique ID. ## -# getCanvas # Returns Canvas that draws into Surface. ## -# getRenderTargetHandle # Returns the GPU reference to render target. ## -# getTextureHandle # Returns the GPU reference to texture. ## -# height() # Returns pixel row count. ## -# makeImageSnapshot # Returns Image capturing Surface contents. ## -# makeSurface # Returns a compatible Surface. ## -# notifyContentWillChange # Notifies that contents will be changed outside of Skia. ## -# peekPixels # Copies Surface parameters to Pixmap. ## -# prepareForExternalIO # To be deprecated. ## -# props() # Returns Surface_Properties. ## -# readPixels # Copies Rect of pixels. ## -# wait() # Pause commands until signaled. ## -# width() # Returns pixel column count. ## +# MakeFromBackendRenderTarget # creates Surface from GPU memory buffer ## +# MakeFromBackendTexture # creates Surface from GPU-backed texture ## +# MakeFromBackendTextureAsRenderTarget # creates Surface from GPU-backed texture ## +# MakeNull # creates Surface without backing pixels ## +# MakeRaster # creates Surface from SkImageInfo ## +# MakeRasterDirect # creates Surface from SkImageInfo and Pixel_Storage ## +# MakeRasterDirectReleaseProc # creates Surface from SkImageInfo and Pixel_Storage ## +# MakeRasterN32Premul # creates Surface from width, height matching output ## +# MakeRenderTarget # creates Surface pointing to new GPU memory buffer ## +# characterize() # sets Surface_Characterization for threaded pre-processing ## +# draw() # draws Surface contents to canvas ## +# flush() # resolve pending I/O ## +# flushAndSignalSemaphores # resolve pending I/O, and signal ## +# generationID # returns unique ID ## +# getCanvas # returns Canvas that draws into Surface ## +# getRenderTargetHandle # returns the GPU reference to render target ## +# getTextureHandle # returns the GPU reference to texture ## +# height() # returns pixel row count ## +# makeImageSnapshot # creates Image capturing Surface contents ## +# makeSurface # creates a compatible Surface ## +# notifyContentWillChange # notifies that contents will be changed outside of Skia ## +# peekPixels # copies Surface parameters to Pixmap ## +# prepareForExternalIO # to be deprecated ## +# props() # returns Surface_Properties ## +# readPixels # copies Rect of pixels ## +# wait() # rause commands until signaled ## +# width() # returns pixel column count ## #Table ## #Subtopic ## -- cgit v1.2.3