From 4855f78dd16ad50003ec537c98062e24a831cd45 Mon Sep 17 00:00:00 2001 From: Cary Clark Date: Tue, 6 Feb 2018 09:41:53 -0500 Subject: fix bookmaker nightly - mark the interfaces that use SkMask as deprecated - add more autogenerated subtopics - make subtopic names singular, avoiding collision with Skia names - simplify #Deprecated and #Bug tags - add "#Deprecated soon" to note things to be deprecated - fix some spelling errors - refresh web docs - add self-check functionality to find methods outside subtopics TBR=caryclark@google.com Docs-Preview: https://skia.org/?cl=102150 Bug: skia:6898 Change-Id: I0e742a56d49dccd4409bb68eed9167c8ad7611ce Reviewed-on: https://skia-review.googlesource.com/102150 Commit-Queue: Cary Clark Reviewed-by: Cary Clark --- docs/SkCanvas_Reference.bmh | 64 +++++++++++---------------------------------- 1 file changed, 15 insertions(+), 49 deletions(-) (limited to 'docs/SkCanvas_Reference.bmh') diff --git a/docs/SkCanvas_Reference.bmh b/docs/SkCanvas_Reference.bmh index 2225b205de..67445d4464 100644 --- a/docs/SkCanvas_Reference.bmh +++ b/docs/SkCanvas_Reference.bmh @@ -2,7 +2,7 @@ #Alias Canvas_Reference #Subtopic Overview - #Subtopic Subtopics + #Subtopic Subtopic #Populate ## ## @@ -30,27 +30,27 @@ destination. Canvas can be constructed to draw to Bitmap without first creating Raster_Surface. This approach may be deprecated in the future. -#Subtopic Related_Functions +#Subtopic Related_Function #Populate ## -#Subtopic Constants +#Subtopic Constant #Populate ## -#Subtopic Classes_and_Structs +#Subtopic Class_or_Struct #Populate ## -#Subtopic Constructors +#Subtopic Constructor -Create the desired type of Surface to obtain its Canvas when possible. Constructors are useful +Create the desired type of Surface to obtain its Canvas when possible. Useful when no Surface is required, and some helpers implicitly create Raster_Surface. #Populate ## -#Subtopic Member_Functions +#Subtopic Member_Function #Populate ## @@ -295,25 +295,7 @@ different characteristics, it is best not to rely on this legacy behavior. # ------------------------------------------------------------------------------ #Method explicit SkCanvas(SkBaseDevice* device) - -#Line # to be deprecated ## -Construct a canvas that draws into device. -Used by child classes of SkCanvas. - -#ToDo Since SkBaseDevice is private, shouldn't this be private also? ## - -#Param device specifies a device for the canvas to draw into ## - -#Return Canvas that can be used to draw into device ## - -#ToDo unsure how to create a meaningful example ## -#NoExample -## - -#ToDo either remove doc or figure out a way to fiddle it ## - -#SeeAlso MakeRasterDirect SkRasterHandleAllocator::MakeCanvas SkSurface::getCanvas SkCreateColorSpaceXformCanvas - +#Deprecated soon ## # ------------------------------------------------------------------------------ @@ -675,7 +657,7 @@ smaller (due to clipping or saveLayer). # ------------------------------------------------------------------------------ #Method sk_sp makeSurface(const SkImageInfo& info, const SkSurfaceProps* props = nullptr) - +#In Constructor #Line # creates Surface matching SkImageInfo and SkSurfaceProps ## Creates Surface matching info and props, and associates it with Canvas. Returns nullptr if no match found. @@ -1707,11 +1689,7 @@ defining how Layer allocated by saveLayer operates. ## #Const kDontClipToLayer_Legacy_SaveLayerFlag 0x80000000 -#Private - to be deprecated: bug.skia.org/2440 -## - Only present on Android. - Skips setting a clip to the Layer bounds. +#Deprecated soon ## #Example @@ -2864,7 +2842,7 @@ is Anti-aliased. ## # local canvas in example works around bug in fiddle ## -#Bug 6524 ## +#Bug 6524 #SeeAlso getDeviceClipBounds getBaseLayerSize quickReject ## @@ -2901,7 +2879,7 @@ is Anti-aliased. ## # local canvas in example works around bug in fiddle ## -#Bug 6524 ## +#Bug 6524 #SeeAlso getDeviceClipBounds getBaseLayerSize quickReject ## @@ -2955,7 +2933,7 @@ void draw(SkCanvas* canvas) { #SeeAlso getLocalClipBounds getBaseLayerSize quickReject # device canvas in example works around bug in fiddle ## -#Bug 6524 ## +#Bug 6524 ## @@ -6127,23 +6105,11 @@ Document_PDF, use annotations. ## #Method SkDrawFilter* getDrawFilter() const - -#Line # legacy; to be deprecated ## -Legacy call to be deprecated. - -#Deprecated -## - +#Deprecated soon ## #Method virtual SkDrawFilter* setDrawFilter(SkDrawFilter* filter) - -#Line # legacy; to be deprecated ## -Legacy call to be deprecated. - -#Deprecated -## - +#Deprecated soon ## # ------------------------------------------------------------------------------ -- cgit v1.2.3