Commit Graph

695 Commits

Author SHA1 Message Date
Kevin Lubick
9590f86e89 Add a k8s cheat sheet to trooper docs
No-Try: true
Docs-Preview: https://skia.org/?cl=190201
Bug: skia:
Change-Id: Idd7d1838a648e1e73d76720dc07bd425ff7929a3
Reviewed-on: https://skia-review.googlesource.com/c/190201
Reviewed-by: Joe Gregorio <jcgregorio@google.com>
Commit-Queue: Kevin Lubick <kjlubick@google.com>
2019-02-07 14:46:50 +00:00
Brian Osman
1345366c21 Update tracing docs slightly
Prioritize "Chrome Tracing", and rename it to not sound like it's
specific to Skia-in-Chrome. Also mention the 256 MB file size limit.
Include basic trace event example, and link to more thorough docs
in the code.

No-Try: true
Docs-Preview: https://skia.org/?cl=188306
Bug: skia:
Change-Id: I882f2a81dfcce33847029f0800b27baa2f98308d
Reviewed-on: https://skia-review.googlesource.com/c/188306
Auto-Submit: Brian Osman <brianosman@google.com>
Reviewed-by: Heather Miller <hcm@google.com>
Commit-Queue: Heather Miller <hcm@google.com>
2019-01-31 19:10:53 +00:00
Hal Canary
3026d4b1b8 SkDocument: use auto for MakeDocument().
A later CL will make this return a unique_ptr<SkDocument>.

Bug: skia:5972
Change-Id: Ie10d6c07d5f2524ecb71d906db0d37427827225d
Reviewed-on: https://skia-review.googlesource.com/c/181660
Reviewed-by: Hal Canary <halcanary@google.com>
Commit-Queue: Hal Canary <halcanary@google.com>
2019-01-17 19:16:28 +00:00
Mike Klein
98dea7b11c remove superfluous skia_vulkan_sdk
We don't actually need the SDK to build anymore.

If you previously set skia_vulkan_sdk or relied on VULKAN_SDK
in the environment, now set skia_use_vulkan = true instead.

We still need the linux_vulkan_sdk asset for Test/Perf bots.

Change-Id: I70ad9c5181ae61725b9dc25cc887dd0640beeed6
Reviewed-on: https://skia-review.googlesource.com/c/184065
Reviewed-by: Brian Salomon <bsalomon@google.com>
Commit-Queue: Mike Klein <mtklein@google.com>
2019-01-15 18:53:02 +00:00
Hal Canary
4ca9fa30ba SkPDF: unify Canon and Document
motivation:  The Document has become intrusive enough that we almost
always have a pointer to the Document on hand anyways.

Also: update document.

Also: forward declare more things in headers.

Also, don't try to clean up resources when abort() or close() is called.
It is easy enough for the client to delete the Document when done.

