diff options
author | Cary Clark <caryclark@skia.org> | 2018-01-11 10:35:44 -0500 |
---|---|---|
committer | Skia Commit-Bot <skia-commit-bot@chromium.org> | 2018-01-11 19:37:49 +0000 |
commit | ac47b88d3c4b6232ea8664cea99fbd8394f2dc38 (patch) | |
tree | 39c001433e3677d688cc472292295a8062edee80 /docs/usingBookmaker.bmh | |
parent | 5f9102f2912ef702e013c48466b5461f2a0b9eb9 (diff) |
update bookmaker to ToT
more image docs, still not done
add ability to comment out non-working examples easily
start work on additional self-checks
clean up use of this-> in docs
TBR=reed@google.com
Docs-Preview: https://skia.org/?cl=91720
Bug: skia:6898
Change-Id: I706ab8145290e53ab67d3f509ccf4e1225adb3c3
Reviewed-on: https://skia-review.googlesource.com/91720
Commit-Queue: Cary Clark <caryclark@skia.org>
Reviewed-by: Cary Clark <caryclark@skia.org>
Diffstat (limited to 'docs/usingBookmaker.bmh')
-rw-r--r-- | docs/usingBookmaker.bmh | 36 |
1 files changed, 35 insertions, 1 deletions
diff --git a/docs/usingBookmaker.bmh b/docs/usingBookmaker.bmh index 170a5a711d..d123bc7647 100644 --- a/docs/usingBookmaker.bmh +++ b/docs/usingBookmaker.bmh @@ -11,6 +11,8 @@ Completed InProgress #Topic Bookmaker +How to use the Bookmaker utility. + #Subtopic Broken_Build If the @@ -24,6 +26,20 @@ To fix this, edit the docs file corresponding to the changed include file. For instance, if the change was made to SkIRect, edit docs/SkIRect_Reference.bmh. Checking in the edited docs/SkIRect_Reference.bmh will fix the bot. +If the interface is deprecated, but still present in the interface, mark-up the +documentation to be deprecated as well. + +#Code +###$ +#Method void someMethodThatIsNowDeprecated() + +#Deprecated +## + +## +$$$# +## + To regenerate the documentation, follow the Installing and Regenerate steps below. If the @@ -71,7 +87,25 @@ and Bookmaker will not generate any output. #Subtopic Editing_Comments ## -How to use the Bookmaker utility. +#Subtopic Broken_Example + +An example may cause Bookmaker or a bot running Bookmaker to fail if it can't +be compiled by fiddle. If the example cannot be fixed, it can be commented out +by changing +###$ +$Code +$Literal +#Example +$Code $$ +to +$Code +#NoExample +$Code $$ +$$$# +. The disabled example can contain additional markup, +which will be ignored. + +#Subtopic Broken_Example ## #Subtopic Installing |