Commit Graph

20 Commits

Author SHA1 Message Date
Cary Clark
2be81cf973 Condense embedded formulas.
Bookmaker delimits formulas and equations to allow
representing variables and symbols without tripping
up reference lookup, spell checking, and comment
generation.

Before, formulas were represented with:
some text
#Formula
(x + y, 0)
##
, and more text

This made it difficult to know when spacing should
be preserved before and after the formula. Now,
formulas are represented with:
some text #Formula # (x + y, 0) ##, and more text

The presence or absence of a space between ## and ,
is now significant (before it was not).

Also, formulas are bracketed by <code> in markdown
generation, so that variables stand out better.
See:
https://skia.org/user/api/SkBlendMode_Reference?cl=152781#Dst_Out
for an example.

Also fixed 100 column offenders and added a code
check to identify them. For the moment, 100 column
offenders are outed with SkDebugf but their presence
does not cause bookmaker to fail.

TBR=caryclark@google.com

Docs-Preview: https://skia.org/?cl=152781
Bug: skia:6898
Change-Id: If92a65a234f5d616bf4485984a8d219a6f04821a
Reviewed-on: https://skia-review.googlesource.com/152781
Commit-Queue: Cary Clark <caryclark@skia.org>
Auto-Submit: Cary Clark <caryclark@skia.org>
Reviewed-by: Cary Clark <caryclark@skia.org>
2018-09-13 16:50:25 +00:00
Ravi Mistry
874e22b4ad Revert "Update markdown files"
This reverts commit a2af30e4b7.

Reason for revert: Was a test bot run

Original change's description:
> Update markdown files
> 
> Automatic commit by the Housekeeper-Nightly-Bookmaker bot.
> 
> TBR=rmistry@google.com
> NO_MERGE_BUILDS
> 
> Change-Id: I80fca2c841cb251ffba81b3c8a9fbfdc59335c1f
> Reviewed-on: https://skia-review.googlesource.com/142274
> Reviewed-by: <skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com>
> Commit-Queue: <skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com>

TBR=rmistry@google.com,skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com

Change-Id: I0d098d40451f5dc2b614b0ded732c6476a35dbdf
No-Presubmit: true
No-Tree-Checks: true
No-Try: true
Reviewed-on: https://skia-review.googlesource.com/142360
Reviewed-by: Ravi Mistry <rmistry@google.com>
Commit-Queue: Ravi Mistry <rmistry@google.com>
2018-07-19 03:49:23 +00:00
skia-bookmaker
a2af30e4b7 Update markdown files
Automatic commit by the Housekeeper-Nightly-Bookmaker bot.

TBR=rmistry@google.com
NO_MERGE_BUILDS

Change-Id: I80fca2c841cb251ffba81b3c8a9fbfdc59335c1f
Reviewed-on: https://skia-review.googlesource.com/142274
Reviewed-by: <skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com>
Commit-Queue: <skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com>
2018-07-18 23:42:02 +00:00
Cary Clark
8364706c02 correct bookmaker md files
Mysterious failures on the part of the bookmaker
bot corrupt the md files.

No-Try: true
Docs-Preview: https://skia.org/?cl=142173
Bug: skia:6818,skia:8151
Change-Id: Iab32e1a47d493b22cc78866f08b79399d983e139
TBR=jcgregario@google.com,rmistry@google.com
Reviewed-on: https://skia-review.googlesource.com/142173
Reviewed-by: Cary Clark <caryclark@google.com>
Commit-Queue: Cary Clark <caryclark@google.com>
Auto-Submit: Cary Clark <caryclark@google.com>
2018-07-18 20:28:52 +00:00
skia-bookmaker
66dac70719 Update markdown files
Automatic commit by the Housekeeper-Nightly-Bookmaker bot.

TBR=rmistry@google.com
NO_MERGE_BUILDS

Change-Id: Idb5886f2b9fe43df81bf0711fc8cac0e48edf187
Reviewed-on: https://skia-review.googlesource.com/142185
Commit-Queue: <skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com>
Reviewed-by: <skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com>
2018-07-18 17:11:01 +00:00
Cary Clark
a619d459b8 update generated md files
can't really tell what changed here
maybe lf style?

