Commit Graph

10 Commits

Author SHA1 Message Date
Brian Osman
4cd0734f4c Remove bookmaker sources and data files
We're moving in a different direction for Skia documentation. We no
longer run bookmaker on the bots, and things have already degraded such
that it can't be run. This leaves the generated markdown in place for
the last set of docs that were generated (which are still useful until
the Doxygen docs catch up).

See also: https://skia-review.googlesource.com/c/skia/+/198162

Docs-Preview: https://skia.org/?cl=203464
Bug: skia:
Change-Id: I2f967a9c17dbc1cc899947d365071ef69cfb8ad7
Reviewed-on: https://skia-review.googlesource.com/c/skia/+/203464
Reviewed-by: Mike Klein <mtklein@google.com>
Commit-Queue: Brian Osman <brianosman@google.com>
2019-03-25 18:56:29 +00:00
Cary Clark
cb6bef0ad5 Update bookmaker
- This update includes font documentation.
SkFont_Reference.bmh was generated by running:

  bookmaker -b docs -i include/core/SkFont.h -t

This creates a placeholder
for examples and additional documentation.

- More work done to exclude experimental/private
symbols.

Symbols that include "experimental_", "legacy_",
"private_", "temporary_", "deprecated_" as part
of their name (case-insensitive) are not
referenced by the on-line docs and don't need
comments.

Tables built for online only include public symbols.

- Better links for constructors, destructors, operators
- Fixed some minor public interfaces
- Removed _const crutch on operators
- Keep includes inside 100 columns

TBR=reed@google.com

Docs-Preview: https://skia.org/?cl=171900
Bug: skia:
Change-Id: I93b229c6625d800604671e05b82a14c06cb906d2
Reviewed-on: https://skia-review.googlesource.com/c/171900
Reviewed-by: Cary Clark <caryclark@skia.org>
Commit-Queue: Cary Clark <caryclark@skia.org>
2018-11-29 18:17:30 +00:00
Mike Reed
e00fe30b8f remove SkIPoint16 from documentation -- it is private
No-Try: true
Docs-Preview: https://skia.org/?cl=149267
Bug: skia:
Change-Id: Idee5487ceecd84c179f898afe3ebc63926608c56
Reviewed-on: https://skia-review.googlesource.com/149267
Commit-Queue: Cary Clark <caryclark@google.com>
Reviewed-by: Cary Clark <caryclark@google.com>
2018-08-27 11:33:19 +00:00
Cary Clark
5eebe87a0c update doc index
Add SkRegion, SkTextBlob, SkTextBuildBuilder
to top level API documentation

TBR=jcgregorio@google.com

No-Try: true
Docs-Preview: https://skia.org/?cl=147814
Bug: skia:6898
Change-Id: Ie4033cd7e542b2e462521aa5c838bb2457d32300
Reviewed-on: https://skia-review.googlesource.com/147814
Commit-Queue: Cary Clark <caryclark@skia.org>
Reviewed-by: Cary Clark <caryclark@skia.org>
2018-08-17 18:19:42 +00:00
Cary Clark
80247e594d Publish docs for rrect, picture, blendmode
Complete basic docs for SkRRect, SkPicture, SkBlendMode.
Add a new rule that checks the main description tense.
Check for spelling errors.

R=caryclark@google.com

Docs-Preview: https://skia.org/?cl=138542
Bug: skia:6898
Change-Id: Iba547873775a89f1d652be9b0219b84ffa8d0628
Reviewed-on: https://skia-review.googlesource.com/138542
Commit-Queue: Cary Clark <caryclark@skia.org>
Reviewed-by: Cary Clark <caryclark@skia.org>
Auto-Submit: Cary Clark <caryclark@skia.org>
2018-07-11 21:21:28 +00:00
Ben Wagner
528ceb9c0d Fix api METADATA json.
Must use double quotes; no comma after last element of array.

Change-Id: I2556508babacc9bc00a5cddceed9ee454dc4fc96
Reviewed-on: https://skia-review.googlesource.com/106282
Reviewed-by: Ben Wagner <bungeman@google.com>
Reviewed-by: Cary Clark <caryclark@google.com>
Commit-Queue: Ben Wagner <bungeman@google.com>
2018-02-09 22:41:09 +00:00
Ben Wagner
64a424f37f Order the API reference.
Docs-Preview: https://skia.org/?cl=105900

Change-Id: I8c514e5c1dc4f5612971f23676351bf2a0e3a135
Reviewed-on: https://skia-review.googlesource.com/105900
Reviewed-by: Cary Clark <caryclark@google.com>
Commit-Queue: Ben Wagner <bungeman@google.com>
2018-02-09 17:11:41 +00:00
Cary Clark
d49980c435 streamline doc menus
No-Try: true
Docs-Preview: https://skia.org/?cl=66145
Bug: skia:6898
Change-Id: I11acd8c17db5faa833ca38550d82819e799dd311
Reviewed-on: https://skia-review.googlesource.com/66145
Commit-Queue: Cary Clark <caryclark@skia.org>
Reviewed-by: Cary Clark <caryclark@skia.org>
2017-11-01 14:23:50 +00:00
Cary Clark
12799e17d5 bookmaker generated site docs
The documents were generated by running
tools/bookmaker against docs/*.bmh

No-Try: true
Docs-Preview: https://skia.org/?cl=28002
Change-Id: I7d7dd73cdea4a234c6175646d5b8938e1af3117a
Reviewed-on: https://skia-review.googlesource.com/28002
Reviewed-by: Cary Clark <caryclark@skia.org>
Commit-Queue: Cary Clark <caryclark@skia.org>
2017-07-28 19:25:53 +00:00
halcanary
ee2a8eede9 Documentation: SkCanvas API
NOTRY=true
DOCS_PREVIEW= https://skia.org/?cl=1127383010
DOCS_PREVIEW= https://skia.org/user/api?cl=1127383010
DOCS_PREVIEW= https://skia.org/user/api/skcanvas?cl=1127383010
DOCS_PREVIEW= https://skia.org/user/api/skpaint?cl=1127383010
DOCS_PREVIEW= https://skia.org/user/api/skrect?cl=1127383010
DOCS_PREVIEW= https://skia.org/user/api/skregion?cl=1127383010
DOCS_PREVIEW= https://skia.org/user/api/skmatrix?cl=1127383010
DOCS_PREVIEW= https://skia.org/user/api/canvas?cl=1127383010

Review URL: https://codereview.chromium.org/1127383010
2015-05-19 10:21:29 -07:00