Commit Graph

14 Commits

Author SHA1 Message Date
Joe Gregorio
ffd6a7f6d1 Change all pointers to doxygen docs to point to api.skia.org.
No-Try: true
Docs-Preview: https://skia.org/?cl=199726
Bug: skia:
Change-Id: I3dc589bfe7b693b9cd29f7262b74824968569c86
Reviewed-on: https://skia-review.googlesource.com/c/skia/+/199726
Reviewed-by: Heather Miller <hcm@google.com>
Commit-Queue: Joe Gregorio <jcgregorio@google.com>
2019-03-11 16:53:41 +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
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
Hal Canary
5c036433b7 Docs: clean up links
No-Try: true
Docs-Preview: https://skia.org/user/api?cl=108502

Change-Id: I17547b53b50a00e4e9ad1704a032b5b0d14ea436
Reviewed-on: https://skia-review.googlesource.com/108502
Reviewed-by: Cary Clark <caryclark@google.com>
Commit-Queue: Hal Canary <halcanary@google.com>
2018-02-20 16:52:03 +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
d0530ba8f4 wip pixmap docs
wip pixmap docs

Docs-Preview: https://skia.org/?cl=42522
Bug: skia: 6898
Change-Id: I85947bc36ea057ed008b87d7bef2efa82d7c89ad
Reviewed-on: https://skia-review.googlesource.com/42522
Reviewed-by: Cary Clark <caryclark@skia.org>
Commit-Queue: Cary Clark <caryclark@skia.org>
2017-09-14 16:05:21 +00:00
Joe Gregorio
a71e2ef412 Remove examples of now removed SkArcToPathEffect.
SkArcToPathEffect was removed in: https://skia-review.googlesource.com/25981

No-Try: true
Docs-Preview: https://skia.org/?cl=35442
Bug: skia:
Change-Id: I8fefa6730d8f1d3fdc5516d46ef706052d84b6bf
Reviewed-on: https://skia-review.googlesource.com/35442
Reviewed-by: Ben Wagner <benjaminwagner@google.com>
Commit-Queue: Joe Gregorio <jcgregorio@google.com>
2017-08-16 18:38:15 +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
Mike Reed
36015ab796 remove SkXfermode from api dox -- it is gone
NOTRY=true
DOCS_PREVIEW= https://skia.org/?cl=16868
Bug: skia:1312
Change-Id: I28aafb80bcad0f3a810ca0b08caa15b70707b4a1
Reviewed-on: https://skia-review.googlesource.com/16868
Reviewed-by: Heather Miller <hcm@google.com>
Commit-Queue: Mike Reed <reed@google.com>
2017-05-15 14:24:02 +00:00
Mike Klein
efaad3cd53 Remove SkColorCubeFilter. It is unused.
Change-Id: Iec5fc759e331de24caea1347f9510917260d379b
Reviewed-on: https://skia-review.googlesource.com/7363
Reviewed-by: Mike Reed <reed@google.com>
Commit-Queue: Mike Klein <mtklein@chromium.org>
2017-01-21 15:09:31 +00:00
Joe Gregorio
6a4cdb6ba9 Remove documentation about emboss.
BUG=skia:

NOTRY=true
DOCS_PREVIEW= https://skia.org/?cl=5708

Change-Id: Iac133df3778061509f5754aa6a742cebc2ab6ba6
Reviewed-on: https://skia-review.googlesource.com/5708
Reviewed-by: Mike Reed <reed@google.com>
Reviewed-by: Heather Miller <hcm@google.com>
Commit-Queue: Joe Gregorio <jcgregorio@google.com>
2016-12-08 21:07:46 +00:00
borenet
777ee88129 Make the housekeeper upload doxygen to a newer bucket
BUG=skia:2969
GOLD_TRYBOT_URL= https://gold.skia.org/search?issue=2370153003
DOCS_PREVIEW= https://skia.org/?cl=2370153003

Review-Url: https://codereview.chromium.org/2370153003
2016-10-04 13:23:57 -07: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