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

fix generated links

Browse Source 
qualify bookmaker links to remove
file reference if intra-file and
add class reference if part of
a class

TBR=caryclark@google.com
Docs-Preview: https://skia.org/?cl=38722
Bug: skia: 6898
Change-Id: Ie0548485a6e3f596efc0f15b819bd5060e983a5b
Reviewed-on: https://skia-review.googlesource.com/38722
Reviewed-by: Cary Clark <caryclark@skia.org>
Commit-Queue: Cary Clark <caryclark@skia.org>
This commit is contained in:
Cary Clark 2017-08-25 11:51:49 -04:00 committed by Skia Commit-Bot
parent 8296e752fa
commit 8cc16c7fde
6 changed files with 3992 additions and 3980 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

File diff suppressed because it is too large Load Diff

2056
site/user/api/SkPaint_Reference.md
View File

File diff suppressed because it is too large Load Diff

2700
site/user/api/SkPath_Reference.md
View File

File diff suppressed because it is too large Load Diff

76
site/user/api/undocumented.md
View File

@ -111,13 +111,13 @@ bool equalsWithinTolerance(const SkPoint& p) const
<table>
<tr>
<td><a name="SkBlendMode::kSrc"></a> <code><strong>SkBlendMode::kSrc </strong></code></td><td>1</td><td></td>
<td><a name="SkBlendMode_kSrc"> <code><strong>SkBlendMode::kSrc </strong></code> </a></td><td>1</td><td></td>
</tr>
<tr>
<td><a name="SkBlendMode::kSrcOver"></a> <code><strong>SkBlendMode::kSrcOver </strong></code></td><td>3</td><td></td>
<td><a name="SkBlendMode_kSrcOver"> <code><strong>SkBlendMode::kSrcOver </strong></code> </a></td><td>3</td><td></td>
</tr>
<tr>
<td><a name="SkBlendMode::kPlus"></a> <code><strong>SkBlendMode::kPlus </strong></code></td><td>12</td><td></td>
<td><a name="SkBlendMode_kPlus"> <code><strong>SkBlendMode::kPlus </strong></code> </a></td><td>12</td><td></td>
</tr>
</table>
@ -132,10 +132,10 @@ bool equalsWithinTolerance(const SkPoint& p) const
<table>
<tr>
<td><a name="SkClipOp::kDifference"></a> <code><strong>SkClipOp::kDifference </strong></code></td><td>0</td><td></td>
<td><a name="SkClipOp_kDifference"> <code><strong>SkClipOp::kDifference </strong></code> </a></td><td>0</td><td></td>
</tr>
<tr>
<td><a name="SkClipOp::kIntersect"></a> <code><strong>SkClipOp::kIntersect </strong></code></td><td>1</td><td></td>
<td><a name="SkClipOp_kIntersect"> <code><strong>SkClipOp::kIntersect </strong></code> </a></td><td>1</td><td></td>
</tr>
</table>
@ -191,19 +191,19 @@ int SkColorSetARGB(a, r, g, b)
<table>
<tr>
<td><a name="SK_ColorBLACK"></a> <code><strong>SK_ColorBLACK </strong></code></td><td>0xFF000000 </td><td></td>
<td><a name="SK_ColorBLACK"> <code><strong>SK_ColorBLACK </strong></code> </a></td><td>0xFF000000 </td><td></td>
</tr>
<tr>
<td><a name="SK_ColorBLUE"></a> <code><strong>SK_ColorBLUE </strong></code></td><td>0xFF0000FF </td><td></td>
<td><a name="SK_ColorBLUE"> <code><strong>SK_ColorBLUE </strong></code> </a></td><td>0xFF0000FF </td><td></td>
</tr>
<tr>
<td><a name="SK_ColorGREEN"></a> <code><strong>SK_ColorGREEN </strong></code></td><td>0xFF00FF00 </td><td></td>
<td><a name="SK_ColorGREEN"> <code><strong>SK_ColorGREEN </strong></code> </a></td><td>0xFF00FF00 </td><td></td>
</tr>
<tr>
<td><a name="SK_ColorRED"></a> <code><strong>SK_ColorRED </strong></code></td><td>0xFFFF0000 </td><td></td>
<td><a name="SK_ColorRED"> <code><strong>SK_ColorRED </strong></code> </a></td><td>0xFFFF0000 </td><td></td>
</tr>
<tr>
<td><a name="SK_ColorWHITE"></a> <code><strong>SK_ColorWHITE </strong></code></td><td>0xFFFFFFFF </td><td></td>
<td><a name="SK_ColorWHITE"> <code><strong>SK_ColorWHITE </strong></code> </a></td><td>0xFFFFFFFF </td><td></td>
</tr>
</table>
@ -256,7 +256,7 @@ void draw(SkCanvas*, const SkMatrix* = NULL)
# <a name="SkRasterHandleAllocator"></a> Class SkRasterHandleAllocator
# <a name="SkRasterHandleAllocator::Rec"></a> Struct SkRasterHandleAllocator::Rec
# <a name="SkRasterHandleAllocator_Rec"></a> Struct SkRasterHandleAllocator::Rec
<a name="MakeCanvas"></a>
## MakeCanvas
@ -278,16 +278,16 @@ static std::unique_ptr<SkCanvas>
<table>
<tr>
<td><a name="kNone_SkFilterQuality"></a> <code><strong>kNone_SkFilterQuality </strong></code></td><td>0</td><td></td>
<td><a name="kNone_SkFilterQuality"> <code><strong>kNone_SkFilterQuality </strong></code> </a></td><td>0</td><td></td>
</tr>
<tr>
<td><a name="kLow_SkFilterQuality"></a> <code><strong>kLow_SkFilterQuality </strong></code></td><td>1</td><td></td>
<td><a name="kLow_SkFilterQuality"> <code><strong>kLow_SkFilterQuality </strong></code> </a></td><td>1</td><td></td>
</tr>
<tr>
<td><a name="kMedium_SkFilterQuality"></a> <code><strong>kMedium_SkFilterQuality </strong></code></td><td>2</td><td></td>
<td><a name="kMedium_SkFilterQuality"> <code><strong>kMedium_SkFilterQuality </strong></code> </a></td><td>2</td><td></td>
</tr>
<tr>
<td><a name="kHigh_SkFilterQuality"></a> <code><strong>kHigh_SkFilterQuality </strong></code></td><td>3</td><td></td>
<td><a name="kHigh_SkFilterQuality"> <code><strong>kHigh_SkFilterQuality </strong></code> </a></td><td>3</td><td></td>
</tr>
</table>
@ -316,7 +316,7 @@ static std::unique_ptr<SkCanvas>
<table>
<tr>
<td><a name="kPremul_SkAlphaType"></a> <code><strong>kPremul_SkAlphaType </strong></code></td><td>2</td><td></td>
<td><a name="kPremul_SkAlphaType"> <code><strong>kPremul_SkAlphaType </strong></code> </a></td><td>2</td><td></td>
</tr>
</table>
@ -329,31 +329,31 @@ static std::unique_ptr<SkCanvas>
<table>
<tr>
<td><a name="kUnknown_SkColorType"></a> <code><strong>kUnknown_SkColorType </strong></code></td><td>0</td><td></td>
<td><a name="kUnknown_SkColorType"> <code><strong>kUnknown_SkColorType </strong></code> </a></td><td>0</td><td></td>
</tr>
<tr>
<td><a name="kAlpha_8_SkColorType"></a> <code><strong>kAlpha_8_SkColorType </strong></code></td><td>1</td><td></td>
<td><a name="kAlpha_8_SkColorType"> <code><strong>kAlpha_8_SkColorType </strong></code> </a></td><td>1</td><td></td>
</tr>
<tr>
<td><a name="kRGB_565_SkColorType"></a> <code><strong>kRGB_565_SkColorType </strong></code></td><td>2</td><td></td>
<td><a name="kRGB_565_SkColorType"> <code><strong>kRGB_565_SkColorType </strong></code> </a></td><td>2</td><td></td>
</tr>
<tr>
<td><a name="kARGB_4444_SkColorType"></a> <code><strong>kARGB_4444_SkColorType </strong></code></td><td>3</td><td></td>
<td><a name="kARGB_4444_SkColorType"> <code><strong>kARGB_4444_SkColorType </strong></code> </a></td><td>3</td><td></td>
</tr>
<tr>
<td><a name="kRGBA_8888_SkColorType"></a> <code><strong>kRGBA_8888_SkColorType </strong></code></td><td>4</td><td></td>
<td><a name="kRGBA_8888_SkColorType"> <code><strong>kRGBA_8888_SkColorType </strong></code> </a></td><td>4</td><td></td>
</tr>
<tr>
<td><a name="kBGRA_8888_SkColorType"></a> <code><strong>kBGRA_8888_SkColorType </strong></code></td><td>5</td><td></td>
<td><a name="kBGRA_8888_SkColorType"> <code><strong>kBGRA_8888_SkColorType </strong></code> </a></td><td>5</td><td></td>
</tr>
<tr>
<td><a name="kIndex_8_SkColorType"></a> <code><strong>kIndex_8_SkColorType </strong></code></td><td>6</td><td></td>
<td><a name="kIndex_8_SkColorType"> <code><strong>kIndex_8_SkColorType </strong></code> </a></td><td>6</td><td></td>
</tr>
<tr>
<td><a name="kGray_8_SkColorType"></a> <code><strong>kGray_8_SkColorType </strong></code></td><td>7</td><td></td>
<td><a name="kGray_8_SkColorType"> <code><strong>kGray_8_SkColorType </strong></code> </a></td><td>7</td><td></td>
</tr>
<tr>
<td><a name="kRGBA_F16_SkColorType"></a> <code><strong>kRGBA_F16_SkColorType </strong></code></td><td>8</td><td></td>
<td><a name="kRGBA_F16_SkColorType"> <code><strong>kRGBA_F16_SkColorType </strong></code> </a></td><td>8</td><td></td>
</tr>
</table>
@ -361,7 +361,7 @@ static std::unique_ptr<SkCanvas>
<table>
<tr>
<td><a name="kN32_SkColorType"></a> <code><strong>kN32_SkColorType </strong></code></td><td>4</td><td></td>
<td><a name="kN32_SkColorType"> <code><strong>kN32_SkColorType </strong></code> </a></td><td>4</td><td></td>
</tr>
</table>
@ -423,16 +423,16 @@ sk_sp<SkShader> makeShader(SkShader::TileMode, SkShader::TileMode,
<table>
<tr>
<td><a name="SK_ScalarMax"></a> <code><strong>SK_ScalarMax </strong></code></td><td>to be written</td><td></td>
<td><a name="SK_ScalarMax"> <code><strong>SK_ScalarMax </strong></code> </a></td><td>to be written</td><td></td>
</tr>
<tr>
<td><a name="SK_ScalarInfinity"></a> <code><strong>SK_ScalarInfinity </strong></code></td><td>to be written</td><td></td>
<td><a name="SK_ScalarInfinity"> <code><strong>SK_ScalarInfinity </strong></code> </a></td><td>to be written</td><td></td>
</tr>
<tr>
<td><a name="SK_ScalarNegativeInfinity"></a> <code><strong>SK_ScalarNegativeInfinity </strong></code></td><td>to be written</td><td></td>
<td><a name="SK_ScalarNegativeInfinity"> <code><strong>SK_ScalarNegativeInfinity </strong></code> </a></td><td>to be written</td><td></td>
</tr>
<tr>
<td><a name="SK_ScalarNaN"></a> <code><strong>SK_ScalarNaN </strong></code></td><td>to be written</td><td></td>
<td><a name="SK_ScalarNaN"> <code><strong>SK_ScalarNaN </strong></code> </a></td><td>to be written</td><td></td>
</tr>
</table>
@ -442,16 +442,16 @@ sk_sp<SkShader> makeShader(SkShader::TileMode, SkShader::TileMode,
<table>
<tr>
<td><a name="SkPaintDefaults_Flags"></a> <code><strong>SkPaintDefaults_Flags </strong></code></td><td>0</td><td></td>
<td><a name="SkPaintDefaults_Flags"> <code><strong>SkPaintDefaults_Flags </strong></code> </a></td><td>0</td><td></td>
</tr>
<tr>
<td><a name="SkPaintDefaults_Hinting"></a> <code><strong>SkPaintDefaults_Hinting </strong></code></td><td>2</td><td></td>
<td><a name="SkPaintDefaults_Hinting"> <code><strong>SkPaintDefaults_Hinting </strong></code> </a></td><td>2</td><td></td>
</tr>
<tr>
<td><a name="SkPaintDefaults_TextSize"></a> <code><strong>SkPaintDefaults_TextSize </strong></code></td><td>12</td><td></td>
<td><a name="SkPaintDefaults_TextSize"> <code><strong>SkPaintDefaults_TextSize </strong></code> </a></td><td>12</td><td></td>
</tr>
<tr>
<td><a name="SkPaintDefaults_MiterLimit"></a> <code><strong>SkPaintDefaults_MiterLimit </strong></code></td><td>4</td><td></td>
<td><a name="SkPaintDefaults_MiterLimit"> <code><strong>SkPaintDefaults_MiterLimit </strong></code> </a></td><td>4</td><td></td>
</tr>
</table>
@ -549,13 +549,13 @@ void dumpHex() const
# <a name="SkShader"></a> Class SkShader
## <a name="SkShader::TileMode"></a> Enum SkShader::TileMode
## <a name="SkShader_TileMode"></a> Enum SkShader::TileMode
### Constants
<table>
<tr>
<td><a name="SkShader::kClamp_TileMode"></a> <code><strong>SkShader::kClamp_TileMode </strong></code></td><td>0</td><td></td>
<td><a name="SkShader_kClamp_TileMode"> <code><strong>SkShader::kClamp_TileMode </strong></code> </a></td><td>0</td><td></td>
</tr>
</table>
@ -604,13 +604,13 @@ static sk_sp<SkSurface> MakeRasterDirect(const SkImageInfo&, void* pixels,
# <a name="Legacy_Font_Host"></a> Legacy Font Host
## <a name="SkSurfaceProps::InitType"></a> Enum SkSurfaceProps::InitType
## <a name="SkSurfaceProps_InitType"></a> Enum SkSurfaceProps::InitType
### Constants
<table>
<tr>
<td><a name="SkSurfaceProps::kLegacyFontHost_InitType"></a> <code><strong>SkSurfaceProps::kLegacyFontHost_InitType </strong></code></td><td>0</td><td></td>
<td><a name="SkSurfaceProps_kLegacyFontHost_InitType"> <code><strong>SkSurfaceProps::kLegacyFontHost_InitType </strong></code> </a></td><td>0</td><td></td>
</tr>
</table>

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

@ -2,19 +2,19 @@ usingBookmaker
===
# <a name="Bookmaker"></a> Bookmaker
How to use the <a href="usingBookmaker#Bookmaker">Bookmaker</a> utility.
How to use the <a href="#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="usingBookmaker#Bookmaker">Bookmaker</a>.
Build <a href="#Bookmaker">Bookmaker</a>.
<pre style="padding: 1em 1em 1em 1em;width: 44em; background-color: #f0f0f0">
$ ninja -<a href="usingBookmaker#C">C</a> out/dir bookmaker</pre>
Generate an starter <a href="usingBookmaker#Bookmaker">Bookmaker</a> file from an existing include.
Generate an starter <a href="#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.
@ -27,7 +27,7 @@ Use your favorite editor to fill out docs/<a href="usingBookmaker#SkXXX">SkXXX</
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="usingBookmaker#Bookmaker">Bookmaker</a> inside <a href="usingBookmaker#Visual_Studio">Visual Studio</a>, you can click on errors and it
If you run <a href="#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">
@ -62,4 +62,4 @@ $ ./out/dir/bookmaker -p -b docs -i include/core/<a href="usingBookmaker#SkXXX">
## <a name="Bugs"></a> Bugs
<a href="usingBookmaker#Bookmaker">Bookmaker</a> bugs are trackedherebug.skia.org/6898.
<a href="#Bookmaker">Bookmaker</a> bugs are trackedherebug.skia.org/6898.

42
tools/bookmaker/mdOut.cpp
View File

@ -485,19 +485,24 @@ string MdOut::linkRef(const string& leadingSpaces, const Definition* def,
classMatch |= curRoot->fName == classPart;
}
const Definition* defRoot;
const Definition* temp = def;
do {
defRoot = def;
if (!(def = def->fParent)) {
defRoot = temp;
if (!(temp = temp->fParent)) {
break;
}
classMatch |= def != defRoot && def->fName == classPart;
classMatch |= temp != defRoot && temp->fName == classPart;
} while (true);
string namePart = string::npos != under ? str->substr(under + 1, str->length()) : *str;
SkASSERT(fRoot);
SkASSERT(fRoot->fFileName.length());
if (false && classMatch) {
str = &namePart;
} else if (true || (curRoot != defRoot && defRoot->isRoot())) {
if (classMatch) {
buildup = "#";
if (*str != classPart && "Sk" == classPart.substr(0, 2)) {
buildup += classPart + "_";
}
buildup += namePart;
} else {
string filename = defRoot->asRoot()->fFileName;
if (filename.substr(filename.length() - 4) == ".bmh") {
filename = filename.substr(0, filename.length() - 4);
@ -507,14 +512,18 @@ string MdOut::linkRef(const string& leadingSpaces, const Definition* def,
--start;
}
buildup = filename.substr(start) + "#" + (classMatch ? namePart : *str);
str = &buildup;
}
if (MarkType::kParam == def->fMarkType) {
const Definition* parent = def->fParent;
SkASSERT(MarkType::kMethod == parent->fMarkType);
buildup = '#' + parent->fFiddle + '_' + ref;
}
string refOut(ref);
std::replace(refOut.begin(), refOut.end(), '_', ' ');
if (ref.length() > 2 && islower(ref[0]) && "()" == ref.substr(ref.length() - 2)) {
refOut = refOut.substr(0, refOut.length() - 2);
}
return leadingSpaces + "<a href=\"" + *str + "\">" + refOut + "</a>";
return leadingSpaces + "<a href=\"" + buildup + "\">" + refOut + "</a>";
}
void MdOut::markTypeOut(Definition* def) {
@ -573,8 +582,8 @@ void MdOut::markTypeOut(Definition* def) {
fTableState = TableState::kColumn;
}
this->writePending();
fprintf(fOut, " <td><a name=\"%s\"></a> <code><strong>%s </strong></code></td>",
def->fName.c_str(), def->fName.c_str());
fprintf(fOut, " <td><a name=\"%s\"> <code><strong>%s </strong></code> </a></td>",
def->fFiddle.c_str(), def->fName.c_str());
const char* lineEnd = strchr(textStart, '\n');
SkASSERT(lineEnd < def->fTerminator);
SkASSERT(lineEnd > textStart);
@ -599,7 +608,7 @@ void MdOut::markTypeOut(Definition* def) {
case MarkType::kEnum:
case MarkType::kEnumClass:
this->mdHeaderOut(2);
fprintf(fOut, "<a name=\"%s\"></a> Enum %s", def->fName.c_str(), def->fName.c_str());
fprintf(fOut, "<a name=\"%s\"></a> Enum %s", def->fFiddle.c_str(), def->fName.c_str());
this->lf(2);
break;
case MarkType::kError:
@ -655,7 +664,8 @@ void MdOut::markTypeOut(Definition* def) {
tp.skipWhiteSpace();
const char* end = tp.trimmedBracketEnd('\n', TextParser::OneLine::kYes);
this->lfAlways(2);
fprintf(fOut, "<code><strong>%.*s</strong></code>", (int) (end - tp.fChar), tp.fChar);
fprintf(fOut, "<a name=\"%s\"> <code><strong>%.*s</strong></code> </a>",
def->fFiddle.c_str(), (int) (end - tp.fChar), tp.fChar);
this->lf(2);
} break;
case MarkType::kMethod: {
@ -708,9 +718,11 @@ void MdOut::markTypeOut(Definition* def) {
paramParser.skipSpace();
const char* paramName = paramParser.fChar;
paramParser.skipToSpace();
string paramNameStr(paramName, (int) (paramParser.fChar - paramName));
string refNameStr = def->fParent->fFiddle + "_" + paramNameStr;
fprintf(fOut,
" <td><code><strong>%.*s </strong></code></td> <td>",
(int) (paramParser.fChar - paramName), paramName);
" <td><a name=\"%s\"> <code><strong>%s </strong></code> </a></td> <td>",
refNameStr.c_str(), paramNameStr.c_str());
} break;
case MarkType::kPlatform:
break;
@ -752,7 +764,7 @@ void MdOut::markTypeOut(Definition* def) {
case MarkType::kStruct:
fRoot = def->asRoot();
this->mdHeaderOut(1);
fprintf(fOut, "<a name=\"%s\"></a> Struct %s", def->fName.c_str(), def->fName.c_str());
fprintf(fOut, "<a name=\"%s\"></a> Struct %s", def->fFiddle.c_str(), def->fName.c_str());
this->lf(1);
break;
case MarkType::kSubstitute: