fix links and missing constructor
Docs-Preview: https://skia.org/?cl=31145 Bug: skia: 6898 Change-Id: Ic94a15551f3683d9de5d3bda53394d2efce0d6a4 Reviewed-on: https://skia-review.googlesource.com/31145 Commit-Queue: Cary Clark <caryclark@skia.org> Reviewed-by: Cary Clark <caryclark@skia.org>
This commit is contained in:
parent
6f08ece37f
commit
4c06f5ee08
@ -67,7 +67,7 @@ when no Surface is required, and some helpers implicitly create Raster_Surface.
|
||||
# # description ##
|
||||
#Legend ##
|
||||
# SkCanvas() # No Surface, no dimensions. ##
|
||||
# SkCanvas(int width, int height, const SkSurfaceProps* = NULL) # No Surface, set dimensions, Surface_Properties. ##
|
||||
# SkCanvas(int width, int height, const SkSurfaceProps* props = NULL) # No Surface, set dimensions, Surface_Properties. ##
|
||||
# SkCanvas(SkBaseDevice* device) # Existing Device. (SkBaseDevice is private.) ##
|
||||
# SkCanvas(const SkBitmap& bitmap) # Uses existing Bitmap. ##
|
||||
# SkCanvas(const SkBitmap& bitmap, const SkSurfaceProps& props) # Uses existing Bitmap and Surface_Properties. ##
|
||||
|
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -2,32 +2,32 @@ usingBookmaker
|
||||
===
|
||||
|
||||
# <a name="Bookmaker"></a> Bookmaker
|
||||
How to use the <a href="bmh_usingBookmaker?cl=9919#Bookmaker">Bookmaker</a> utility.
|
||||
How to use the <a href="usingBookmaker#Bookmaker">Bookmaker</a> utility.
|
||||
|
||||
Get the fiddle command line interface tool.
|
||||
|
||||
<pre style="padding: 1em 1em 1em 1em;width: 44em; background-color: #f0f0f0">
|
||||
$ go get go.skia.org/infra/fiddle/go/fiddlecli</pre>
|
||||
|
||||
Build <a href="bmh_usingBookmaker?cl=9919#Bookmaker">Bookmaker</a>.
|
||||
Build <a href="usingBookmaker#Bookmaker">Bookmaker</a>.
|
||||
|
||||
<pre style="padding: 1em 1em 1em 1em;width: 44em; background-color: #f0f0f0">
|
||||
$ ninja -<a href="bmh_usingBookmaker?cl=9919#C">C</a> out/dir bookmaker</pre>
|
||||
$ ninja -<a href="usingBookmaker#C">C</a> out/dir bookmaker</pre>
|
||||
|
||||
Generate an starter <a href="bmh_usingBookmaker?cl=9919#Bookmaker">Bookmaker</a> file from an existing include.
|
||||
This writes <a href="bmh_usingBookmaker?cl=9919#SkXXX">SkXXX</a>.bmh in the current directory, which is
|
||||
Generate an starter <a href="usingBookmaker#Bookmaker">Bookmaker</a> file from an existing include.
|
||||
This writes <a href="usingBookmaker#SkXXX">SkXXX</a>.bmh in the current directory, which is
|
||||
out/dir/obj/ from an IDE.
|
||||
|
||||
<pre style="padding: 1em 1em 1em 1em;width: 44em; background-color: #f0f0f0">
|
||||
$ ./out/dir/bookmaker -t -i include/core/<a href="bmh_usingBookmaker?cl=9919#SkXXX">SkXXX</a>.h</pre>
|
||||
$ ./out/dir/bookmaker -t -i include/core/<a href="usingBookmaker#SkXXX">SkXXX</a>.h</pre>
|
||||
|
||||
Copy <a href="bmh_usingBookmaker?cl=9919#SkXXX">SkXXX</a>.bmh to docs.
|
||||
Use your favorite editor to fill out docs/<a href="bmh_usingBookmaker?cl=9919#SkXXX">SkXXX</a>.bmh.
|
||||
Copy <a href="usingBookmaker#SkXXX">SkXXX</a>.bmh to docs.
|
||||
Use your favorite editor to fill out docs/<a href="usingBookmaker#SkXXX">SkXXX</a>.bmh.
|
||||
|
||||
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.
|
||||
If you run <a href="bmh_usingBookmaker?cl=9919#Bookmaker">Bookmaker</a> inside <a href="bmh_usingBookmaker?cl=9919#Visual_Studio">Visual Studio</a>, you can click on errors and it
|
||||
If you run <a href="usingBookmaker#Bookmaker">Bookmaker</a> inside <a href="usingBookmaker#Visual_Studio">Visual Studio</a>, you can click on errors and it
|
||||
will take you to the source line in question.
|
||||
|
||||
<pre style="padding: 1em 1em 1em 1em;width: 44em; background-color: #f0f0f0">
|
||||
@ -39,10 +39,10 @@ Errors are contained by the output but aren't reported yet.
|
||||
<pre style="padding: 1em 1em 1em 1em;width: 44em; background-color: #f0f0f0">
|
||||
$ $GOPATH/bin/fiddlecli --input fiddle.json --output fiddleout.json</pre>
|
||||
|
||||
Generate <a href="bmh_usingBookmaker?cl=9919#bmh_SkXXX">bmh SkXXX</a>.md from <a href="bmh_usingBookmaker?cl=9919#SkXXX">SkXXX</a>.bmh and fiddleout.json.
|
||||
Generate <a href="usingBookmaker#bmh_SkXXX">bmh SkXXX</a>.md from <a href="usingBookmaker#SkXXX">SkXXX</a>.bmh and fiddleout.json.
|
||||
Error checking includes: undefined references, fiddle compiler errors,
|
||||
missing or mismatched printf output.
|
||||
Again, you can click on any errors inside <a href="bmh_usingBookmaker?cl=9919#Visual_Studio">Visual Studio</a>.
|
||||
Again, you can click on any errors inside <a href="usingBookmaker#Visual_Studio">Visual Studio</a>.
|
||||
|
||||
<pre style="padding: 1em 1em 1em 1em;width: 44em; background-color: #f0f0f0">
|
||||
$ ./out/dir/bookmaker -r site/user/api -b docs -f fiddleout.json</pre>
|
||||
@ -52,14 +52,14 @@ Check to see if it is up to date.
|
||||
This reports if a method no longer exists or its parameters have changed.
|
||||
|
||||
<pre style="padding: 1em 1em 1em 1em;width: 44em; background-color: #f0f0f0">
|
||||
$ ./out/dir/bookmaker -x -b docs/<a href="bmh_usingBookmaker?cl=9919#SkXXX">SkXXX</a>.bmh -i include/core/<a href="bmh_usingBookmaker?cl=9919#SkXXX">SkXXX</a>.h</pre>
|
||||
$ ./out/dir/bookmaker -x -b docs/<a href="usingBookmaker#SkXXX">SkXXX</a>.bmh -i include/core/<a href="usingBookmaker#SkXXX">SkXXX</a>.h</pre>
|
||||
|
||||
Generate an updated include header.
|
||||
This writes the updated <a href="bmh_undocumented?cl=9919#SkXXX.h">SkXXX.h</a> to the current directory.
|
||||
This writes the updated <a href="undocumented#SkXXX.h">SkXXX.h</a> to the current directory.
|
||||
|
||||
<pre style="padding: 1em 1em 1em 1em;width: 44em; background-color: #f0f0f0">
|
||||
$ ./out/dir/bookmaker -p -b docs -i include/core/<a href="bmh_usingBookmaker?cl=9919#SkXXX">SkXXX</a>.h</pre>
|
||||
$ ./out/dir/bookmaker -p -b docs -i include/core/<a href="usingBookmaker#SkXXX">SkXXX</a>.h</pre>
|
||||
|
||||
## <a name="Bugs"></a> Bugs
|
||||
|
||||
<a href="bmh_usingBookmaker?cl=9919#Bookmaker">Bookmaker</a> bugs are trackedherebug.skia.org/6898.
|
||||
<a href="usingBookmaker#Bookmaker">Bookmaker</a> bugs are trackedherebug.skia.org/6898.
|
||||
|
@ -90,6 +90,9 @@ string MdOut::addReferences(const char* refStart, const char* refEnd,
|
||||
}
|
||||
if (!foundMatch) {
|
||||
if (!(def = this->isDefined(t, fullRef, true))) {
|
||||
if (!result.size()) {
|
||||
t.reportError("missing method");
|
||||
}
|
||||
return result;
|
||||
}
|
||||
ref = fullRef;
|
||||
@ -406,7 +409,6 @@ const Definition* MdOut::isDefined(const TextParser& parser, const string& ref,
|
||||
if (string::npos != ref.find("_Private")) {
|
||||
return nullptr;
|
||||
}
|
||||
SkDebugf("");
|
||||
}
|
||||
if ('f' == ref[0]) {
|
||||
// FIXME : find def associated with prior, e.g.: r.fX where 'SkPoint r' was earlier
|
||||
@ -504,8 +506,7 @@ string MdOut::linkRef(const string& leadingSpaces, const Definition* def,
|
||||
while (start > 0 && (isalnum(filename[start - 1]) || '_' == filename[start - 1])) {
|
||||
--start;
|
||||
}
|
||||
buildup = "bmh_" + filename.substr(start) + "?cl=9919#"
|
||||
+ (classMatch ? namePart : *str);
|
||||
buildup = filename.substr(start) + "#" + (classMatch ? namePart : *str);
|
||||
str = &buildup;
|
||||
}
|
||||
string refOut(ref);
|
||||
|
Loading…
Reference in New Issue
Block a user