Change-Id: I21aeed37f26ba16d68af041d9317adf00e9a61f2
Reviewed-on: https://skia-review.googlesource.com/c/180646
Commit-Queue: Hal Canary <halcanary@google.com>
Reviewed-by: Herb Derby <herb@google.com>
2019-01-14 17:56:14 +00:00
Ned Nguyen
9716603f97 Update skia docs to stop referring to NeedsManualRebaseline
No-Try: true
Docs-Preview: https://skia.org/?cl=179782
Bug: chromium:621126
Change-Id: Iee8d6d86a5cda31d84d4ebe708c7f6fd9f80f78b
Reviewed-on: https://skia-review.googlesource.com/c/179782
Reviewed-by: Ben Wagner <bungeman@google.com>
Commit-Queue: Ben Wagner <bungeman@google.com>
2019-01-11 17:14:06 +00:00
Joe Gregorio
980b231f57 Add link to general Google privacy policy.
No-Try: true
Docs-Preview: https://skia.org/?cl=182448
Bug: skia:
Change-Id: I334cb6e66a62b1bb2631f7e806d48f75612020ea
Reviewed-on: https://skia-review.googlesource.com/c/182448
Auto-Submit: Joe Gregorio <jcgregorio@google.com>
Reviewed-by: Joe Gregorio <jcgregorio@google.com>
Commit-Queue: Joe Gregorio <jcgregorio@google.com>
2019-01-09 16:10:31 +00:00
Joe Gregorio
87f1b9426a skottie - Use our new skottie-inline-sk element.
No-Try: true
Docs-Preview: https://skia.org/?cl=181901
Bug: skia:
Change-Id: If9a2f8e7216ded0042c0bcb40798b2946f727261
Reviewed-on: https://skia-review.googlesource.com/c/181901
Reviewed-by: Joe Gregorio <jcgregorio@google.com>
Commit-Queue: Joe Gregorio <jcgregorio@google.com>
2019-01-08 13:51:04 +00:00
Joe Gregorio
0ae5f90985 Fix link in /dev/contrib.
No-Try: true
Docs-Preview: https://skia.org/?cl=181168
Bug: skia:8654
Change-Id: I409a9138c13937f9aac986fd68866862512be9dd
Reviewed-on: https://skia-review.googlesource.com/c/181168
Auto-Submit: Joe Gregorio <jcgregorio@google.com>
Reviewed-by: Joe Gregorio <jcgregorio@google.com>
Commit-Queue: Joe Gregorio <jcgregorio@google.com>
2019-01-04 15:16:06 +00:00
Hal Canary
aec8c7e280 Docs: fix @text_shadow, use blob, font.
No-Try: true
Change-Id: I3f60f3fb1036584fb5bb68428fa761f818003f63
Reviewed-on: https://skia-review.googlesource.com/c/180323
Reviewed-by: Hal Canary <halcanary@google.com>
Commit-Queue: Hal Canary <halcanary@google.com>
2018-12-28 19:42:29 +00:00
skia-bookmaker
bdfe3a3ee9 Update markdown files
Automatic commit by the Housekeeper-Nightly-Bookmaker bot.

TBR=rmistry@google.com
NO_MERGE_BUILDS

Change-Id: I8fd5167615717fe04c38cc7a317186ff3c0f9019
Reviewed-on: https://skia-review.googlesource.com/c/179780
Reviewed-by: <skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com>
Commit-Queue: <skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com>
2018-12-20 23:26:55 +00:00
Kevin Lubick
a6e3f6288c [canvaskit] use the live CDN version for the docs
Also update pathkit's page to use most recent version.

No-Try: true
Docs-Preview: https://skia.org/?cl=178920
Bug: skia:8584
Change-Id: I53b58b12c937b78ffd0a527b8ca5080bd2e3f156
Reviewed-on: https://skia-review.googlesource.com/c/178920
Reviewed-by: Kevin Lubick <kjlubick@google.com>
2018-12-18 13:39:52 +00:00
Mike Klein
5e276a6376 remove old docs
- c++11.md isn't really needed any more
  - flatten.md makes reference to code that doesn't exist
  - simd.md describes a whole system that doesn't exist
  - color.md explains a model that's fundamentally different
    to how color correction works in Skia now

Change-Id: Ib09678190d04a0dcf44eadf13c617d488307332b
Reviewed-on: https://skia-review.googlesource.com/c/178080
Reviewed-by: Heather Miller <hcm@google.com>
Commit-Queue: Mike Klein <mtklein@google.com>
2018-12-17 16:20:20 +00:00
Leon Scroggins III
1be2d421ce Update Robocop docs for skia-android-triage
Instead of looking at open Skia bugs, which may already be assigned or
have lower priority, the Robocop should be looking at open bugs assigned
to skia-android-triage. New bugs will typically (though not always) be
assigned to this new alias.

No-Try: true
Docs-Preview: https://skia.org/?cl=177889
Change-Id: Ifa006bfda5ad46f37e8e23ee80a7ee1caad8b915
Reviewed-on: https://skia-review.googlesource.com/c/177889
Reviewed-by: Derek Sollenberger <djsollen@google.com>
Commit-Queue: Leon Scroggins <scroggo@google.com>
2018-12-17 15:15:18 +00:00
Kevin Lubick
8e4a331c8a [canvaskit] Canvas API for loading fonts
There's the barest hint of a "font manager" here.
Basically, nothing smart to deal with bold or fallbacks.

Maybe one day, we'll expose
SkTypeface* matchStyleCSS3(const SkFontStyle& pattern);

