AuroraMiddleware/skia2
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update markdown files

Browse Source 
Automatic commit by the Housekeeper-Nightly-Bookmaker bot.

TBR=update-docs@skia.org
NO_MERGE_BUILDS

No-Tree-Checks: true
Change-Id: I954a88f5fdc11387f07d81d66cfd743803b3538e
Reviewed-on: https://skia-review.googlesource.com/84083
Commit-Queue: Update Docs <update-docs@skia.org>
Reviewed-by: Update Docs <update-docs@skia.org>
Reviewed-by: Cary Clark <caryclark@google.com>
Reviewed-by: Ravi Mistry <rmistry@google.com>
This commit is contained in:
Update Docs 2017-12-12 18:34:44 +00:00 committed by Skia Commit-Bot
parent 6df4befce6
commit a46f1ddd14
2 changed files with 30 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
site/user/api/SkCanvas_Reference.md
View File

@ -4496,7 +4496,7 @@ and so on; or nullptr</td>
### Example
<div><fiddle-embed name="773134f4fe127f9c9caa110c24c988dc"><div>The two leftmost <a href="#SkCanvas_drawBitmapLattice_bitmap">bitmap</a> draws has four corners and sides to the left and right of center.
<div><fiddle-embed name="7a02b16a4cc8158d88858a76907c9d89"><div>The two leftmost <a href="#SkCanvas_drawBitmapLattice_bitmap">bitmap</a> draws has four corners and sides to the left and right of center.
The leftmost <a href="#SkCanvas_drawBitmapLattice_bitmap">bitmap</a> draw scales the width of corners proportionately to fit.
The third and fourth draw corners are not scaled; the sides are scaled to
fill the remaining space; the center is transparent.
@ -4552,7 +4552,7 @@ and so on; or nullptr</td>
### Example
<div><fiddle-embed name="c52ee1d4c69363c6b109539c1da3ce83"><div>The leftmost <a href="#SkCanvas_drawImageLattice_image">image</a> is smaller than center; only corners are drawn, all scaled to fit.
<div><fiddle-embed name="75f43f11c6bd58175071b8b54ebec676"><div>The leftmost <a href="#SkCanvas_drawImageLattice_image">image</a> is smaller than center; only corners are drawn, all scaled to fit.
The second <a href="#SkCanvas_drawImageLattice_image">image</a> equals the size of center; only corners are drawn without scaling.
The remaining images are larger than center. All corners draw without scaling. The sides
are scaled if needed to take up the remaining space; the center is transparent.</div></fiddle-embed></div>

30
site/user/api/usingBookmaker.md
View File

@ -53,6 +53,16 @@ All structs, classes, enums, their members and methods, functions, and so on,
require descriptions. Most also require examples.
All methods and functions should include examples if practical.
It's difficult to think of a meaningful example for class destructors.
In cases like these, change the placeholder:
<pre style="padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0">
#Example</pre>
to:
<pre style="padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0">
#NoExample</pre>
Descriptions start with an active verb. Descriptions are complete, punctuated
sentences unless they describe parameters or return values. Parameters and
@ -60,8 +70,8 @@ returned values are described by phrases that start lower case and do not
include trailing punctuation.
Descriptions are not self-referential; they do not include the thing they
describe. Descriptions may contain upper case references to definitions
but otherwise should be free of jargon.
describe. Descriptions may contain upper case or camel case references to
definitions but otherwise should be free of jargon.
Descriptions may contain code and formulas, each bracketed by markup.
@ -76,6 +86,10 @@ an example, and any cross references.
Each method must contain either one or more examples or markup indicating
that there is no example.
After editing is complete, searching for "" should fail,
assuming "" is not the perfect word to use in a description or
example!
Generate fiddle.json from all examples, including the ones you just wrote.
Error checking is syntatic: starting keywords are closed, keywords have the
correct parents.
@ -113,6 +127,18 @@ $ ./out/dir/bookmaker -p -b docs -i include/core/<a href="usingBookmaker#SkXXX">
to write the updated <a href="undocumented#SkXXX.h">SkXXX.h</a> to the current directory.
Once adding the file is complete, add the file to status.json in the section. You may add it to the section during
development, or leave status.json unchanged.
If the new file has been added to status.json, you can run
any of the above commands with -a docs/status.json in place of
-b docs or -i includes.
Complete rebuilding of all bookmaker output looks like:
<pre style="padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0">
./ out/skia/bookmaker.exe -a docs/status.json -e fiddle.json</pre>
## <a name="Bugs"></a> Bugs
<a href="#Bookmaker">Bookmaker</a> bugs are trackedhere.