TBR=jcgregario@google.com

No-Try: true
Docs-Preview: https://skia.org/?cl=141461
Bug: skia:6818
Change-Id: I8ddce168b07751b6abdc7931e71613afbb74b872
Reviewed-on: https://skia-review.googlesource.com/141461
Commit-Queue: Cary Clark <caryclark@skia.org>
Auto-Submit: Cary Clark <caryclark@skia.org>
Reviewed-by: Cary Clark <caryclark@skia.org>
2018-07-16 12:16:36 +00:00
skia-bookmaker
e0a458f02f Update markdown files
Automatic commit by the Housekeeper-Nightly-Bookmaker bot.

TBR=rmistry@google.com
NO_MERGE_BUILDS

Change-Id: I03c2a6518b2bf7dd6972744d3184c20f513d23ed
Reviewed-on: https://skia-review.googlesource.com/141446
Commit-Queue: <skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com>
Reviewed-by: <skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com>
2018-07-16 06:00:06 +00:00
Cary Clark
390495eb8d fix bookmaker
make SkImage::makeColorSpace include match docs.

R=brianosman@google.com

Docs-Preview: https://skia.org/?cl=141086
Bug: skia:6818
Change-Id: Ica65effdd05c2d8d731d1d1773fb80798be0274b
Reviewed-on: https://skia-review.googlesource.com/141086
Commit-Queue: Cary Clark <caryclark@skia.org>
Commit-Queue: Robert Phillips <robertphillips@google.com>
Reviewed-by: Robert Phillips <robertphillips@google.com>
Reviewed-by: Cary Clark <caryclark@skia.org>
Auto-Submit: Cary Clark <caryclark@skia.org>
2018-07-13 14:06:24 +00:00
skia-bookmaker
12ce2cbab8 Update markdown files
Automatic commit by the Housekeeper-Nightly-Bookmaker bot.

TBR=rmistry@google.com
NO_MERGE_BUILDS

Change-Id: I753a92dce99acb1d6b64a92657cc103d99144c40
Reviewed-on: https://skia-review.googlesource.com/141139
Reviewed-by: <skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com>
Commit-Queue: <skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com>
2018-07-13 06:15:14 +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
skia-bookmaker
a391c72a20 Update markdown files
Automatic commit by the Housekeeper-Nightly-Bookmaker bot.

TBR=rmistry@google.com
NO_MERGE_BUILDS

Change-Id: Ifb3c285af3cb518cb372d7e4d8cc893cf1fb8a9b
Reviewed-on: https://skia-review.googlesource.com/139700
Commit-Queue: <skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com>
Reviewed-by: <skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com>
2018-07-09 05:52:44 +00:00
skia-bookmaker
a717ca970b Update markdown files
Automatic commit by the Housekeeper-Nightly-Bookmaker bot.

TBR=rmistry@google.com
NO_MERGE_BUILDS

Change-Id: Ibd504c4e4658dea629ec585df6485727c1163aec
Reviewed-on: https://skia-review.googlesource.com/139535
Reviewed-by: <skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com>
Commit-Queue: <skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com>
2018-07-08 05:56:12 +00:00
skia-bookmaker
dd962a95c5 Update markdown files
Automatic commit by the Housekeeper-Nightly-Bookmaker bot.

TBR=rmistry@google.com
NO_MERGE_BUILDS

Change-Id: I8bf0dccafeaeffbeb2f477229d2bef691e9b5fe9
Reviewed-on: https://skia-review.googlesource.com/139532
Reviewed-by: <skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com>
Commit-Queue: <skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com>
2018-07-07 05:58:01 +00:00
skia-bookmaker
44bad2e86a Update markdown files
Automatic commit by the Housekeeper-Nightly-Bookmaker bot.

TBR=rmistry@google.com
NO_MERGE_BUILDS

