diff options
author | Cary Clark <caryclark@skia.org> | 2017-07-28 11:04:54 -0400 |
---|---|---|
committer | Skia Commit-Bot <skia-commit-bot@chromium.org> | 2017-07-28 15:30:38 +0000 |
commit | 8032b983faaa8c76f81bf3cf028e9c64f4635478 (patch) | |
tree | ed3be061ff02a99dab1b3e443d48b7f5c906417e /docs/markup.bmh | |
parent | acaa607328fb0dfac0894d4a2fcdead520e696b3 (diff) |
bookmaker initial checkin
bookmaker is a tool that generates documentation
backends from a canonical markup. Documentation for
bookmaker itself is evolving at docs/usingBookmaker.bmh,
which is visible online at skia.org/user/api/bmh_usingBookmaker
Change-Id: Ic76ddf29134895b5c2ebfbc84603e40ff08caf09
Reviewed-on: https://skia-review.googlesource.com/28000
Commit-Queue: Cary Clark <caryclark@google.com>
Reviewed-by: Cary Clark <caryclark@google.com>
Diffstat (limited to 'docs/markup.bmh')
-rw-r--r-- | docs/markup.bmh | 88 |
1 files changed, 88 insertions, 0 deletions
diff --git a/docs/markup.bmh b/docs/markup.bmh new file mode 100644 index 0000000000..2127fc71f4 --- /dev/null +++ b/docs/markup.bmh @@ -0,0 +1,88 @@ +#Topic Bookmaker_Markup + +# redefine markup character so examples below will not be parsed +###$ + +Text, except for the single markup character, requires no annotation. + +# comments are preceded by a hash symbol and whitespace +# comments may terminated by linefeed or double hash ## <- end of comment + +Keywords are preceded by a single hash symbol without whitespace. +#Keyword + +Keywords are terminated by double hash and may be labeled +## <- end of #keyword + +#Keyword +#Keyword ## <- alternate labeled end of #Keyword + +Tables use single hash symbols to delimit columns, and double to end row. +#Table +#Legend +# first column in table # next column in table ## +## <- end of #Legend +# a row # another row ## +# another row # another row ## +#Table ## <- or, just ## + +$Table +$Legend +$ first column in table $ next column in table $$ +$$ +$ a row $ another row $$ +$ another row $ another row $$ +$Table $$ + +The markup character is initially # at the start of any .bmh file +###x <- redefine the markup character as 'x' +xxx# <- restore the default markup character + + anchor, ala HTML + anchors may start anywhere in the line +#A text #_reference ## + + class description +#Class SkClassName +description +methods +## + + if the example is not named, it inherits the name of its container +#Example + #Description + ## + #Image + #Width + #Height + code... + #StdOut + expected example output + ## +## + +#Enum __required_reference +description +#Code +## +#Example +## +#Enum ## + + method description + the _method_reference must be unique within the class +#Method type name(params..) +description +#Param name description ## +#Return return ## +#Example +## +#SeeAlso ## +## + +#ToDo description ## + +$ restore markup character +$$$# + +## |