Skip to content

Commit 8c57eed

Browse files
theloniousthelonious
committed
Update JSDoc type references
Also renames scratch to scratchpad
1 parent 5317782 commit 8c57eed

21 files changed

+181
-166
lines changed

‎.eslintignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
node_modules
22
dist
33
docs/jsdoc
4-
scratch
4+
scratchpad

‎dist/index-esm.js

+48-48
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ function _createClass(Constructor, protoProps, staticProps) {
2626
/**
2727
* BoundingBox2D
2828
*
29-
* @copyright 2011-2019 Kevin Lindsey
3029
* @module BoundingBox2D
30+
* @copyright 2011-2019 Kevin Lindsey
3131
*/
3232

3333
/**
@@ -41,7 +41,7 @@ function () {
4141
* @param {number} y
4242
* @param {number} width
4343
* @param {number} height
44-
* @returns {BoundingBox2D}
44+
* @returns {module:kld-contours.BoundingBox2D}
4545
*/
4646
function BoundingBox2D(x, y, width, height) {
4747
_classCallCheck(this, BoundingBox2D);
@@ -54,7 +54,7 @@ function () {
5454
/**
5555
* overlaps
5656
*
57-
* @param {BoundingBox2D} that
57+
* @param {module:kld-contours.BoundingBox2D} that
5858
* @returns {boolean}
5959
*/
6060

@@ -99,8 +99,8 @@ var Polygon2D =
9999
/*#__PURE__*/
100100
function () {
101101
/*
102-
* @param {Array<Point2D>} points
103-
* @returns {Polygon2D}
102+
* @param {Array<module:kld-affine.Point2D>} points
103+
* @returns {module:kld-contours.Polygon2D}
104104
*/
105105
function Polygon2D(points) {
106106
_classCallCheck(this, Polygon2D);
@@ -110,7 +110,7 @@ function () {
110110
/**
111111
* getBoundingBox
112112
*
113-
* @returns {BoundingBox2D}
113+
* @returns {module:kld-contours.BoundingBox2D}
114114
*/
115115

116116

@@ -135,7 +135,7 @@ function () {
135135
/**
136136
* toPolygon2D
137137
*
138-
* @returns {Polygon2D}
138+
* @returns {module:kld-contours.Polygon2D}
139139
*/
140140

141141
}, {
@@ -170,9 +170,9 @@ var Circle2D =
170170
function () {
171171
/**
172172
* @class
173-
* @param {Point2D} center
173+
* @param {module:kld-affine.Point2D} center
174174
* @param {number} radius
175-
* @returns {Circle2D}
175+
* @returns {module:kld-contours.Circle2D}
176176
*/
177177
function Circle2D(center, radius) {
178178
_classCallCheck(this, Circle2D);
@@ -183,7 +183,7 @@ function () {
183183
/**
184184
* getBoundingBox
185185
*
186-
* @returns {BoundingBox2D}
186+
* @returns {module:kld-contours.BoundingBox2D}
187187
*/
188188

189189

@@ -195,7 +195,7 @@ function () {
195195
/**
196196
* toPolygon2D
197197
*
198-
* @returns {Polygon2D}
198+
* @returns {module:kld-contours.Polygon2D}
199199
*/
200200

201201
}, {
@@ -216,11 +216,11 @@ var CubicBezier2D =
216216
/*#__PURE__*/
217217
function () {
218218
/**
219-
* @param {Point2D} p1
220-
* @param {Point2D} p2
221-
* @param {Point2D} p3
222-
* @param {Point2D} p4
223-
* @returns {CubicBezier2D}
219+
* @param {module:kld-affine.Point2D} p1
220+
* @param {module:kld-affine.Point2D} p2
221+
* @param {module:kld-affine.Point2D} p3
222+
* @param {module:kld-affine.Point2D} p4
223+
* @returns {module:kld-contours.CubicBezier2D}
224224
*/
225225
function CubicBezier2D(p1, p2, p3, p4) {
226226
_classCallCheck(this, CubicBezier2D);
@@ -234,7 +234,7 @@ function () {
234234
* getPointAtParameter
235235
*
236236
* @param {number} t
237-
* @returns {Point2D}
237+
* @returns {module:kld-affine.Point2D}
238238
*/
239239

240240

@@ -255,7 +255,7 @@ function () {
255255
* splitAtParameter
256256
*
257257
* @param {number} t
258-
* @returns {Array<CubicBezier2D>}
258+
* @returns {Array<module:kld-contours.CubicBezier2D>}
259259
*/
260260

261261
}, {
@@ -275,7 +275,7 @@ function () {
275275
/**
276276
* getBernsteinPolynomials
277277
*
278-
* @returns {{x: Polynomial, y: Polynomial}}
278+
* @returns {{x: module:kld-polynomial.Polynomial, y: module:kld-polynomial.Polynomial}}
279279
*/
280280

281281
}, {
@@ -312,7 +312,7 @@ function () {
312312
/**
313313
* getArcLengthPolynomial
314314
*
315-
* @returns {SqrtPolynomial}
315+
* @returns {module:kld-polynomial.SqrtPolynomial}
316316
*/
317317

318318
}, {
@@ -392,7 +392,7 @@ function () {
392392
/**
393393
* getBoundingBox
394394
*
395-
* @returns {BoundingBox2D}
395+
* @returns {module:kld-contours.BoundingBox2D}
396396
*/
397397

398398
}, {
@@ -419,7 +419,7 @@ function () {
419419
/**
420420
* getAlignedBoundingBox
421421
*
422-
* @returns {{ bbox: BoundingBox2D, transform: Matrix2D }}
422+
* @returns {{ bbox: module:kld-contours.BoundingBox2D, transform: module:kld-affine.Matrix2D }}
423423
*/
424424

425425
}, {
@@ -433,7 +433,7 @@ function () {
433433
/**
434434
* getAlignedBezier
435435
*
436-
* @returns {CubicBezier2D}
436+
* @returns {module:kld-contours.CubicBezier2D}
437437
*/
438438

439439
}, {
@@ -450,7 +450,7 @@ function () {
450450
* toPolygon2D
451451
*
452452
* @param {number} [flatness]
453-
* @returns {Polygon2D}
453+
* @returns {module:kld-contours.Polygon2D}
454454
*/
455455

456456
}, {
@@ -534,10 +534,10 @@ var Ellipse2D =
534534
/*#__PURE__*/
535535
function () {
536536
/**
537-
* @param {Point2D} center
537+
* @param {module:kld-affine.Point2D} center
538538
* @param {number} radiusX
539539
* @param {number} radiusY
540-
* @returns {Ellipse2D}
540+
* @returns {module:kld-contours.Ellipse2D}
541541
*/
542542
function Ellipse2D(center, radiusX, radiusY) {
543543
_classCallCheck(this, Ellipse2D);
@@ -549,7 +549,7 @@ function () {
549549
/**
550550
* getBoundingBox
551551
*
552-
* @returns {BoundingBox2D}
552+
* @returns {module:kld-contours.BoundingBox2D}
553553
*/
554554

555555

@@ -561,7 +561,7 @@ function () {
561561
/**
562562
* toPolygon2D
563563
*
564-
* @returns {Polygon2D}
564+
* @returns {module:kld-contours.Polygon2D}
565565
*/
566566

567567
}, {
@@ -582,9 +582,9 @@ var Line2D =
582582
/*#__PURE__*/
583583
function () {
584584
/**
585-
* @param {Point2D} p1
586-
* @param {Point2D} p2
587-
* @returns {Line2D}
585+
* @param {module:kld-affine.Point2D} p1
586+
* @param {module:kld-affine.Point2D} p2
587+
* @returns {module:kld-contours.Line2D}
588588
*/
589589
function Line2D(p1, p2) {
590590
_classCallCheck(this, Line2D);
@@ -595,7 +595,7 @@ function () {
595595
/**
596596
* getBoundingBox
597597
*
598-
* @returns {BoundingBox2D}
598+
* @returns {module:kld-contours.BoundingBox2D}
599599
*/
600600

601601

@@ -609,7 +609,7 @@ function () {
609609
/**
610610
* toPolygon2D
611611
*
612-
* @returns {Polygon2D}
612+
* @returns {module:kld-contours.Polygon2D}
613613
*/
614614

615615
}, {
@@ -630,10 +630,10 @@ var QuadraticBezier2D =
630630
/*#__PURE__*/
631631
function () {
632632
/**
633-
* @param {Point2D} p1
634-
* @param {Point2D} p2
635-
* @param {Point2D} p3
636-
* @returns {QuadraticBezier2D}
633+
* @param {module:kld-affine.Point2D} p1
634+
* @param {module:kld-affine.Point2D} p2
635+
* @param {module:kld-affine.Point2D} p3
636+
* @returns {module:kld-contours.QuadraticBezier2D}
637637
*/
638638
function QuadraticBezier2D(p1, p2, p3) {
639639
_classCallCheck(this, QuadraticBezier2D);
@@ -646,7 +646,7 @@ function () {
646646
* getPointAtParameter
647647
*
648648
* @param {number} t
649-
* @returns {Point2D}
649+
* @returns {module:kld-affine.Point2D}
650650
*/
651651

652652

@@ -663,7 +663,7 @@ function () {
663663
* splitAtParameter
664664
*
665665
* @param {number} t
666-
* @returns {Array<QuadraticBezier2D>}
666+
* @returns {Array<module:kld-contours.QuadraticBezier2D>}
667667
*/
668668

669669
}, {
@@ -679,7 +679,7 @@ function () {
679679
/**
680680
* getBernsteinPolynomials
681681
*
682-
* @returns {{x: Polynomial, y: Polynomial}}
682+
* @returns {{x: module:kld-polynomial.Polynomial, y: module:kld-polynomial.Polynomial}}
683683
*/
684684

685685
}, {
@@ -701,7 +701,7 @@ function () {
701701
/**
702702
* getArcLengthPolynomial
703703
*
704-
* @returns {SqrtPolynomial}
704+
* @returns {module:kld-polynomial.SqrtPolynomial}
705705
*/
706706

707707
}, {
@@ -771,7 +771,7 @@ function () {
771771
/**
772772
* getBoundingBox
773773
*
774-
* @returns {BoundingBox2D}
774+
* @returns {module:kld-contours.BoundingBox2D}
775775
*/
776776

777777
}, {
@@ -796,7 +796,7 @@ function () {
796796
/**
797797
* getAlignedBoundingBox
798798
*
799-
* @returns {{ bbox: BoundingBox2D, transform: Matrix2D }}
799+
* @returns {{ bbox: module:kld-contours.BoundingBox2D, transform: module:kld-affine.Matrix2D }}
800800
*/
801801

802802
}, {
@@ -810,7 +810,7 @@ function () {
810810
/**
811811
* getAlignedBezier
812812
*
813-
* @returns {QuadraticBezier2D}
813+
* @returns {module:kld-contours.QuadraticBezier2D}
814814
*/
815815

816816
}, {
@@ -827,7 +827,7 @@ function () {
827827
* toPolygon2D
828828
*
829829
* @param {number} [flatness]
830-
* @returns {Polygon2D}
830+
* @returns {module:kld-contours.Polygon2D}
831831
*/
832832

833833
}, {
@@ -903,7 +903,7 @@ function () {
903903
* @param {number} y
904904
* @param {number} width
905905
* @param {number} height
906-
* @returns {Rectangle2D}
906+
* @returns {module:kld-contours.Rectangle2D}
907907
*/
908908
function Rectangle2D(x, y, width, height) {
909909
_classCallCheck(this, Rectangle2D);
@@ -916,7 +916,7 @@ function () {
916916
/**
917917
* getBoundingBox
918918
*
919-
* @returns {BoundingBox2D}
919+
* @returns {module:kld-contours.BoundingBox2D}
920920
*/
921921

922922

@@ -928,7 +928,7 @@ function () {
928928
/**
929929
* toPolygon2D
930930
*
931-
* @returns {Polygon2D}
931+
* @returns {module:kld-contours.Polygon2D}
932932
*/
933933

934934
}, {

‎dist/index-esm.min.js.map

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)