From d0530ba8f406ef287ce89a995ce7be4b32ab6e85 Mon Sep 17 00:00:00 2001 From: Cary Clark Date: Thu, 14 Sep 2017 11:25:39 -0400 Subject: wip pixmap docs wip pixmap docs Docs-Preview: https://skia.org/?cl=42522 Bug: skia: 6898 Change-Id: I85947bc36ea057ed008b87d7bef2efa82d7c89ad Reviewed-on: https://skia-review.googlesource.com/42522 Reviewed-by: Cary Clark Commit-Queue: Cary Clark --- docs/usingBookmaker.bmh | 35 ++++++++++++++++++++++++++++------- 1 file changed, 28 insertions(+), 7 deletions(-) (limited to 'docs/usingBookmaker.bmh') diff --git a/docs/usingBookmaker.bmh b/docs/usingBookmaker.bmh index 60505ca279..16775c5716 100644 --- a/docs/usingBookmaker.bmh +++ b/docs/usingBookmaker.bmh @@ -25,15 +25,35 @@ $ ninja -C out/dir bookmaker ## Generate an starter Bookmaker file from an existing include. -This writes SkXXX.bmh in the current directory, which is -out/dir/obj/ from an IDE. #Code -$ ./out/dir/bookmaker -t -i include/core/SkXXX.h +$ ./out/dir/bookmaker -i include/core/SkXXX.h -t docs ## -Copy SkXXX.bmh to docs. -Use your favorite editor to fill out docs/SkXXX.bmh. +If a method or function has an unnamed parameter, bookmaker generates an error: + +#Code +###$ +C:/puregit/include/core/SkPixmap.h(208): error: #Method missing param name +bool erase(const SkColor4f&, const SkIRect* subset = nullptr) const + ^ +$$$# +## + +All parameters require names to allow markdown and doxygen documents to refer to +them. After naming all parameters, check in the include before continuing. + +A successful run generates +#Code +docs/SkXXX_Reference.bmh +## +. + +Next, use your favorite editor to fill out +#Code +docs/SkXXX_Reference.bmh +## +. #Subtopic Style @@ -102,13 +122,14 @@ This reports if a method no longer exists or its parameters have changed. $ ./out/dir/bookmaker -x -b docs/SkXXX.bmh -i include/core/SkXXX.h ## -Generate an updated include header. -This writes the updated SkXXX.h to the current directory. +Generate an updated include header. Run: #Code $ ./out/dir/bookmaker -p -b docs -i include/core/SkXXX.h ## +to write the updated SkXXX.h to the current directory. + #Subtopic Bugs Bookmaker bugs are tracked #A here # bug.skia.org/6898 ##. -- cgit v1.2.3