diff options
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 |