and do smart things for fallbacks, but for now that's not
in the immediate future.

Docs-Preview: https://skia.org/?cl=177067
Bug: skia:
Change-Id: Iaeabcbf5ff4511a01b37c16c983e447c25b0e3e7
Reviewed-on: https://skia-review.googlesource.com/c/177067
Reviewed-by: Ben Wagner <bungeman@google.com>
2018-12-14 21:32:21 +00:00
skia-bookmaker
59c9f1595e Update markdown files
Automatic commit by the Housekeeper-Nightly-Bookmaker bot.

TBR=rmistry@google.com
NO_MERGE_BUILDS

Change-Id: I93323b54068cf900fde307be8e2f9a2a73d3e387
Reviewed-on: https://skia-review.googlesource.com/c/177741
Reviewed-by: <skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com>
Commit-Queue: <skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com>
2018-12-14 06:32:44 +00:00
skia-bookmaker
a69b103129 Update markdown files
Automatic commit by the Housekeeper-Nightly-Bookmaker bot.

TBR=rmistry@google.com
NO_MERGE_BUILDS

Change-Id: Ic8c33e6519a55b6b9d1b28b90960bd99df29b7c4
Reviewed-on: https://skia-review.googlesource.com/c/177176
Reviewed-by: <skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com>
Commit-Queue: <skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com>
2018-12-13 06:26:16 +00:00
Brian Osman
044044f5a2 Update win_toolchain, and refactor how it's built
The old win_toolchain script required a Chromium checkout, and
extracted portions of the win_toolchain from that to build the
Skia asset. Instead, use the depot_tools script that assembles
a toolchain from a locally installed MSVC.

The create script doesn't do that, but relies on the user to
run that script first. Automating everything would be a nice
follow-up.

With the new strategy, the toolchain directory is simpler, and
no longer contains the depot_tools kruft or extra directories.
Adjust the bot scripts accordingly. (Renaming the directory to
win_toolchain from 't' would be a nice touch, too).

Finally, I built the new toolchain with the updated process,
and included the ARM64 compiler and libraries, so we can set
up a bot to build Windows ARM64.

Docs-Preview: https://skia.org/?cl=176968
Bug: skia:8569
Change-Id: I4bdf3cfb29d50f4464853445d0226241e70c33b4
Reviewed-on: https://skia-review.googlesource.com/c/176968
Reviewed-by: Mike Klein <mtklein@google.com>
Reviewed-by: Eric Boren <borenet@google.com>
Commit-Queue: Brian Osman <brianosman@google.com>
2018-12-12 15:50:16 +00:00
skia-bookmaker
9cabb4f98e Update markdown files
Automatic commit by the Housekeeper-Nightly-Bookmaker bot.

TBR=rmistry@google.com
NO_MERGE_BUILDS

Change-Id: I365c56af7fd227cb5dd9cfd47261284ce9c18bd2
Reviewed-on: https://skia-review.googlesource.com/c/176342
Reviewed-by: <skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com>
Commit-Queue: <skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com>
2018-12-11 06:17:45 +00:00
Brian Osman
13b2770513 Add minimal documentation about Windows on ARM64
No-Try: true
Docs-Preview: https://skia.org/?cl=175994
Bug: skia:8569
Change-Id: I9afa9aa6b7293f751db8c43996a82aff1aafbf2d
Reviewed-on: https://skia-review.googlesource.com/c/175994
Commit-Queue: Brian Osman <brianosman@google.com>
Reviewed-by: Mike Klein <mtklein@google.com>
2018-12-10 17:07:56 +00:00
Cary Clark
1c23557b6e bookmaker nightly fix
replace SkPaint::kGlyphID_TextEncoding with kGlyphID_SkTextEncoding

NOTRY=true
TBR=reed@google.com

Docs-Preview: https://skia.org/?cl=175340
Bug: skia:
Change-Id: I5835bf2d45969b727d9c895d34d7adb7c15b251c
Reviewed-on: https://skia-review.googlesource.com/c/175340
Commit-Queue: Cary Clark <caryclark@skia.org>
Auto-Submit: Cary Clark <caryclark@skia.org>
Reviewed-by: Cary Clark <caryclark@skia.org>
2018-12-06 18:03:08 +00:00
Cary Clark
3e73dcf24b fix bookmaker
Move some documentation from SkPaint_Reference.bmh to
SkFont_Reference.bmh. Since the legacy routines are still
in SkPaint.h (and not yet marked as deprecated) duplicate
much of it for now.

