skia2/tools/bookmaker
Cary Clark abaffd85ab bookmaker does deprecated
Bookmaker does not require documentation for public symbols
described as "deprecated", "private", or "experimental".
Adding one of these words (case-insensitive) to the symbol
description in the include file tells bookmaker that the bmh file
should not include documentation, and the generated markdown
should omit it in its indices and descriptions.

Symbols marked as "to be deprecated" or "may be deprecated"
are still regarded as public and documented.

Private notes in the includes that start with TODO: are
omitted as well.

This CL updated generated includes to describe its symbols
accordingly. The includes will be fully regenerated in a future
CL. The corresponding documentation has been deleted from the
bmh files, and the web markup has been regenerated.

TBR=reed@google.com
Docs-Preview: https://skia.org/?cl=169830
Bug: skia:
Change-Id: Ie6ec3ccdadb7be9ac15db4811823a30948c4af25
Reviewed-on: https://skia-review.googlesource.com/c/169830
Commit-Queue: Cary Clark <caryclark@skia.org>
Auto-Submit: Cary Clark <caryclark@skia.org>
Reviewed-by: Cary Clark <caryclark@skia.org>
2018-11-15 14:08:45 +00:00
..
bmhParser.cpp bookmaker does deprecated 2018-11-15 14:08:45 +00:00
bmhParser.h refactor bookmaker 2018-11-01 13:58:32 +00:00
bookmaker.cpp Check every word in docs 2018-11-08 13:27:57 +00:00
bookmaker.h bookmaker does deprecated 2018-11-15 14:08:45 +00:00
cataloger.cpp refactor bookmaker 2018-11-01 13:58:32 +00:00
definition.cpp bookmaker does deprecated 2018-11-15 14:08:45 +00:00
definition.h bookmaker does deprecated 2018-11-15 14:08:45 +00:00
fiddleParser.cpp refactor bookmaker 2018-11-01 13:58:32 +00:00
fiddleParser.h refactor bookmaker 2018-11-01 13:58:32 +00:00
hackParser.cpp bookmaker does deprecated 2018-11-15 14:08:45 +00:00
includeParser.cpp bookmaker does deprecated 2018-11-15 14:08:45 +00:00
includeParser.h bookmaker does deprecated 2018-11-15 14:08:45 +00:00
includeWriter.cpp bookmaker does deprecated 2018-11-15 14:08:45 +00:00
includeWriter.h refactor bookmaker 2018-11-01 13:58:32 +00:00
mdOut.cpp bookmaker does deprecated 2018-11-15 14:08:45 +00:00
mdOut.h Check every word in docs 2018-11-08 13:27:57 +00:00
parserCommon.cpp refactor bookmaker 2018-11-01 13:58:32 +00:00
parserCommon.h bookmaker does deprecated 2018-11-15 14:08:45 +00:00
selfCheck.cpp bookmaker does deprecated 2018-11-15 14:08:45 +00:00
selfCheck.h refactor bookmaker 2018-11-01 13:58:32 +00:00
spellCheck.cpp bookmaker does deprecated 2018-11-15 14:08:45 +00:00
textParser.cpp Check every word in docs 2018-11-08 13:27:57 +00:00
textParser.h bookmaker does deprecated 2018-11-15 14:08:45 +00:00