zcy
/
snap.js
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Docs fix

master
Dmitry Baranovskiy 2017-02-05 12:17:21 +11:00
parent fa62b7b152
commit 23140bf2e1
8 changed files with 1423 additions and 1395 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
dist/snap.svg-min.js vendored
View File

File diff suppressed because one or more lines are too long

16
dist/snap.svg.js vendored
View File

@ -14,7 +14,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.
//
// build: 2017-02-04
// build: 2017-02-05
// Copyright (c) 2013 Adobe Systems Incorporated. All rights reserved.
//
@ -947,7 +947,7 @@ var has = "hasOwnProperty",
xmlns = "http://www.w3.org/2000/svg",
hub = {},
/*\
* Snap.url()
* Snap.url
[ method ]
**
* Wraps path into `"url('<path>')"`.
@ -1241,7 +1241,6 @@ Snap.atan2 = function (num) {
[ method ]
**
* Returns an angle between two or three points
> Parameters
- x1 (number) x coord of first point
- y1 (number) y coord of first point
- x2 (number) x coord of second point
@ -1256,7 +1255,6 @@ Snap.angle = angle;
[ method ]
**
* Returns distance between two points
> Parameters
- x1 (number) x coord of first point
- y1 (number) y coord of first point
- x2 (number) x coord of second point
@ -1271,7 +1269,6 @@ Snap.len = function (x1, y1, x2, y2) {
[ method ]
**
* Returns squared distance between two points
> Parameters
- x1 (number) x coord of first point
- y1 (number) y coord of first point
- x2 (number) x coord of second point
@ -1286,7 +1283,6 @@ Snap.len2 = function (x1, y1, x2, y2) {
[ method ]
**
* Returns closest point to a given one on a given path.
> Parameters
- path (Element) path element
- x (number) x coord of a point
- y (number) y coord of a point
@ -4116,7 +4112,7 @@ Snap.plugin(function (Snap, Element, Paper, glob, Fragment) {
separator = Snap._.separator,
E = "";
/*\
* Snap.deurl()
* Snap.deurl
[ method ]
**
* Unwraps path from `"url(<path>)"`.
@ -5310,7 +5306,7 @@ Snap.plugin(function (Snap, Element, Paper, glob, Fragment) {
var $ = Snap._.$;
// gradients' helpers
/*\
* Element.stops()
* Element.stops
[ method ]
**
* Only for gradients!
@ -5321,7 +5317,7 @@ Snap.plugin(function (Snap, Element, Paper, glob, Fragment) {
return this.selectAll("stop");
}
/*\
* Element.addStop()
* Element.addStop
[ method ]
**
* Only for gradients!
@ -5371,7 +5367,7 @@ Snap.plugin(function (Snap, Element, Paper, glob, Fragment) {
}
}
/*\
* Element.setStops()
* Element.setStops
[ method ]
**
* Only for gradients!

2768
doc/reference.html
View File

File diff suppressed because it is too large Load Diff

3
dr.json
View File

@ -8,6 +8,9 @@
}, {
"url": "src/element.js",
"link": "https://github.com/adobe-webplatform/Snap.svg/blob/master/src/element.js"
}, {
"url": "src/attr.js",
"link": "https://github.com/adobe-webplatform/Snap.svg/blob/master/src/attr.js"
}, {
"url": "src/animation.js",
"link": "https://github.com/adobe-webplatform/Snap.svg/blob/master/src/animation.js"

2
src/attr.js
View File

@ -24,7 +24,7 @@ Snap.plugin(function (Snap, Element, Paper, glob, Fragment) {
separator = Snap._.separator,
E = "";
/*\
* Snap.deurl()
* Snap.deurl
[ method ]
**
* Unwraps path from `"url(<path>)"`.

6
src/paper.js
View File

@ -513,7 +513,7 @@ Snap.plugin(function (Snap, Element, Paper, glob, Fragment) {
var $ = Snap._.$;
// gradients' helpers
/*\
* Element.stops()
* Element.stops
[ method ]
**
* Only for gradients!
@ -524,7 +524,7 @@ Snap.plugin(function (Snap, Element, Paper, glob, Fragment) {
return this.selectAll("stop");
}
/*\
* Element.addStop()
* Element.addStop
[ method ]
**
* Only for gradients!
@ -574,7 +574,7 @@ Snap.plugin(function (Snap, Element, Paper, glob, Fragment) {
}
}
/*\
* Element.setStops()
* Element.setStops
[ method ]
**
* Only for gradients!

6
src/svg.js
View File

@ -92,7 +92,7 @@ var has = "hasOwnProperty",
xmlns = "http://www.w3.org/2000/svg",
hub = {},
/*\
* Snap.url()
* Snap.url
[ method ]
**
* Wraps path into `"url('<path>')"`.
@ -386,7 +386,6 @@ Snap.atan2 = function (num) {
[ method ]
**
* Returns an angle between two or three points
> Parameters
- x1 (number) x coord of first point
- y1 (number) y coord of first point
- x2 (number) x coord of second point
@ -401,7 +400,6 @@ Snap.angle = angle;
[ method ]
**
* Returns distance between two points
> Parameters
- x1 (number) x coord of first point
- y1 (number) y coord of first point
- x2 (number) x coord of second point
@ -416,7 +414,6 @@ Snap.len = function (x1, y1, x2, y2) {
[ method ]
**
* Returns squared distance between two points
> Parameters
- x1 (number) x coord of first point
- y1 (number) y coord of first point
- x2 (number) x coord of second point
@ -431,7 +428,6 @@ Snap.len2 = function (x1, y1, x2, y2) {
[ method ]
**
* Returns closest point to a given one on a given path.
> Parameters
- path (Element) path element
- x (number) x coord of a point
- y (number) y coord of a point

15
template.dot
View File

@ -8,7 +8,6 @@
<link rel="shortcut icon" href="/assets/favicon.ico?v=1">
<meta name="viewport" content="user-scalable=no, initial-scale=1, maximum-scale=1, minimum-scale=1, width=device-width">
<link rel="stylesheet" href="/assets/docs/fonts/stylesheet.css?v=201311041519">
<link rel="stylesheet" href="/assets/docs/css/topcoat-desktop-light.css?v=201311041519">
<link rel="stylesheet" href="/assets/docs/css/main.css?v=201311041519">
<link rel="stylesheet" href="/assets/docs/css/dr.css?v=201311041519">
<link rel="stylesheet" href="/assets/docs/css/prism.css?v=201311041519">
@ -50,7 +49,7 @@
<a href="/docs/" class="mobile-hide selected">Docs</a>
<a href="/support/">Support</a>
<a href="/demos/" class="mobile-hide">Demos</a>
<a class="bt" href="/assets/downloads/Snap.svg-0.4.2.zip" onclick="trackOutboundLink(this, 'Download', '0.4.2');return false;">Download</a>
<a class="bt" href="/assets/downloads/Snap.svg-0.5.0.zip" onclick="trackOutboundLink(this, 'Download', '0.5.0');return false;">Download</a>
</nav>
</div>
</header>
@ -62,7 +61,7 @@
<div class="max-width">
<div id="sideNav">
<div class="combo">
<input type="search" id="dr-filter" value="" placeholder="search" class="topcoat-search-input">
<input type="search" id="dr-filter" value="" placeholder="search">
</div>
<div id="pageNav">
<ol id="dr-toc">
@ -80,7 +79,7 @@
{{~it.out :item:index}}
<article id="{{=item[0].title}}">
<header>
<h3 class="{{=item[0].clas}}">{{=item[0].name}}<a href="#{{=item[0].title}}" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line {{=item[0].line}} in the source" href="https://github.com/adobe-webplatform/Snap.svg/blob/master/src/svg.js#L{{=item[0].line}}">&#x27ad;</a></h3>
<h2 class="{{=item[0].clas}}">{{=item[0].name}}<a href="#{{=item[0].title}}" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line {{=item[0].line}} in the source" href="https://github.com/adobe-webplatform/Snap.svg/blob/master/src/svg.js#L{{=item[0].line}}">&#x27ad;</a></h2>
</header>
<section>
<div class="extra" id="{{=item[0].title}}-extra"></div>
@ -88,10 +87,10 @@
{{~item :line:i}}
{{ if (i > 0) { }}
{{ if (line.text) { }}<p>{{=line.text.join("</p><p>")}}</p>{{ } }}
{{ if (line.attr) { }}<div class="topcoat-list__container">
<h3 class="topcoat-list__header">Parameters</h3>
<ol class="topcoat-list">
{{~line.attr :attr:j}}<li class="topcoat-list__item"><span class="dr-param">{{=attr.name}}</span>
{{ if (line.attr) { }}<div class="params">
<h3 class="params">Parameters</h3>
<ol class="params-list">
{{~line.attr :attr:j}}<li><span class="dr-param">{{=attr.name}}</span>
<span class="dr-type">{{~attr.type :type:k}}<em class="dr-type-{{=type}}">{{=type}}</em> {{~}}</span>
<span class="dr-description">{{=attr.desc}}</span></li>
{{~}}