This get bookmaker running without error, but the generated
documentation is not organized.

TBR=reed@google.com,bungeman@google.com

Docs-Preview: https://skia.org/?cl=175241
Bug: skia:
Change-Id: I31e7dff425e8c0bbac0179a1f3546fbc38fc4504
Reviewed-on: https://skia-review.googlesource.com/c/175241
Commit-Queue: Cary Clark <caryclark@skia.org>
Reviewed-by: Cary Clark <caryclark@skia.org>
2018-12-06 14:52:27 +00:00
Cary Clark
8afaa1ef2d fix operator const links
Replaced crutch "_const" with " const" in docs
but missed one place to look for " const" after
operator method.

TBR=reed@google.com

Docs-Preview: https://skia.org/?cl=174587
Bug: skia:
Change-Id: I62cda5ab64aa419d0da028be17e1d751fbf2100a
Reviewed-on: https://skia-review.googlesource.com/c/174587
Commit-Queue: Cary Clark <caryclark@skia.org>
Auto-Submit: Cary Clark <caryclark@skia.org>
Reviewed-by: Cary Clark <caryclark@skia.org>
2018-12-05 17:08:03 +00:00
Cary Clark
6ddeaa4af0 fix word-like functions links in docs
Functions like SkRegion::intersects() have words 'intersects'
which are both function references and English. If injected
by #Populate, and if followed by a '(', make sure to look
for 'intersects()' to create a link to the function instead
of treating it as a permissable spelling word.

TBR=reed@google.com

Docs-Preview: https://skia.org/?cl=174582
Bug: skia:
Change-Id: I08c346e6888226197f269ecaa0eed5f4b3915344
Reviewed-on: https://skia-review.googlesource.com/c/174582
Commit-Queue: Cary Clark <caryclark@skia.org>
Auto-Submit: Cary Clark <caryclark@skia.org>
Reviewed-by: Cary Clark <caryclark@skia.org>
2018-12-05 16:05:06 +00:00
skia-bookmaker
fe47c2a60c Update markdown files
Automatic commit by the Housekeeper-Nightly-Bookmaker bot.

TBR=rmistry@google.com
NO_MERGE_BUILDS

Change-Id: I5cbd493c883fb1d65212edc22c1b5258d90a2d3f
Reviewed-on: https://skia-review.googlesource.com/c/174165
Commit-Queue: <skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com>
Reviewed-by: <skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com>
2018-12-04 06:38:29 +00:00
Kevin Lubick
7a1b845f2f [canvaskit] remove POC Nima code
Now that drawVertices is exposed, no need to keep this around as a demo

Docs-Preview: https://skia.org/?cl=173994
Bug: skia:
Change-Id: I6293c8e2038ece27635d254db097e651c9d77a94
Reviewed-on: https://skia-review.googlesource.com/c/173994
Reviewed-by: Kevin Lubick <kjlubick@google.com>
2018-12-03 19:31:09 +00:00
Cary Clark
5b671c300d add breaktext doc skeleton
copy paragraph from paint, add empty
example to docs. Fixes bot

TBR=reed@google.com

Docs-Preview: https://skia.org/?cl=173771
Bug: skia:
Change-Id: I4a79f7f8f32f860d0390dbce44669e03bb3a281e
Reviewed-on: https://skia-review.googlesource.com/c/173771
Commit-Queue: Cary Clark <caryclark@skia.org>
Auto-Submit: Cary Clark <caryclark@skia.org>
Reviewed-by: Cary Clark <caryclark@skia.org>
2018-12-03 10:18:06 +00:00
skia-bookmaker
28ce5f269f Update markdown files
Automatic commit by the Housekeeper-Nightly-Bookmaker bot.

TBR=rmistry@google.com
NO_MERGE_BUILDS

