Lines Matching full:docs

4 docs/SkIRect_Reference.bmh
5 docs/SkSurface_Reference.bmh
6 docs/status.json
22 Bookmaker reads canonical documentation from files suffixed with bmh in the docs directory. These b…
25 The docs files must be manually edited to stay current with Skia as it evolves.
88 verify that Bookmaker data in docs builds without error and is consistent with include files it doc…
92 # Public interface in include directory does not match documented interface in docs directory. ##
94 # Undocumented but referenced interface is missing from undocumented bookmaker file in docs directo…
98 Bookmaker detects that comments edited in includes do not match comments in docs; it will generate …
103 …is red, the error is usually related to an edit to an include which has not been reflected in docs.
105 To fix this, edit the docs file corresponding to the changed include file.
107 For instance, if the change was made to SkIRect, edit docs/SkIRect_Reference.bmh.
108 Checking in the edited docs/SkIRect_Reference.bmh will fix the bot.
134 Edit docs instead of include/core files to update comments if possible.
136 The Bookmaker bots do not complain if the docs file does not match the
138 report when docs and includes comments do not match.
141 docs/SkSurface_Reference.bmh, running:
144 $ ./out/dir/bookmaker -b docs -i include/core/SkSurface.h -p
186 $ ./out/dir/bookmaker -a docs/status.json -e fiddle.json
188 $ ./out/dir/bookmaker -a docs/status.json -f fiddleout.json -r site/user/api -c
189 $ ./out/dir/bookmaker -a docs/status.json -f fiddleout.json -r site/user/api
190 $ ./out/dir/bookmaker -a docs/status.json -x
191 $ ./out/dir/bookmaker -a docs/status.json -p
201 $ ./out/dir/bookmaker -i include/core/SkXXX.h -t docs
219 docs/SkXXX_Reference.bmh
225 docs/SkXXX_Reference.bmh
291 $ ./out/dir/bookmaker -e fiddle.json -b docs
307 $ ./out/dir/bookmaker -r site/user/api -b docs -f fiddleout.json
315 $ ./out/dir/bookmaker -x -b docs/SkXXX.bmh -i include/core/SkXXX.h
321 $ ./out/dir/bookmaker -p -b docs -i include/core/SkXXX.h
331 any of the above commands with -a docs/status.json in place of
332 -b docs or -i includes.