aboutsummaryrefslogtreecommitdiffhomepage
path: root/site
diff options
context:
space:
mode:
authorGravatar Cary Clark <caryclark@skia.org>2018-07-12 16:24:53 -0400
committerGravatar Skia Commit-Bot <skia-commit-bot@chromium.org>2018-07-12 23:47:49 +0000
commitab5c9af442382fd05215a09f1814686710108880 (patch)
tree4ae24dee1da7e80095da3c300db5f36b36150932 /site
parentf839361feabc22a97108140e2f665cd4c947141a (diff)
fix include generation
Over zealous requirement to have periods at end of every sentence relaxed. Removed ancient comments from SkRRect.h. Add support for understanding " = default". TBR=caryclark@google.com Docs-Preview: https://skia.org/?cl=141120 Bug: skia:6818 Change-Id: I184533539803238ed386863f9029cb68a27e1d6a Reviewed-on: https://skia-review.googlesource.com/141120 Commit-Queue: Cary Clark <caryclark@skia.org> Reviewed-by: Cary Clark <caryclark@skia.org>
Diffstat (limited to 'site')
-rw-r--r--site/user/api/SkBitmap_Reference.md12
-rw-r--r--site/user/api/SkCanvas_Reference.md10
-rw-r--r--site/user/api/SkMatrix_Reference.md94
-rw-r--r--site/user/api/SkSurface_Reference.md6
4 files changed, 0 insertions, 122 deletions
diff --git a/site/user/api/SkBitmap_Reference.md b/site/user/api/SkBitmap_Reference.md
index 625fdfbadf..8273397001 100644
--- a/site/user/api/SkBitmap_Reference.md
+++ b/site/user/api/SkBitmap_Reference.md
@@ -2058,8 +2058,6 @@ Calls <a href='#SkBitmap_reset'>reset</a> and returns false if:
</tr>
</table>
-.
-
### Parameters
<table> <tr> <td><a name='SkBitmap_setInfo_imageInfo'><code><strong>imageInfo</strong></code></a></td>
@@ -3400,8 +3398,6 @@ Input is not validated. Triggers an assert() if built with SK_DEBUG defined and:
</tr>
</table>
-.
-
### Parameters
<table> <tr> <td><a name='SkBitmap_getAddr32_x'><code><strong>x</strong></code></a></td>
@@ -3456,8 +3452,6 @@ Input is not validated. Triggers an assert() if built with SK_DEBUG defined and:
</tr>
</table>
-.
-
### Parameters
<table> <tr> <td><a name='SkBitmap_getAddr16_x'><code><strong>x</strong></code></a></td>
@@ -3512,8 +3506,6 @@ Input is not validated. Triggers an assert() if built with SK_DEBUG defined and:
</tr>
</table>
-.
-
### Parameters
<table> <tr> <td><a name='SkBitmap_getAddr8_x'><code><strong>x</strong></code></a></td>
@@ -3573,8 +3565,6 @@ Return false if:
</tr>
</table>
-.
-
### Parameters
<table> <tr> <td><a name='SkBitmap_extractSubset_dst'><code><strong>dst</strong></code></a></td>
@@ -3643,8 +3633,6 @@ row to the next. Returns true if pixels are copied. Returns false if:
</tr>
</table>
-.
-
<a href='#Pixels'>Pixels</a> are copied only if pixel conversion is possible. If <a href='#Bitmap'>Bitmap</a> <a href='#SkBitmap_colorType'>colorType</a> is
<a href='SkImageInfo_Reference#kGray_8_SkColorType'>kGray_8_SkColorType</a>, or <a href='SkImageInfo_Reference#kAlpha_8_SkColorType'>kAlpha_8_SkColorType</a>; <a href='#SkBitmap_readPixels_dstInfo'>dstInfo</a>.<a href='#SkBitmap_colorType'>colorType</a> must match.
If <a href='#Bitmap'>Bitmap</a> <a href='#SkBitmap_colorType'>colorType</a> is <a href='SkImageInfo_Reference#kGray_8_SkColorType'>kGray_8_SkColorType</a>, <a href='#SkBitmap_readPixels_dstInfo'>dstInfo</a>.<a href='#SkBitmap_colorSpace'>colorSpace</a> must match.
diff --git a/site/user/api/SkCanvas_Reference.md b/site/user/api/SkCanvas_Reference.md
index c418c50897..75bf7645f8 100644
--- a/site/user/api/SkCanvas_Reference.md
+++ b/site/user/api/SkCanvas_Reference.md
@@ -1497,8 +1497,6 @@ Does not copy, and returns false if:
</tr>
</table>
-.
-
### Parameters
<table> <tr> <td><a name='SkCanvas_readPixels_dstInfo'><code><strong>dstInfo</strong></code></a></td>
@@ -1595,8 +1593,6 @@ Does not copy, and returns false if:
</tr>
</table>
-.
-
### Parameters
<table> <tr> <td><a name='SkCanvas_readPixels_2_pixmap'><code><strong>pixmap</strong></code></a></td>
@@ -1677,8 +1673,6 @@ Does not copy, and returns false if:
</tr>
</table>
-.
-
### Parameters
<table> <tr> <td><a name='SkCanvas_readPixels_3_bitmap'><code><strong>bitmap</strong></code></a></td>
@@ -1758,8 +1752,6 @@ Does not copy, and returns false if:
</tr>
</table>
-.
-
### Parameters
<table> <tr> <td><a name='SkCanvas_writePixels_info'><code><strong>info</strong></code></a></td>
@@ -1836,8 +1828,6 @@ Does not copy, and returns false if:
</tr>
</table>
-.
-
### Parameters
<table> <tr> <td><a name='SkCanvas_writePixels_2_bitmap'><code><strong>bitmap</strong></code></a></td>
diff --git a/site/user/api/SkMatrix_Reference.md b/site/user/api/SkMatrix_Reference.md
index 617ccc8915..b780eb27e1 100644
--- a/site/user/api/SkMatrix_Reference.md
+++ b/site/user/api/SkMatrix_Reference.md
@@ -680,8 +680,6 @@ Sets <a href='#Matrix'>Matrix</a> to scale by (<a href='#SkMatrix_MakeScale_sx'>
| 0 0 1 |
</pre>
-.
-
### Parameters
<table> <tr> <td><a name='SkMatrix_MakeScale_sx'><code><strong>sx</strong></code></a></td>
@@ -720,8 +718,6 @@ Sets <a href='#Matrix'>Matrix</a> to <a href='#SkMatrix_MakeScale_2_scale'>scale
| 0 0 1 |
</pre>
-.
-
### Parameters
<table> <tr> <td><a name='SkMatrix_MakeScale_2_scale'><code><strong>scale</strong></code></a></td>
@@ -758,8 +754,6 @@ Sets <a href='#Matrix'>Matrix</a> to translate by (<a href='#SkMatrix_MakeTrans_
| 0 0 1 |
</pre>
-.
-
### Parameters
<table> <tr> <td><a name='SkMatrix_MakeTrans_dx'><code><strong>dx</strong></code></a></td>
@@ -801,8 +795,6 @@ Sets <a href='#Matrix'>Matrix</a> to:
| pers0 pers1 pers2 |
</pre>
-.
-
### Parameters
<table> <tr> <td><a name='SkMatrix_MakeAll_scaleX'><code><strong>scaleX</strong></code></a></td>
@@ -1084,8 +1076,6 @@ Returns true if <a href='#Matrix'>Matrix</a> is identity. Identity matrix is:
| 0 0 1 |
</pre>
-.
-
### Return Value
true if <a href='#Matrix'>Matrix</a> has no effect
@@ -1125,8 +1115,6 @@ contain only scale elements, only translate elements, or both. <a href='#Matrix'
| 0 0 1 |
</pre>
-.
-
### Return Value
true if <a href='#Matrix'>Matrix</a> is identity; or scales, translates, or both
@@ -1167,8 +1155,6 @@ Returns true if <a href='#Matrix'>Matrix</a> is identity, or translates. <a href
| 0 0 1 |
</pre>
-.
-
### Return Value
true if <a href='#Matrix'>Matrix</a> is identity, or translates
@@ -2486,8 +2472,6 @@ Sets all values from parameters. Sets matrix to:
| persp0 persp1 persp2 |
</pre>
-.
-
### Parameters
<table> <tr> <td><a name='SkMatrix_setAll_scaleX'><code><strong>scaleX</strong></code></a></td>
@@ -2586,8 +2570,6 @@ Sets matrix to:
| buffer[6] buffer[7] buffer[8] |
</pre>
-.
-
In the future, <a href='#SkMatrix_set9'>set9</a> followed by <a href='#SkMatrix_get9'>get9</a> may not return the same values. Since <a href='#Matrix'>Matrix</a>
maps non-homogeneous coordinates, scaling all nine values produces an equivalent
transformation, possibly improving precision.
@@ -2624,8 +2606,6 @@ Sets <a href='#Matrix'>Matrix</a> to identity; which has no effect on mapped <a
| 0 0 1 |
</pre>
-.
-
Also called <a href='#SkMatrix_setIdentity'>setIdentity</a>; use the one that provides better inline
documentation.
@@ -2662,8 +2642,6 @@ Sets <a href='#Matrix'>Matrix</a> to identity; which has no effect on mapped <a
| 0 0 1 |
</pre>
-.
-
Also called <a href='#SkMatrix_reset'>reset</a>; use the one that provides better inline
documentation.
@@ -3059,8 +3037,6 @@ a * b = | D E F | * | M N O | = | DJ+EM+FP DK+EN+FQ DL+EO+FR |
| G H I | | P Q R | | GJ+HM+IP GK+HN+IQ GL+HO+IR |
</pre>
-.
-
### Parameters
<table> <tr> <td><a name='SkMatrix_setConcat_a'><code><strong>a</strong></code></a></td>
@@ -3109,8 +3085,6 @@ Matrix * T(dx, dy) = | D E F | | 0 1 dy | = | D E D*dx+E*dy+F |
| G H I | | 0 0 1 | | G H G*dx+H*dy+I |
</pre>
-.
-
### Parameters
<table> <tr> <td><a name='SkMatrix_preTranslate_dx'><code><strong>dx</strong></code></a></td>
@@ -3165,8 +3139,6 @@ Matrix * S(sx, sy, px, py) = | D E F | | 0 sy dy | = | D*sx E*sy D*dx+E*dy+F |
| G H I | | 0 0 1 | | G*sx H*sy G*dx+H*dy+I |
</pre>
-.
-
### Parameters
<table> <tr> <td><a name='SkMatrix_preScale_sx'><code><strong>sx</strong></code></a></td>
@@ -3219,8 +3191,6 @@ Matrix * S(sx, sy) = | D E F | | 0 sy 0 | = | D*sx E*sy F |
| G H I | | 0 0 1 | | G*sx H*sy I |
</pre>
-.
-
### Parameters
<table> <tr> <td><a name='SkMatrix_preScale_2_sx'><code><strong>sx</strong></code></a></td>
@@ -3279,8 +3249,6 @@ Matrix * R(degrees, px, py) = | D E F | | s c dy | = | Dc+Es -Ds+Ec D*dx+E*dy+F
| G H I | | 0 0 1 | | Gc+Hs -Gs+Hc G*dx+H*dy+I |
</pre>
-.
-
### Parameters
<table> <tr> <td><a name='SkMatrix_preRotate_degrees'><code><strong>degrees</strong></code></a></td>
@@ -3339,8 +3307,6 @@ Matrix * R(degrees, px, py) = | D E F | | s c 0 | = | Dc+Es -Ds+Ec F |
| G H I | | 0 0 1 | | Gc+Hs -Gs+Hc I |
</pre>
-.
-
### Parameters
<table> <tr> <td><a name='SkMatrix_preRotate_2_degrees'><code><strong>degrees</strong></code></a></td>
@@ -3392,8 +3358,6 @@ Matrix * K(kx, ky, px, py) = | D E F | | ky 1 dy | = | D+E*ky D*kx+E D*dx+E*dy+
| G H I | | 0 0 1 | | G+H*ky G*kx+H G*dx+H*dy+I |
</pre>
-.
-
### Parameters
<table> <tr> <td><a name='SkMatrix_preSkew_kx'><code><strong>kx</strong></code></a></td>
@@ -3446,8 +3410,6 @@ Matrix * K(kx, ky) = | D E F | | ky 1 0 | = | D+E*ky D*kx+E F |
| G H I | | 0 0 1 | | G+H*ky G*kx+H I |
</pre>
-.
-
### Parameters
<table> <tr> <td><a name='SkMatrix_preSkew_2_kx'><code><strong>kx</strong></code></a></td>
@@ -3494,8 +3456,6 @@ Matrix * other = | D E F | * | M N O | = | DJ+EM+FP DK+EN+FQ DL+EO+FR |
| G H I | | P Q R | | GJ+HM+IP GK+HN+IQ GL+HO+IR |
</pre>
-.
-
### Parameters
<table> <tr> <td><a name='SkMatrix_preConcat_other'><code><strong>other</strong></code></a></td>
@@ -3541,8 +3501,6 @@ T(dx, dy) * Matrix = | 0 1 dy | | M N O | = | M+dy*P N+dy*Q O+dy*R |
| 0 0 1 | | P Q R | | P Q R |
</pre>
-.
-
### Parameters
<table> <tr> <td><a name='SkMatrix_postTranslate_dx'><code><strong>dx</strong></code></a></td>
@@ -3598,8 +3556,6 @@ S(sx, sy, px, py) * Matrix = | 0 sy dy | | M N O | = | sy*M+dy*P sy*N+dy*Q sy*O
| 0 0 1 | | P Q R | | P Q R |
</pre>
-.
-
### Parameters
<table> <tr> <td><a name='SkMatrix_postScale_sx'><code><strong>sx</strong></code></a></td>
@@ -3652,8 +3608,6 @@ S(sx, sy) * Matrix = | 0 sy 0 | | M N O | = | sy*M sy*N sy*O |
| 0 0 1 | | P Q R | | P Q R |
</pre>
-.
-
### Parameters
<table> <tr> <td><a name='SkMatrix_postScale_2_sx'><code><strong>sx</strong></code></a></td>
@@ -3709,8 +3663,6 @@ I(divx, divy) * Matrix = | 0 sy 0 | | M N O | = | sy*M sy*N sy*O |
| 0 0 1 | | P Q R | | P Q R |
</pre>
-.
-
### Parameters
<table> <tr> <td><a name='SkMatrix_postIDiv_divx'><code><strong>divx</strong></code></a></td>
@@ -3773,8 +3725,6 @@ R(degrees, px, py) * Matrix = |s c dy| |M N O| = |sJ+cM+dy*P sK+cN+dy*Q sL+cO+d
|0 0 1| |P Q R| | P Q R|
</pre>
-.
-
### Parameters
<table> <tr> <td><a name='SkMatrix_postRotate_degrees'><code><strong>degrees</strong></code></a></td>
@@ -3833,8 +3783,6 @@ R(degrees, px, py) * Matrix = | s c dy | | M N O | = | sJ+cM sK+cN sL+cO |
| 0 0 1 | | P Q R | | P Q R |
</pre>
-.
-
### Parameters
<table> <tr> <td><a name='SkMatrix_postRotate_2_degrees'><code><strong>degrees</strong></code></a></td>
@@ -3886,8 +3834,6 @@ K(kx, ky, px, py) * Matrix = |ky 1 dy| |M N O| = |ky*J+M+dy*P ky*K+N+dy*Q ky*L+
| 0 0 1| |P Q R| | P Q R|
</pre>
-.
-
### Parameters
<table> <tr> <td><a name='SkMatrix_postSkew_kx'><code><strong>kx</strong></code></a></td>
@@ -3940,8 +3886,6 @@ K(kx, ky) * Matrix = | ky 1 0 | | M N O | = | ky*J+M ky*K+N ky*L+O |
| 0 0 1 | | P Q R | | P Q R |
</pre>
-.
-
### Parameters
<table> <tr> <td><a name='SkMatrix_postSkew_2_kx'><code><strong>kx</strong></code></a></td>
@@ -3988,8 +3932,6 @@ other * Matrix = | D E F | * | M N O | = | DJ+EM+FP DK+EN+FQ DL+EO+FR |
| G H I | | P Q R | | GJ+HM+IP GK+HN+IQ GL+HO+IR |
</pre>
-.
-
### Parameters
<table> <tr> <td><a name='SkMatrix_postConcat_other'><code><strong>other</strong></code></a></td>
@@ -4093,8 +4035,6 @@ Returns true if <a href='#SkMatrix_setRectToRect_dst'>dst</a> is empty, and sets
| 0 0 1 |
</pre>
-.
-
### Parameters
<table> <tr> <td><a name='SkMatrix_setRectToRect_src'><code><strong>src</strong></code></a></td>
@@ -4156,8 +4096,6 @@ empty, returns <a href='#Matrix'>Matrix</a> set to:
| 0 0 1 |
</pre>
-.
-
### Parameters
<table> <tr> <td><a name='SkMatrix_MakeRectToRect_src'><code><strong>src</strong></code></a></td>
@@ -4291,8 +4229,6 @@ Sets <a href='#SkMatrix_SetAffineIdentity_affine'>affine</a> to:
| 0 1 0 |
</pre>
-.
-
Affine 3x2 matrices in column major order are used by OpenGL and XPS.
### Parameters
@@ -4334,8 +4270,6 @@ Fills <a href='#SkMatrix_asAffine_affine'>affine</a> in column major order. Sets
| skew-y scale-y translate-y |
</pre>
-.
-
If <a href='#Matrix'>Matrix</a> contains perspective, returns false and leaves <a href='#SkMatrix_asAffine_affine'>affine</a> unchanged.
### Parameters
@@ -4390,8 +4324,6 @@ column, then row, as:
| 0 0 1 |
</pre>
-.
-
### Parameters
<table> <tr> <td><a name='SkMatrix_setAffine_affine'><code><strong>affine</strong></code></a></td>
@@ -4539,8 +4471,6 @@ Matrix * pt = |D E F| |y| = |Ax+By+C Dx+Ey+F Gx+Hy+I| = ------- , -------
|G H I| |1| Gx+Hy+I Gx+Hy+I
</pre>
-.
-
<a href='#SkMatrix_mapPoints_src'>src</a> and <a href='#SkMatrix_mapPoints_dst'>dst</a> may point to the same storage.
### Parameters
@@ -4598,8 +4528,6 @@ Matrix * pt = |D E F| |y| = |Ax+By+C Dx+Ey+F Gx+Hy+I| = ------- , -------
|G H I| |1| Gx+Hy+I Gx+Hy+I
</pre>
-.
-
### Parameters
<table> <tr> <td><a name='SkMatrix_mapPoints_2_pts'><code><strong>pts</strong></code></a></td>
@@ -4644,8 +4572,6 @@ Matrix * src = |D E F| |y| = |Ax+By+Cz Dx+Ey+Fz Gx+Hy+Iz|
|G H I| |z|
</pre>
-.
-
### Parameters
<table> <tr> <td><a name='SkMatrix_mapHomogeneousPoints_dst'><code><strong>dst</strong></code></a></td>
@@ -4692,8 +4618,6 @@ Matrix * pt = |D E F| |y| = |Ax+By+C Dx+Ey+F Gx+Hy+I| = ------- , -------
|G H I| |1| Gx+Hy+I Gx+Hy+I
</pre>
-.
-
### Parameters
<table> <tr> <td><a name='SkMatrix_mapXY_x'><code><strong>x</strong></code></a></td>
@@ -4739,8 +4663,6 @@ Matrix * pt = |D E F| |y| = |Ax+By+C Dx+Ey+F Gx+Hy+I| = ------- , -------
|G H I| |1| Gx+Hy+I Gx+Hy+I
</pre>
-.
-
### Parameters
<table> <tr> <td><a name='SkMatrix_mapXY_2_x'><code><strong>x</strong></code></a></td>
@@ -4856,8 +4778,6 @@ Matrix * vec = |D E 0| |y| = |Ax+By Dx+Ey Gx+Hy+I| = ------- , -------
|G H I| |1| Gx+Hy+I Gx+Hy+I
</pre>
-.
-
### Parameters
<table> <tr> <td><a name='SkMatrix_mapVectors_2_vecs'><code><strong>vecs</strong></code></a></td>
@@ -4902,8 +4822,6 @@ Matrix * vec = |D E 0| |dy| = |A*dx+B*dy D*dx+E*dy G*dx+H*dy+I| = ----------- ,
|G H I| | 1| G*dx+H*dy+I G*dx+*dHy+I
</pre>
-.
-
### Parameters
<table> <tr> <td><a name='SkMatrix_mapVector_dx'><code><strong>dx</strong></code></a></td>
@@ -4950,8 +4868,6 @@ Matrix * vec = |D E 0| |dy| = |A*dx+B*dy D*dx+E*dy G*dx+H*dy+I| = ----------- ,
|G H I| | 1| G*dx+H*dy+I G*dx+*dHy+I
</pre>
-.
-
### Parameters
<table> <tr> <td><a name='SkMatrix_mapVector_2_dx'><code><strong>dx</strong></code></a></td>
@@ -5106,8 +5022,6 @@ Matrix * pt = |D E F| |y| = |Ax+By+C Dx+Ey+F Gx+Hy+I| = ------- , -------
|G H I| |1| Gx+Hy+I Gx+Hy+I
</pre>
-.
-
### Parameters
<table> <tr> <td><a name='SkMatrix_mapRectToQuad_dst'><code><strong>dst</strong></code></a></td>
@@ -5629,8 +5543,6 @@ Returns reference to const identity <a href='#Matrix'>Matrix</a>. Returned <a hr
| 0 0 1 |
</pre>
-.
-
### Return Value
const identity <a href='#Matrix'>Matrix</a>
@@ -5670,8 +5582,6 @@ to:
| SK_ScalarMax SK_ScalarMax SK_ScalarMax |
</pre>
-.
-
### Return Value
const invalid <a href='#Matrix'>Matrix</a>
@@ -5719,8 +5629,6 @@ a * b = | D E F | * | M N O | = | DJ+EM+FP DK+EN+FQ DL+EO+FR |
| G H I | | P Q R | | GJ+HM+IP GK+HN+IQ GL+HO+IR |
</pre>
-.
-
### Parameters
<table> <tr> <td><a name='SkMatrix_Concat_a'><code><strong>a</strong></code></a></td>
@@ -5793,8 +5701,6 @@ Initializes <a href='#Matrix'>Matrix</a> with scale and translate elements.
| 0 0 1 |
</pre>
-.
-
### Parameters
<table> <tr> <td><a name='SkMatrix_setScaleTranslate_sx'><code><strong>sx</strong></code></a></td>
diff --git a/site/user/api/SkSurface_Reference.md b/site/user/api/SkSurface_Reference.md
index c1fbe929dc..387c6cbae6 100644
--- a/site/user/api/SkSurface_Reference.md
+++ b/site/user/api/SkSurface_Reference.md
@@ -1627,8 +1627,6 @@ Does not copy, and returns false if:
</tr>
</table>
-.
-
### Parameters
<table> <tr> <td><a name='SkSurface_readPixels_dst'><code><strong>dst</strong></code></a></td>
@@ -1690,8 +1688,6 @@ Does not copy, and returns false if:
</tr>
</table>
-.
-
### Parameters
<table> <tr> <td><a name='SkSurface_readPixels_2_dstInfo'><code><strong>dstInfo</strong></code></a></td>
@@ -1764,8 +1760,6 @@ Does not copy, and returns false if:
</tr>
</table>
-.
-
### Parameters
<table> <tr> <td><a name='SkSurface_readPixels_3_dst'><code><strong>dst</strong></code></a></td>