Updated JSDoc.

Author: dmester

index.js

@@ -30,7 +30,7 @@ module.exports = {
     /**
      * Creates a new canvas.
      * @param {number} width  Width of the canvas in pixels.
-     * @param {number} heigt  Height of the canvas in pixels.
+     * @param {number} heigth  Height of the canvas in pixels.
      * @returns {Canvas}
      */
     createCanvas: function (width, height) {

lib/canvas.js

@@ -23,8 +23,8 @@
  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE 
  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
- 
- "use strict";
+
+"use strict";
 
 const EdgeTable = require("./rasterization/edgeTable");
 const rasterizer = require("./rasterization/rasterizer");
@@ -38,7 +38,6 @@ const colorUtils = require("./colorUtils");
  * @param {number} width  Canvas width in pixels.
  * @param {number} height  Canvas height in pixels.
  * @constructor
- * @public
  */
 function Canvas(width, height) {
     this.width = width;
@@ -49,42 +48,51 @@ function Canvas(width, height) {
 /**
  * The width of the canvas in pixels.
  * @type {number}
- * @public
  */
 Canvas.prototype.width = 0;
 
 /**
  * The height of the canvas in pixels.
  * @type {number}
- * @public
  */
 Canvas.prototype.height = 0;
 
 /**
- * Specifies the background color. Allowed values are:
- * - 32 bit integers on the format 0xRRGGBBAA
- * - strings on the format #RGB
- * - strings on the format #RRGGBB
- * - strings on the format #RRGGBBAA
- * @type {number}
- * @public
+ * Specifies the background color. Default is fully transparent. Allowed values are:
+ * - 32 bit integers on the format `0xRRGGBBAA`
+ * - strings on the format `"#RGB"`
+ * - strings on the format `"#RGBA"`
+ * - strings on the format `"#RRGGBB"`
+ * - strings on the format `"#RRGGBBAA"`
+ * - strings on the format `"rgb(255, 255, 255)"`
+ * - strings on the format `"rgb(255, 255, 255, 0.5)"`
+ * - strings on the format `"rgb(255, 255, 255, 50%)"`
+ * - strings on the format `"rgba(255, 255, 255, 0.5)"`
+ * - strings on the format `"rgba(255, 255, 255, 50%)"`
+ * - strings on the format `"hsl(134, 50%, 50%)"`
+ * - strings on the format `"hsl(134, 50%, 50%, 0.5)"`
+ * - strings on the format `"hsl(134, 50%, 50%, 50%)"`
+ * - strings on the format `"hsla(134, 50%, 50%, 0.5)"`
+ * - strings on the format `"hsla(134, 50%, 50%, 50%)"`
+ * - strings on the format `"hwb(134, 50%, 50%)"`
+ * - strings on the format `"hwb(134, 50%, 50%, 0.5)"`
+ * - strings on the format `"hwb(134, 50%, 50%, 50%)"`
+ * @type {string|number}
  */
 Canvas.prototype.backColor = 0x00000000;
 
 /**
  * Gets a context used to draw polygons on this canvas.
  * @returns {CanvasContext}
- * @public
  */
 Canvas.prototype.getContext = function Canvas_getContext() {
     return new CanvasContext(this);
 };
 
 /**
  * Renders the canvas as a PNG data stream.
- * @param {Object} keywords  Keywords to be written to the PNG stream. See https://www.w3.org/TR/PNG/#11keywords.
+ * @param {Object} [keywords]  Keywords to be written to the PNG stream. See https://www.w3.org/TR/PNG/#11keywords.
  * @returns {Buffer}
- * @public
  */
 Canvas.prototype.toPng = function Canvas_toPng(keywords) {
     var backColor = colorUtils.parse(this.backColor);
@@ -119,9 +127,8 @@ Canvas.prototype.toPng = function Canvas_toPng(keywords) {
 };
 
 /**
- * Renders the canvas as a data URI. Only type 'image/png' is supported.
+ * Renders the canvas as a data URI. Only type `"image/png"` is supported.
  * @returns {string}
- * @public
  */
 Canvas.prototype.toDataURL = function Canvas_toDataURL() {
     if (this.width <= 0 || this.height <= 0) {

lib/canvasContext.js

@@ -33,7 +33,6 @@ const canvasState = require("./canvasState");
 
 /**
  * Creates a new canvas with the specified dimensions given in pixels.
- * @public
  */
 function CanvasContext(canvas) {
     this.canvas = canvas;
@@ -48,39 +47,41 @@ function CanvasContext(canvas) {
 
 /**
  * Specifies the fill color that is used when the fill method is called. Allowed values are:
- * - 32 bit integers on the format 0xRRGGBBAA
- * - strings on the format #RGB
- * - strings on the format #RGBA
- * - strings on the format #RRGGBB
- * - strings on the format #RRGGBBAA
- * - strings on the format rgb(255, 255, 255)
- * - strings on the format rgb(255, 255, 255, 0.5)
- * - strings on the format rgb(255, 255, 255, 50%)
- * - strings on the format rgba(255, 255, 255, 0.5)
- * - strings on the format rgba(255, 255, 255, 50%)
- * - strings on the format hsl(134, 50%, 50%)
- * - strings on the format hsl(134, 50%, 50%, 0.5)
- * - strings on the format hsl(134, 50%, 50%, 50%)
- * - strings on the format hsla(134, 50%, 50%, 0.5)
- * - strings on the format hsla(134, 50%, 50%, 50%)
- * - strings on the format hwb(134, 50%, 50%)
- * - strings on the format hwb(134, 50%, 50%, 0.5)
- * - strings on the format hwb(134, 50%, 50%, 50%)
- * @public
+ * - 32 bit integers on the format `0xRRGGBBAA`
+ * - strings on the format `"#RGB"`
+ * - strings on the format `"#RGBA"`
+ * - strings on the format `"#RRGGBB"`
+ * - strings on the format `"#RRGGBBAA"`
+ * - strings on the format `"rgb(255, 255, 255)"`
+ * - strings on the format `"rgb(255, 255, 255, 0.5)"`
+ * - strings on the format `"rgb(255, 255, 255, 50%)"`
+ * - strings on the format `"rgba(255, 255, 255, 0.5)"`
+ * - strings on the format `"rgba(255, 255, 255, 50%)"`
+ * - strings on the format `"hsl(134, 50%, 50%)"`
+ * - strings on the format `"hsl(134, 50%, 50%, 0.5)"`
+ * - strings on the format `"hsl(134, 50%, 50%, 50%)"`
+ * - strings on the format `"hsla(134, 50%, 50%, 0.5)"`
+ * - strings on the format `"hsla(134, 50%, 50%, 50%)"`
+ * - strings on the format `"hwb(134, 50%, 50%)"`
+ * - strings on the format `"hwb(134, 50%, 50%, 0.5)"`
+ * - strings on the format `"hwb(134, 50%, 50%, 50%)"`
+ * @type {string|number}
  */
 CanvasContext.prototype.fillStyle = 0x000000ff;
 
 /**
- * Saves the current state to the state stack.
- * @public
+ * Saves the current drawing state to a stack. The state can later be restored by calling `CanvasContext.restore()`.
+ * 
+ * The following state is included when being saved to the stack:
+ * - Current transformation matrix
+ * - Current fill style
  */
 CanvasContext.prototype.save = function CanvasContext_save() {
     this._savedStates.push(canvasState.capture(this));
 };
 
 /**
- * Restores the last saved state of the CanvasContext.
- * @public
+ * Restores the last drawing state that was saved with `CanvasContext.save()`, and then removes it from the state stack.
  */
 CanvasContext.prototype.restore = function CanvasContext_restore() {
     if (this._savedStates.length) {
@@ -89,16 +90,14 @@ CanvasContext.prototype.restore = function CanvasContext_restore() {
 };
 
 /**
- * Resets the internal path buffer and begins a new path.
- * @public
+ * Restores the current transformation to the identity matrix.
  */
 CanvasContext.prototype.resetTransform = function CanvasContext_resetTransform() {
     this._transform = new Matrix(1, 0, 0, 1, 0, 0);
 };
 
 /**
  * Multiplies the current transformation matrix with the specified values.
- * @public
  */
 CanvasContext.prototype.transform = function CanvasContext_transform(a, b, c, d, e, f) {
     if (!Number.isFinite(a) ||
@@ -115,7 +114,6 @@ CanvasContext.prototype.transform = function CanvasContext_transform(a, b, c, d,
 
 /**
  * Sets the transformation matrix to the specified matrix.
- * @public
  */
 CanvasContext.prototype.setTransform = function CanvasContext_transform(a, b, c, d, e, f) {
     if (!Number.isFinite(a) ||
@@ -131,10 +129,9 @@ CanvasContext.prototype.setTransform = function CanvasContext_transform(a, b, c,
 };
 
 /**
- * Applies a translation transformation to the CanvasContext.
+ * Applies a translation transformation on top of the current transform.
  * @param {number} x  Distance to move in the horizontal direction in pixels.
  * @param {number} y  Distance to move in the vertical direction in pixels.
- * @public
  */
 CanvasContext.prototype.translate = function CanvasContext_translate(x, y) {
     if (!Number.isFinite(x) || !Number.isFinite(y)) {
@@ -145,10 +142,9 @@ CanvasContext.prototype.translate = function CanvasContext_translate(x, y) {
 };
 
 /**
- * Applies a scale transformation to the CanvasContext.
- * @param {number} x  Scale in the horizontal direction. 1 means no scale.
- * @param {number} y  Scale in the vertical direction. 1 means no scale.
- * @public
+ * Applies a scale transformation on top of the current transform.
+ * @param {number} x  Scale in the horizontal direction. `1` means no horizontal scaling.
+ * @param {number} y  Scale in the vertical direction. `1` means no vertical scaling.
  */
 CanvasContext.prototype.scale = function CanvasContext_scale(x, y) {
     if (!Number.isFinite(x) || !Number.isFinite(y)) {
@@ -159,9 +155,8 @@ CanvasContext.prototype.scale = function CanvasContext_scale(x, y) {
 };
 
 /**
- * Applies a rotation transformation to the canvas around its current origo.
+ * Applies a rotation transformation on top of the current transform around the current canvas origo.
  * @param {number} angle  Angle in radians measured clockwise from the positive x axis.
- * @public
  */
 CanvasContext.prototype.rotate = function CanvasContext_rotate(angle) {
     if (!Number.isFinite(angle)) {
@@ -173,15 +168,13 @@ CanvasContext.prototype.rotate = function CanvasContext_rotate(angle) {
 
 /**
  * Removes all existing subpaths and begins a new path.
- * @public
  */
 CanvasContext.prototype.beginPath = function CanvasContext_beginPath() {
     this._paths = [];
 };
 
 /**
  * Starts a new subpath that begins in the same point as the start and end point of the previous one.
- * @public
  */
 CanvasContext.prototype.closePath = function CanvasContext_closePath() {
     if (this._paths.length) {
@@ -204,7 +197,6 @@ CanvasContext.prototype.closePath = function CanvasContext_closePath() {
  * Begins a new subpath by moving the cursor to the specified position.
  * @param {number} x  X coordinate.
  * @param {number} y  Y coordinate.
- * @public
  */
 CanvasContext.prototype.moveTo = function CanvasContext_moveTo(x, y) {
     if (!Number.isFinite(x) || !Number.isFinite(y)) {
@@ -219,7 +211,6 @@ CanvasContext.prototype.moveTo = function CanvasContext_moveTo(x, y) {
  * Inserts an edge between the last and specified position.
  * @param {number} x  Target X coordinate.
  * @param {number} y  Target Y coordinate.
- * @public
  */
 CanvasContext.prototype.lineTo = function CanvasContext_lineTo(x, y) {
     if (!Number.isFinite(x) || !Number.isFinite(y)) {
@@ -243,7 +234,7 @@ CanvasContext.prototype.lineTo = function CanvasContext_lineTo(x, y) {
  * @param {number} radius  Radius of the arc.
  * @param {number} startAngle  The angle in radians at which the arc starts, measured clockwise from the positive x axis.
  * @param {number} endAngle  The angle in radians at which the arc end, measured clockwise from the positive x axis.
- * @param {Boolean} anticlockwise  Specifies whether the arc will be drawn counter clockwise. Default is clockwise.
+ * @param {boolean} [anticlockwise]  Specifies whether the arc will be drawn counter clockwise. Default is clockwise.
  */
 CanvasContext.prototype.arc = function CanvasContext_arc(x, y, radius, startAngle, endAngle, anticlockwise) {
     if (!Number.isFinite(x) || !Number.isFinite(y) ||
@@ -304,12 +295,11 @@ CanvasContext.prototype.arc = function CanvasContext_arc(x, y, radius, startAngl
 };
 
 /**
- * Fills the specified rectangle with fully transparent black without affecting the current paths.
+ * Fills a specified rectangle with fully transparent black without blending with the background or affecting the current paths.
  * @param {number} x  X coordinate of the left side of the rectangle.
  * @param {number} y  Y coordinate of the top of the rectangle.
  * @param {number} width  Width of the rectangle.
  * @param {number} height  Height of the rectangle.
- * @public
  */
 CanvasContext.prototype.clearRect = function CanvasContext_clearRect(x, y, width, height) {
     var fullCanvas = false;
@@ -336,12 +326,11 @@ CanvasContext.prototype.clearRect = function CanvasContext_clearRect(x, y, width
 };
 
 /**
- * Fills the specified rectangle without affecting the current paths.
+ * Fills a specified rectangle without affecting the current paths.
  * @param {number} x  X coordinate of the left side of the rectangle.
  * @param {number} y  Y coordinate of the top of the rectangle.
  * @param {number} width  Width of the rectangle.
  * @param {number} height  Height of the rectangle.
- * @public
  */
 CanvasContext.prototype.fillRect = function CanvasContext_fillRect(x, y, width, height) {
     var fillColor = colorUtils.parse(this.fillStyle);
@@ -379,9 +368,8 @@ CanvasContext.prototype._fillRect = function CanvasContext__fillRect(fillColor,
 /**
  * Fills the defined paths.
  * @param {string} [windingRule]  The winding rule to be used for determining
- * which areas are covered by the current path. Valid values are "evenodd" and
- * "nonzero". Default is "nonzero".
- * @public
+ *     which areas are covered by the current path. Valid values are "evenodd" and
+ *     "nonzero". Default is `"nonzero"`.
  */
 CanvasContext.prototype.fill = function CanvasContext_fill(windingRule) {
     var id = this._edges.nextId++;

lib/canvasState.js

@@ -29,7 +29,6 @@
 /**
  * Captures the current state of a specified canvas context.
  * @param {CanvasContext} ctx  Canvas context whose state will be captured.
- * @public
  */
 function canvasState_capture(ctx) {
     return {
@@ -42,7 +41,6 @@ function canvasState_capture(ctx) {
  * Restores the specified canvas state.
  * @param {CanvasContext} ctx  Canvas context whose state will be restored.
  * @param {CanvasState} state  State to restore.
- * @public
  */
 function canvasState_restore(ctx, state) {
     ctx.fillStyle = state.fillStyle;