jsdoc追加。

Author: satopian

chickenpaint/js/chickenpaint.js

@@ -3139,6 +3139,10 @@ export default class CPArtwork extends EventEmitter {
       }
     }
 
+    /**
+     * @class
+     * @extends {CPUndo}
+     */
     class CPActionTransformSelection extends CPUndo {
       constructor() {
         super();
@@ -3187,8 +3191,8 @@ export default class CPArtwork extends EventEmitter {
          *
          * We either have these full undos which cover the whole layer area:
          *
-         * @property {?CPColorBmp} imageUndo
-         * @property {?CPGreyBmp} maskUndo
+         * @property {?CPColorBmp} [imageUndo]
+         * @property {?CPGreyBmp} [maskUndo]
          *
          * Or else we have this map from rectangles to images which cover the dirtied areas only.
          *

chickenpaint/js/chickenpaint.min.js

@@ -61,7 +61,7 @@ async function performAction(mode, callback) {
 /**
  * データ消失防止のためDBに保存 (Save)
  * 画像データとパレットデータを保存する
- * @param {Uint8Array} bytes - .chi形式のバイナリ
+ * @param {Blob} bytes - .chi形式のBlobデータ
  * @param {Blob|null} swatchesBlob - パレットのBlobデータ
  */
 export async function CPPutChiAutosaveToDB(bytes, swatchesBlob) {

js/engine/CPArtwork.js

@@ -138,8 +138,15 @@ class ChibiLayerDecoder {
 
     this.colorDecoder = null;
     this.maskDecoder = null;
+    /** @type {boolean} */
+    this.clip = false;
   }
 
+  /**
+   * @returns {CPImageLayer|void}
+   */
+  createLayer() {}
+
   readFixedHeader(stream) {
     this.payloadOffset = stream.readU32BE();
 
@@ -754,12 +761,6 @@ function hasChibiMagicMarker(array) {
   return true;
 }
 
-/**
- * @typedef {Object} SerializeResult
- * @property {(Blob|Uint8Array)} SerializeResult.bytes - A Blob when called in the browser, or a Uint8Array in Node.
- * @property {String} SerializeResult.version - Version string of created artwork, "ChibiPaint v0.0" or "ChickenPaint v0.10"
- */
-
 // ループの合間に「ブラウザに息をつかせる」関数
 const yieldToMain = () => {
   return new Promise((resolve) => {
@@ -768,11 +769,16 @@ const yieldToMain = () => {
     channel.port2.postMessage(undefined);
   });
 };
+
 /**
  * Serialize the given artwork to Chibifile format.
+ * @typedef {Object} SerializeResult
+ * @property {(Blob)} SerializeResult.bytes - A Blob when called in the browser, or a Uint8Array in Node.
+ * @property {String} SerializeResult.version - Version string of created artwork, "ChibiPaint v0.0" or "ChickenPaint v0.10"
  *
  * @param {CPArtwork} artwork
  * @param {?Object} options
+ * @param {Object} [options] -
  * @param {boolean} options.forceOldVersion - Mark this as a version 0.0 (ChibiPaint) drawing even if it uses new features
  *
  * @returns {Promise.<SerializeResult>}

js/engine/CPChiAutosaveDB.js

@@ -485,22 +485,32 @@ CPColorBmp.prototype.createThumbnailFrom = function (that) {
  * - expandBy: 塗りつぶし範囲を拡張するピクセル数
  * - alpha255: 不透明度 (1-255)
  * - mergedData: 判定用に渡す全レイヤー合成結果 (Uint8ClampedArray)
- *   null の場合は現在のレイヤーを基準にする
+ *   空のオブジェクトの場合は現在のレイヤーを基準にする
+ *
+ * @param {number} x - 塗りつぶしを開始するX座標
+ * @param {number} y - 塗りつぶしを開始するY座標
+ * @param {number} fillColor - 塗りつぶす色（0xRRGGBB 形式の数値）
+ * @param {number} [expandBy=2] - 塗りつぶした領域を外側に拡張するピクセル数（縁取りの太さ）
+ * @param {number} [alpha255=255] - 塗りつぶす色の不透明度（0〜255）
+ * @param {Object} [fusion={}] - 統合画像の情報を含むオブジェクト
+ * @param {Uint8Array|Uint8ClampedArray} [fusion.data] - 塗りつぶし対象の判定元として使用する画像データ。未指定の場合は自身の `data` を参照。
+ * @returns {void}
  */
+
 CPColorBmp.prototype.floodFillWithBorder = function (
   x,
   y,
   fillColor,
   expandBy = 2,
   alpha255 = 255,
-  fusion = null,
+  fusion = {},
 ) {
   if (!this.isInside(x, y)) return;
 
   const w = this.width;
   const h = this.height;
   const data = this.data; // 書き込み先
-  const srcData = fusion ? fusion.data : data; // 判定元
+  const srcData = fusion && fusion.data ? fusion.data : data; // 判定元
   const BYTES = CPColorBmp.BYTES_PER_PIXEL;
 
   const fillR = (fillColor >> 16) & 0xff;
@@ -539,7 +549,9 @@ CPColorBmp.prototype.floodFillWithBorder = function (
 
   // flood fill 本体
   while (stack.length) {
-    const { x: px, y: py } = stack.pop();
+    const { x: px, y: py } = /** @type {{x: number, y: number}} */ (
+      stack.pop()
+    );
     if (!comparePixel(px, py)) continue;
 
     Processed[py * w + px] = 1;
@@ -2087,8 +2099,9 @@ CPColorBmp.prototype.getNonTransparentBounds = function (initialBounds) {
 /**
  * Returns a new canvas with a rotated version of the given canvas.
  *
- * @param {HTMLCanvasElement} canvas
+ * @param {any} canvas
  * @param {number} rotation - [0..3], selects a multiple of 90 degrees of clockwise rotation to be applied.
+ * @return {any}
  */
 export function getRotatedCanvas(canvas, rotation) {
   rotation = rotation % 4;
@@ -2165,7 +2178,7 @@ CPColorBmp.prototype.getAsCanvas = function (rotation) {
  * Rotation is [0..3] and selects a multiple of 90 degrees of clockwise rotation to be applied, or 0 to leave
  * unrotated.
  *
- * @returns {string} - "Binary string" representation of the PNG file
+ * @returns {string|false} - "Binary string" representation of the PNG file
  */
 CPColorBmp.prototype.getAsPNG = function (rotation) {
   let canvas = this.getAsCanvas(rotation);
@@ -2182,6 +2195,7 @@ CPColorBmp.prototype.getAsPNG = function (rotation) {
  * @returns {Buffer}
  */
 CPColorBmp.prototype.getAsPNGBuffer = function (rotation) {
+  /** @type {any} */
   let canvas = this.getAsCanvas(rotation);
 
   // API provided by node-canvas for running on Node (browsers don't support this)
@@ -2233,7 +2247,7 @@ CPColorBmp.prototype.hasAlpha = function () {
 /**
  * Create from a loaded HTML Image object
  *
- * @param {HTMLImageElement} image
+ * @param {any} image
  */
 CPColorBmp.createFromImage = function (image) {
   var imageCanvas = createCanvas(image.width, image.height),

js/engine/CPChibiFile.js

@@ -204,7 +204,9 @@ CPGreyBmp.prototype.floodFillWithBorder = function (
   const stack = [{ x, y }];
 
   while (stack.length) {
-    const { x: px, y: py } = stack.pop();
+    const { x: px, y: py } = /** @type {{x: number, y: number}} */ (
+      stack.pop()
+    );
     if (px < 0 || py < 0 || px >= w || py >= h) continue;
     const idx = py * w + px;
     if (Processed[idx]) continue;
@@ -380,7 +382,7 @@ CPGreyBmp.prototype.getAsCanvas = function (imageRotation) {
  * @param {number} width
  * @param {number} height
  *
- * @returns {ImageData}
+ * @returns {any}
  */
 CPGreyBmp.prototype.getImageData = function (x, y, width, height) {
   let imageData = createImageData(width, height),
@@ -615,7 +617,7 @@ function boxBlurLine(src, dst, len, radius) {
  * @param {number} x X-coordinate of column
  * @param {number} y Y-coordinate of top of column to copy
  * @param {number} len Number of pixels to copy
- * @param {TypedArray} buffer Pixel array
+ * @param {Uint8Array|Uint8ClampedArray} buffer Pixel array
  */
 CPGreyBmp.prototype.copyPixelColumnToArray = function (x, y, len, buffer) {
   var yJump = this.width,
@@ -636,7 +638,7 @@ CPGreyBmp.prototype.copyPixelColumnToArray = function (x, y, len, buffer) {
  * @param {number} x X-coordinate of column
  * @param {number} y Y-coordinate of top of column to copy
  * @param {number} len Number of pixels to copy
- * @param {TypedArray} buffer Pixel array to copy from
+ * @param {Uint8Array|Uint8ClampedArray} buffer Pixel array to copy from
  */
 CPGreyBmp.prototype.copyArrayToPixelColumn = function (x, y, len, buffer) {
   var yJump = this.width,
@@ -760,7 +762,6 @@ CPGreyBmp.prototype.monoHalftone = function (
 
   const w = this.width;
   const h = this.height;
-  const B = CPGreyBmp.BYTES_PER_PIXEL; // = 1
 
   const src = new Uint8ClampedArray(this.data);
   const dst = new Uint8ClampedArray(this.data.length);

js/engine/CPColorBmp.js

@@ -42,8 +42,7 @@ import CPRect from "../util/CPRect.js";
  *
  * @constructor
  * @extends CPLayer
- * @this{typeof CPImageLayer
- *  & Record<string, any>}
+ * @this {any}
  */
 export default class CPImageLayer extends CPLayer {
   constructor(width, height, name) {

js/engine/CPGreyBmp.js

@@ -159,6 +159,10 @@ CPLayer.prototype.copyFrom = function (layer) {
   }
 };
 
+/**
+ * @memberof CPLayer
+ * @param {CPGreyBmp|null} mask
+ */
 CPLayer.prototype.setMask = function (mask) {
   this.mask = mask;
   if (!mask) {

js/engine/CPImageLayer.js

@@ -248,17 +248,17 @@ export default class CPResourceSaver extends EventEmitter {
       const savedb = save_options.savedb ?? false;
       const savedbFromMenu = save_options.savedbFromMenu ?? false;
 
-      var flat, flatBlob, swatchesBlob;
-
-      flat = !savedb
-        ? binaryStringToByteArray(options.artwork.getFlatPNG(options.rotation))
-        : null;
-      flatBlob = !savedb ? new Blob([flat], { type: "image/png" }) : null;
-      flat = null; // Don't need this any more
-
+      let flat = null;
+      let flatBlob = null;
+      let swatchesBlob;
       if (!savedb) {
+        flat = binaryStringToByteArray(
+          options.artwork.getFlatPNG(options.rotation),
+        );
+        flatBlob = new Blob([flat], { type: "image/png" });
         reportProgress(0.3); // 開始
       }
+      flat = null; // Don't need this any more
 
       var serializeLayers;
 
@@ -280,9 +280,12 @@ export default class CPResourceSaver extends EventEmitter {
           if (options.swatches) {
             var aco = new AdobeColorTable();
 
-            swatchesBlob = new Blob([aco.write(options.swatches)], {
-              type: "application/octet-stream",
-            });
+            swatchesBlob = new Blob(
+              [/** @type {any} */ (aco.write(options.swatches))],
+              {
+                type: "application/octet-stream",
+              },
+            );
           } else {
             swatchesBlob = null;
           }
@@ -300,7 +303,6 @@ export default class CPResourceSaver extends EventEmitter {
 
             if (chibiResult) {
               formData.append("chibifileFormat", chibiResult.version);
-
               formData.append("chibifile", chibiResult.bytes);
               chibiResult = null;