- Docs: Use jsdoc modules

index.js

@@ -1,9 +1,66 @@
+/**
+ * @module kld-intersections
+ */
 // expose module classes
+
 export {default as Intersection} from "./lib/Intersection.js";
+
 export {default as IntersectionArgs} from "./lib/IntersectionArgs.js";
+
+/**
+ * @namespace Shapes
+ * @implements {module:Shapes~Shapes}
+ */
 export {default as Shapes} from "./lib/Shapes.js";
+
+/**
+ * @namespace AffineShapes
+ * @implements {module:AffineShapes~AffineShapes}
+ */
 export {default as AffineShapes} from "./lib/AffineShapes.js";
+
+/**
+ * @namespace IntersectionQuery
+ * @implements {module:IntersectionQuery~IntersectionQuery}
+ */
 export {default as IntersectionQuery} from "./lib/IntersectionQuery.js";
 
-// expose affine module classes
-export {Point2D, Vector2D, Matrix2D} from "kld-affine";
+// Expose affine module classes
+
+/**
+* @external Point2D
+*/
+
+/**
+* @external Vector2D
+*/
+
+/**
+* @external Matrix2D
+*/
+
+/**
+ * @class Point2D
+ * @memberof module:kld-intersections
+ * @implements {external:Point2D}
+ */
+export {Point2D} from "kld-affine";
+
+/**
+ * @class Vector2D
+ * @memberof module:kld-intersections
+ * @implements {external:Vector2D}
+ */
+export {Vector2D} from "kld-affine";
+
+/**
+ * @class Matrix2D
+ * @memberof module:kld-intersections
+ * @implements {external:Matrix2D}
+ */
+export {Matrix2D} from "kld-affine";
+
+
+/**
+* @external Polynomial
+*/

lib/AffineShapes.js

@@ -2,19 +2,22 @@
  *  AffineShapes
  *
  *  @copyright 2017, Kevin Lindsey
+ *  @module AffineShapes
  */
 
 import IntersectionArgs from "./IntersectionArgs.js";
 
+/**
+ * @namespace
+ */
 const AffineShapes = {};
 
 /**
  *  quadraticBezier
- *
- *  @param {Point2D} p1
- *  @param {Point2D} p2
- *  @param {Point2D} p3
- *  @returns {IntersectionArgs}
+ *  @param {module:kld-intersections.Point2D} p1
+ *  @param {module:kld-intersections.Point2D} p2
+ *  @param {module:kld-intersections.Point2D} p3
+ *  @returns {module:kld-intersections.IntersectionArgs}
  */
 AffineShapes.quadraticBezier = function(p1, p2, p3) {
     return new IntersectionArgs("Bezier2", [p1, p2, p3]);
@@ -24,11 +27,11 @@ AffineShapes.quadraticBezier = function(p1, p2, p3) {
 /**
  *  cubicBezier
  *
- *  @param {Point2D} p1
- *  @param {Point2D} p2
- *  @param {Point2D} p3
- *  @param {Point2D} p4
- *  @returns {IntersectionArgs}
+ *  @param {module:kld-intersections.Point2D} p1
+ *  @param {module:kld-intersections.Point2D} p2
+ *  @param {module:kld-intersections.Point2D} p3
+ *  @param {module:kld-intersections.Point2D} p4
+ *  @returns {module:kld-intersections.IntersectionArgs}
  */
 AffineShapes.cubicBezier = function(p1, p2, p3, p4) {
     return new IntersectionArgs("Bezier3", [p1, p2, p3, p4]);
@@ -38,9 +41,9 @@ AffineShapes.cubicBezier = function(p1, p2, p3, p4) {
 /**
  *  circle
  *
- *  @param {Point2D} center
+ *  @param {module:kld-intersections.Point2D} center
  *  @param {number} radius
- *  @returns {IntersectionArgs}
+ *  @returns {module:kld-intersections.IntersectionArgs}
  */
 AffineShapes.circle = function(center, radius) {
     return new IntersectionArgs("Circle", [center, radius]);
@@ -50,10 +53,10 @@ AffineShapes.circle = function(center, radius) {
 /**
  *  ellipse
  *
- *  @param {Point2D} center
+ *  @param {module:kld-intersections.Point2D} center
  *  @param {number} radiusX
  *  @param {number} radiusY
- *  @returns {IntersectionArgs}
+ *  @returns {module:kld-intersections.IntersectionArgs}
  */
 AffineShapes.ellipse = function(center, radiusX, radiusY) {
     return new IntersectionArgs("Ellipse", [center, radiusX, radiusY]);
@@ -63,9 +66,9 @@ AffineShapes.ellipse = function(center, radiusX, radiusY) {
 /**
  *  line
  *
- *  @param {Point2D} p1
- *  @param {Point2D} p2
- *  @returns {IntersectionArgs}
+ *  @param {module:kld-intersections.Point2D} p1
+ *  @param {module:kld-intersections.Point2D} p2
+ *  @returns {module:kld-intersections.IntersectionArgs}
  */
 AffineShapes.line = function(p1, p2) {
     return new IntersectionArgs("Line", [p1, p2]);
@@ -75,8 +78,8 @@ AffineShapes.line = function(p1, p2) {
 /**
  *  path
  *
- *  @param {Array<AffineShapes>} segments
- *  @returns {IntersectionArgs}
+ *  @param {Array<module:kld-intersections.AffineShapes>} segments
+ *  @returns {module:kld-intersections.IntersectionArgs}
  */
 AffineShapes.path = function(segments) {
     return new IntersectionArgs("Path", [segments]);
@@ -86,8 +89,8 @@ AffineShapes.path = function(segments) {
 /**
  *  polygon
  *
- *  @param {Array<Point2D>} points
- *  @returns {IntersectionArgs}
+ *  @param {Array<module:kld-intersections.Point2D>} points
+ *  @returns {module:kld-intersections.IntersectionArgs}
  */
 AffineShapes.polygon = function(points) {
     return new IntersectionArgs("Polygon", [points]);
@@ -97,8 +100,8 @@ AffineShapes.polygon = function(points) {
 /**
  *  polyline
  *
- *  @param {Array<Point2D>} points
- *  @returns {IntersectionArgs}
+ *  @param {Array<module:kld-intersections.Point2D>} points
+ *  @returns {module:kld-intersections.IntersectionArgs}
  */
 AffineShapes.polyline = function(points) {
     return new IntersectionArgs("Polyline", [points]);
@@ -108,9 +111,9 @@ AffineShapes.polyline = function(points) {
 /**
  *  rectangle
  *
- *  @param {Point2D} topLeft
- *  @param {Vector2D} size
- *  @returns {IntersectionArgs}
+ *  @param {module:kld-intersections.Point2D} topLeft
+ *  @param {module:kld-intersections.Vector2D} size
+ *  @returns {module:kld-intersections.IntersectionArgs}
  */
 AffineShapes.rectangle = function(topLeft, size) {
     return new IntersectionArgs("Rectangle", [topLeft, topLeft.add(size)]);