Change-Id: Ib0e4a097ec2cc7dbc9a92d576cea0e346c7ced6b
Reviewed-on: https://skia-review.googlesource.com/c/173844
Commit-Queue: <skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com>
Reviewed-by: <skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com>
2018-12-03 07:38:03 +00:00
skia-bookmaker
6894f22de2 Update markdown files
Automatic commit by the Housekeeper-Nightly-Bookmaker bot.

TBR=rmistry@google.com
NO_MERGE_BUILDS

Change-Id: I7a5ababc8dab41c2f1c89b22e3387c4a9a377091
Reviewed-on: https://skia-review.googlesource.com/c/173841
Commit-Queue: <skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com>
Reviewed-by: <skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com>
2018-12-02 06:25:06 +00:00
Brian Salomon
2335644771 Fix occurrences of "-Wextra-semi-stmt"
Docs-Preview: https://skia.org/?cl=173761
Change-Id: Iefdb91cd28eabb4b01b7b42a4f300b0b4caf05d9
Reviewed-on: https://skia-review.googlesource.com/c/173761
Reviewed-by: Mike Klein <mtklein@google.com>
Commit-Queue: Brian Salomon <bsalomon@google.com>
2018-11-30 23:23:09 +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
skia-bookmaker
275e8750e3 Update markdown files
Automatic commit by the Housekeeper-Nightly-Bookmaker bot.

TBR=rmistry@google.com
NO_MERGE_BUILDS

Change-Id: I159ed93931b616b36ae9fb7e64ed8e645b68f4a0
Reviewed-on: https://skia-review.googlesource.com/c/173345
Reviewed-by: <skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com>
Commit-Queue: <skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com>
2018-11-29 06:30:11 +00:00
skia-bookmaker
e5d244c68a Update markdown files
Automatic commit by the Housekeeper-Nightly-Bookmaker bot.

TBR=rmistry@google.com
NO_MERGE_BUILDS

Change-Id: I4086295ae9981f4febd76d4d5d7fccddf0e21f23
Reviewed-on: https://skia-review.googlesource.com/c/173035
Reviewed-by: <skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com>
Commit-Queue: <skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com>
2018-11-27 06:18:47 +00:00
skia-bookmaker
53079c3c11 Update markdown files
Automatic commit by the Housekeeper-Nightly-Bookmaker bot.

TBR=rmistry@google.com
NO_MERGE_BUILDS

Change-Id: Ifb4b974f27dcf346f2ead85f6142963eb5ce8140
Reviewed-on: https://skia-review.googlesource.com/c/172760
Commit-Queue: <skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com>
Reviewed-by: <skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com>
2018-11-25 04:27:28 +00:00
skia-bookmaker
724d5dd8a3 Update markdown files
Automatic commit by the Housekeeper-Nightly-Bookmaker bot.

TBR=rmistry@google.com
NO_MERGE_BUILDS

Change-Id: I018eedf6cb28518656d1578f71f1f2d60a1fbdd7
Reviewed-on: https://skia-review.googlesource.com/c/172561
Commit-Queue: <skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com>
Reviewed-by: <skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com>
2018-11-22 06:03:05 +00:00
Cary Clark
e9c5a15993 fix bookmaker
Mark experimental method in SkCanvas as "Experimental" in its
comment. Maybe it should be enough to name the routine experimental_...
but for now bookmaker requires the comment to say that as well.

Change the TextIntercept examples to #NoExample.

TBR=reed@google.com,bsalomon@google.com

Docs-Preview: https://skia.org/?cl=172402
Bug: skia:
Change-Id: Id74b59e141d5002a8b6118ca28cb9c62a36e2f02
Reviewed-on: https://skia-review.googlesource.com/c/172402
Reviewed-by: Cary Clark <caryclark@skia.org>
Reviewed-by: Brian Salomon <bsalomon@google.com>
Commit-Queue: Cary Clark <caryclark@skia.org>
2018-11-21 19:15:59 +00:00
Kevin Lubick
6fccc9db67 [canvaskit] Add debug-mode only logs
And a fix for node.

