Clean up docs and fix spelling mistakes.

This commit is contained in:
Jürg Lehni 2013-12-29 15:44:26 +01:00
parent 5f466bbc7e
commit 8395541298
9 changed files with 25 additions and 9 deletions

5
node_modules/.gitignore generated vendored
View file

@ -1,7 +1,8 @@
.bin
canvas
grunt*
jsdoc
jsdom
prepro
request
uglify-js
prepro
grunt*

View file

@ -211,7 +211,7 @@ Base.inject(/** @lends Base# */{
/**
* Reads all readable arguments from the list, handling nested arrays
* seperately.
* separately.
* @param {Array} list the list to read from, either an arguments object
* or a normal array.
* @param {Number} start the index at which to start reading in the list

View file

@ -46,7 +46,7 @@ var DomElement = new function() {
return res;
}
return {
return /** @lends DomElement */{
create: function(nodes, parent) {
var isArray = Array.isArray(nodes),
res = create(isArray ? nodes : arguments, isArray ? parent : null);

View file

@ -15,7 +15,7 @@
* @namespace
* @private
*/
var DomEvent = {
var DomEvent = /** @lends DomEvent */{
add: function(el, events) {
for (var type in events)
el.addEventListener(type, events[type], false);

View file

@ -556,7 +556,7 @@ statics: {
},
getParameterOf: function(v, x, y) {
// Handle beginnings and end seperately, as they are not detected
// Handle beginnings and end separately, as they are not detected
// sometimes.
var tolerance = /*#=*/ Numerical.TOLERANCE;
if (Math.abs(v[0] - x) < tolerance && Math.abs(v[1] - y) < tolerance)
@ -675,7 +675,7 @@ statics: {
c = v1 - v0,
count = Numerical.solveQuadratic(a, b, c, roots),
// Add some tolerance for good roots, as t = 0 / 1 are added
// seperately anyhow, and we don't want joins to be added with
// separately anyhow, and we don't want joins to be added with
// radiuses in getStrokeBounds()
tMin = /*#=*/ Numerical.TOLERANCE,
tMax = 1 - tMin;

View file

@ -15,6 +15,11 @@
// from "Graphics Gems", Academic Press, 1990
// Modifications and optimisations of original algorithm by Juerg Lehni.
/**
* @name PathFitter
* @class
* @private
*/
var PathFitter = Base.extend({
initialize: function(path, error) {
this.points = [];

View file

@ -10,6 +10,11 @@
* All rights reserved.
*/
/**
* @name PathFlattener
* @class
* @private
*/
var PathFlattener = Base.extend({
initialize: function(path) {
this.curves = []; // The curve values as returned by getValues()

View file

@ -143,7 +143,7 @@ var CanvasView = View.extend(/** @lends CanvasView# */{
return false;
}
return {
return /** @lends CanvasView# */{
/**
* Returns true if event was stopped, false otherwise, whether handler
* was called or not!

View file

@ -10,6 +10,11 @@
* All rights reserved.
*/
/**
* @name Numerical
* @namespace
* @private
*/
var Numerical = new function() {
// Lookup tables for abscissas and weights with values for n = 2 .. 16.
@ -75,7 +80,7 @@ var Numerical = new function() {
};
}
return {
return /** @lends Numerical */{
TOLERANCE: TOLERANCE,
// Precision when comparing against 0
EPSILON: EPSILON,