skia2/docs
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
..
catalogHeader.txt Documentation refresh 2018-05-16 11:35:24 +00:00
catalogTrailer.txt streamline doc menus 2017-11-01 14:23:50 +00:00
illustrations.bmh remove SkPaint Align from doc examples 2018-10-30 19:51:05 +00:00
markup.bmh Documentation refresh 2018-05-16 11:35:24 +00:00
overview.bmh bookmaker initial checkin 2017-07-28 15:30:38 +00:00
SkAutoCanvasRestore_Reference.bmh Check every word in docs 2018-11-08 13:27:57 +00:00
SkBitmap_Reference.bmh bookmaker does deprecated 2018-11-15 14:08:45 +00:00
SkBlendMode_Overview.bmh Generate bookmaker indices 2018-10-08 19:24:31 +00:00
SkBlendMode_Reference.bmh docs with more pop 2018-10-31 16:45:32 +00:00
SkCanvas_Reference.bmh bookmaker does deprecated 2018-11-15 14:08:45 +00:00
SkColor4f_Reference.bmh Check every word in docs 2018-11-08 13:27:57 +00:00
SkColor_Reference.bmh Check every word in docs 2018-11-08 13:27:57 +00:00
SkDynamicMemoryWStream_Reference.bmh Generate bookmaker indices 2018-10-08 19:24:31 +00:00
SkFILEStream_Reference.bmh docs with more pop 2018-10-31 16:45:32 +00:00
SkFILEWStream_Reference.bmh Generate bookmaker indices 2018-10-08 19:24:31 +00:00
SkImage_Reference.bmh bookmaker does deprecated 2018-11-15 14:08:45 +00:00
SkImageInfo_Reference.bmh Check every word in docs 2018-11-08 13:27:57 +00:00
SkIPoint_Reference.bmh docs with more pop 2018-10-31 16:45:32 +00:00
SkIRect_Reference.bmh Check every word in docs 2018-11-08 13:27:57 +00:00
SkMatrix_Reference.bmh Check every word in docs 2018-11-08 13:27:57 +00:00
SkMemoryStream_Reference.bmh bookmaker does deprecated 2018-11-15 14:08:45 +00:00
SkPaint_Reference.bmh bookmaker does deprecated 2018-11-15 14:08:45 +00:00
SkPath_Overview.bmh Generate bookmaker indices 2018-10-08 19:24:31 +00:00
SkPath_Reference.bmh bookmaker does deprecated 2018-11-15 14:08:45 +00:00
SkPicture_Reference.bmh docs with more pop 2018-10-31 16:45:32 +00:00
SkPixmap_Reference.bmh bookmaker does deprecated 2018-11-15 14:08:45 +00:00
SkPoint_Reference.bmh docs with more pop 2018-10-31 16:45:32 +00:00
SkRect_Reference.bmh bookmaker does deprecated 2018-11-15 14:08:45 +00:00
SkRegion_Reference.bmh bookmaker does deprecated 2018-11-15 14:08:45 +00:00
SkRRect_Reference.bmh Check every word in docs 2018-11-08 13:27:57 +00:00
SkStream_Reference.bmh bookmaker does deprecated 2018-11-15 14:08:45 +00:00
SkSurface_Reference.bmh bookmaker does deprecated 2018-11-15 14:08:45 +00:00
SkTextBlob_Reference.bmh Check every word in docs 2018-11-08 13:27:57 +00:00
SkTextBlobBuilder_Reference.bmh bookmaker does deprecated 2018-11-15 14:08:45 +00:00
SkWStream_Reference.bmh Generate bookmaker indices 2018-10-08 19:24:31 +00:00
spelling.txt bookmaker does deprecated 2018-11-15 14:08:45 +00:00
status.json Generate bookmaker indices 2018-10-08 19:24:31 +00:00
undocumented.bmh bookmaker does deprecated 2018-11-15 14:08:45 +00:00
usingBookmaker.bmh bookmaker does deprecated 2018-11-15 14:08:45 +00:00