Docs-Preview: https://skia.org/?cl=172143
Bug: skia:
Change-Id: I519c2693b386aa68655f235281d932ee5fffbc61
Reviewed-on: https://skia-review.googlesource.com/c/172143
Reviewed-by: Kevin Lubick <kjlubick@google.com>
2018-11-20 22:22:04 +00:00
Brian Salomon
343063f338 Add docs about building with clang-cl on Windows.
No-Try: true
Docs-Preview: https://skia.org/?cl=172061
Change-Id: I509ca82707324b49e3c439c0c07a8091ceaf374c
Reviewed-on: https://skia-review.googlesource.com/c/172061
Commit-Queue: Brian Salomon <bsalomon@google.com>
Reviewed-by: Mike Klein <mtklein@google.com>
Reviewed-by: Brian Osman <brianosman@google.com>
2018-11-20 16:25:04 +00:00
skia-bookmaker
8be4196e48 Update markdown files
Automatic commit by the Housekeeper-Nightly-Bookmaker bot.

TBR=rmistry@google.com
NO_MERGE_BUILDS

Change-Id: Ib7eeec0e2e5c71dad3e683446ef67878a4723028
Reviewed-on: https://skia-review.googlesource.com/c/171953
Commit-Queue: <skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com>
Reviewed-by: <skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com>
2018-11-20 06:00:05 +00:00
skia-bookmaker
73b4a1f572 Update markdown files
Automatic commit by the Housekeeper-Nightly-Bookmaker bot.

TBR=rmistry@google.com
NO_MERGE_BUILDS

Change-Id: I925a3b021af1a1f0df0e3e019c659879c3499137
Reviewed-on: https://skia-review.googlesource.com/c/171690
Commit-Queue: <skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com>
Reviewed-by: <skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com>
2018-11-17 06:15:59 +00:00
Cary Clark
fd32e724d6 bookmaker error handling
Bookmaker will generate instructions on how to
fix detected errors in a few cases:
- if class function is missing description
- if global function is missing description
- if function parameters don't match doxygen
- if function parameters don't match bmh

(The last case above won't happen if bmh #Method
uses #Populate to retrieve parameter descriptions
from the include.)

Adding this revealed that globals weren't always
accounted for in bookmaker's cross-check; fix
that as well.

TBR=reed@google.com
Docs-Preview: https://skia.org/?cl=171224
Bug: skia:
Change-Id: Ic1b41d4722954fa8a42685a8fe7266b8a860c362
Reviewed-on: https://skia-review.googlesource.com/c/171224
Reviewed-by: Cary Clark <caryclark@skia.org>
Commit-Queue: Cary Clark <caryclark@skia.org>
Auto-Submit: Cary Clark <caryclark@skia.org>
2018-11-16 20:30:18 +00:00
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
Ben Wagner
bb9844ef69 Add client code search to docs.
Also, history seems to be available for internal code search.

No-Try: true
Docs-Preview: https://skia.org/?cl=171003
Change-Id: I13707664b88e3d84760f11f43d2bd7c35c2a8969
Reviewed-on: https://skia-review.googlesource.com/c/171003
Commit-Queue: Ben Wagner <benjaminwagner@google.com>
Commit-Queue: Joe Gregorio <jcgregorio@google.com>
Auto-Submit: Ben Wagner <benjaminwagner@google.com>
Reviewed-by: Joe Gregorio <jcgregorio@google.com>
2018-11-14 17:37:44 +00:00
skia-bookmaker
b45b53f01c Update markdown files
Automatic commit by the Housekeeper-Nightly-Bookmaker bot.

TBR=rmistry@google.com
NO_MERGE_BUILDS

Change-Id: I53cfa8794ddfc5fd1045be62b4ea58afeeec5814
Reviewed-on: https://skia-review.googlesource.com/c/170943
Commit-Queue: <skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com>
Reviewed-by: <skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com>
2018-11-14 05:58:57 +00:00
skia-bookmaker
1e1ba0e017 Update markdown files
Automatic commit by the Housekeeper-Nightly-Bookmaker bot.

TBR=rmistry@google.com
NO_MERGE_BUILDS

Change-Id: I59bbbbecafca34863cfaf269cbcc38d0d98b609d
Reviewed-on: https://skia-review.googlesource.com/c/170681
Reviewed-by: <skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com>
Commit-Queue: <skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com>
2018-11-13 06:00:58 +00:00
Cary Clark
8cc4cdc467 fix bookmaker
this fixes the build