Change-Id: Iaae2223a7e928917ddfd0dc51c097ffbc986f85a
Reviewed-on: https://skia-review.googlesource.com/139382
Commit-Queue: <skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com>
Reviewed-by: <skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com>
2018-07-05 05:57:48 +00:00
skia-bookmaker
233c65202e Update markdown files
Automatic commit by the Housekeeper-Nightly-Bookmaker bot.

TBR=rmistry@google.com
NO_MERGE_BUILDS

Change-Id: I3e1b077686e625c0c69561532f1bc95155319340
Reviewed-on: https://skia-review.googlesource.com/139301
Reviewed-by: <skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com>
Commit-Queue: <skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com>
2018-07-04 05:56:47 +00:00
Ruiqi Mao
94d57c477f updated SkCanvas documentation for animation overloads of drawVertices
changed bookmaker ParserCommon::writeBlockTrim limit to 20000

disabled broken SkPaint::containsText example

Docs-Preview: https://skia.org/?cl=138862
Bug: skia:8123
Change-Id: Ib4003bf7b9603bf652f86cd56e0975cd09bcbf71
Reviewed-on: https://skia-review.googlesource.com/138862
Reviewed-by: Brian Osman <brianosman@google.com>
Commit-Queue: Brian Osman <brianosman@google.com>
2018-07-03 13:33:43 +00:00
Cary Clark
53498e973e fix blank catalog images
Some catalog images are blank because
the image wasn't selected in the fiddle
example.

Also continue to add documentation and
examples for SkRRect

R=caryclark@google.com
NOTRY=true

Docs-Preview: https://skia.org/?cl=138382
Bug: skia:6898
Change-Id: I282a14ffcbaf2f8383294724900960f5ba40a2aa
Reviewed-on: https://skia-review.googlesource.com/138382
Reviewed-by: Cary Clark <caryclark@skia.org>
Commit-Queue: Cary Clark <caryclark@skia.org>
Auto-Submit: Cary Clark <caryclark@skia.org>
2018-06-28 23:17:47 +00:00
Cary Clark
82f1f744f8 fix doc catalog
The doc catalog (the thing that allows graphical example searches)
got broken because bookmaker generated json names with linefeeds
in them.

Fix that and add an incremental update towards documenting SkRRect.

R=caryclark@google.com

Docs-Preview: https://skia.org/?cl=138020
Bug: skia:6898
Change-Id: I8e033d2d59fc9693f377be8c202bbf8ac9253b20
Reviewed-on: https://skia-review.googlesource.com/138020
Reviewed-by: Cary Clark <caryclark@skia.org>
Commit-Queue: Cary Clark <caryclark@skia.org>
Auto-Submit: Cary Clark <caryclark@skia.org>
2018-06-28 13:18:16 +00:00
skia-bookmaker
e97bb26893 Update markdown files
Automatic commit by the Housekeeper-Nightly-Bookmaker bot.

TBR=rmistry@google.com
NO_MERGE_BUILDS

Change-Id: I4176e8cb5de092e8bc8ca41b782bd0742ef504b5
Reviewed-on: https://skia-review.googlesource.com/138101
Commit-Queue: <skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com>
Reviewed-by: <skia-bookmaker@skia-swarming-bots.iam.gserviceaccount.com>
2018-06-28 05:50:16 +00:00
Cary Clark
224c700a1f sync docs up with tip of tree
Also check in work in progress for blend modes,
round rects, and a placeholder for pictures.

One minor include change to add a parameter name
for SkBlendMode function.

TBR=reed@google.com
R=caryclark@google.com

Docs-Preview: https://skia.org/?cl=134200
Bug: skia:6898
Change-Id: I5d2a9221d61edb32d9c7edbb3193401605b2b513
Reviewed-on: https://skia-review.googlesource.com/134200
Reviewed-by: Cary Clark <caryclark@google.com>
Reviewed-by: Cary Clark <caryclark@skia.org>
Commit-Queue: Cary Clark <caryclark@skia.org>
Auto-Submit: Cary Clark <caryclark@skia.org>
2018-06-27 15:47:45 +00:00