The checked in code is tricky because bookmaker
doesn't understand the value of the #define
so doesn't know which side of the #ifdef is valid.

So it assumes it should have both.

But then there are two identical functions:

SkFontHinting getHinting() const
Hinting getHinting() const

since just like C, bookmaker can't uniquely
identify a function on its return type alone.

So to fix the build, the second one is commented out
bookmaker-style, using the lines mentioned below.

When legacy flags for hinting enum gets
re-landed, remove these lines to reenable
the documentation for SkFontHinting getHinting() const

" # Disable for now
" #ToDo no spelling errors
" ###$ block comment

" $$$# end of block comment
" #ToDo ##

TBR=reed@google.com

Docs-Preview: https://skia.org/?cl=170275
Bug: skia:
Change-Id: Ibc0e9fac48fd0b57524a35133306728e38b600d6
Reviewed-on: https://skia-review.googlesource.com/c/170275
Commit-Queue: Cary Clark <caryclark@skia.org>
Auto-Submit: Cary Clark <caryclark@skia.org>
Reviewed-by: Cary Clark <caryclark@skia.org>
2018-11-10 04:49:37 +00:00
Cary Clark
777eede780 fix bookmaker
Remove references to old SkPaint::Hinting.

Also fix bug recently introduced that made
unlinkable words use the last link found.

TBR=reed@google.com

Docs-Preview: https://skia.org/?cl=170266
Bug: skia:
Change-Id: I8b83bcb479bd3f79699a1c74818a817190fd42a5
Reviewed-on: https://skia-review.googlesource.com/c/170266
Commit-Queue: Cary Clark <caryclark@skia.org>
Auto-Submit: Cary Clark <caryclark@skia.org>
Reviewed-by: Cary Clark <caryclark@skia.org>
2018-11-09 21:33:54 +00:00
Cary Clark
4a23bbf823 fix doc paint hinting examples
Some references to the old hint enum
remained, so switch them over.

This fixes bookmaker nightly.

TBR=reed@google.com
NOTRY=true
Docs-Preview: https://skia.org/?cl=169825
Bug: skia:
Change-Id: I2d13ae85e6e14e3445a03e361a50e91bb3bdedd2
Reviewed-on: https://skia-review.googlesource.com/c/169825
Auto-Submit: Cary Clark <caryclark@skia.org>
Commit-Queue: Cary Clark <caryclark@skia.org>
Reviewed-by: Cary Clark <caryclark@skia.org>
2018-11-09 00:48:17 +00:00
skia-bookmaker
fe60bfb010 Update markdown files
Automatic commit by the Housekeeper-Nightly-Bookmaker bot.

TBR=rmistry@google.com
NO_MERGE_BUILDS

Change-Id: I289dc24d46bf77b08268ce9edbbf92b672702bfe
Reviewed-on: https://skia-review.googlesource.com/c/169885
Reviewed-by: <skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com>
Commit-Queue: Ravi Mistry <rmistry@google.com>
2018-11-08 23:52:39 +00:00
Cary Clark
885f10787b fix bookmaker
more strict bookmaker rules are now in effect;
all methods require documentation, and all documentation
is checked for accuracy.

In this case, the multiple temporary copies of SkPaint::getHinting
and SkPaint::setHinting are checked.

In an upcoming change, bookmaker will ignore symbols marked
as deprecated, experimental, or private; making this bookmaker's
strictness a little more palatable.

TBR=reed@google.com

Docs-Preview: https://skia.org/?cl=169822
Bug: skia:
Change-Id: If1bc079a13828a5ca435911338b9c75acbe8ad6f
Reviewed-on: https://skia-review.googlesource.com/c/169822
Commit-Queue: Cary Clark <caryclark@skia.org>
Commit-Queue: Mike Reed <reed@google.com>
Auto-Submit: Cary Clark <caryclark@skia.org>
Reviewed-by: Mike Reed <reed@google.com>
Reviewed-by: Cary Clark <caryclark@skia.org>
2018-11-08 19:02:39 +00:00