diff --git a/CHANGELOG.md b/CHANGELOG.md index 7fb9ccedd26..16afeece2f0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,7 @@ ## [next] +- docs(): Add tsdoc tag to remove inheritance from docs [#9486](https://github.com/fabricjs/fabric.js/pull/9486) - feat(Next.js sandbox): simpler canvas hook [#9577](https://github.com/fabricjs/fabric.js/pull/9577) - fix(): fix modify polygon points with zero sized polygons ( particular case of axis oriented lines ) [#9575](https://github.com/fabricjs/fabric.js/pull/9575) - fix(Polyline, Polygon): Fix wrong pathOffset for polyline with the normal bounding box calculation. [#9460](https://github.com/fabricjs/fabric.js/pull/9460) diff --git a/package-lock.json b/package-lock.json index 294ff19c61d..f7bc302d57e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "fabric", - "version": "6.0.0-beta15", + "version": "6.0.0-beta17", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "fabric", - "version": "6.0.0-beta15", + "version": "6.0.0-beta17", "license": "MIT", "devDependencies": { "@babel/cli": "^7.22.9", @@ -58,6 +58,7 @@ "tslib": "^2.4.1", "typedoc": "^0.25.3", "typedoc-plugin-markdown": "^3.17.0", + "typedoc-plugin-no-inherit": "^1.4.0", "typescript": "^4.9.4", "v8-to-istanbul": "^9.1.0" }, @@ -11060,9 +11061,9 @@ "license": "MIT" }, "node_modules/shiki": { - "version": "0.14.3", - "resolved": "https://registry.npmjs.org/shiki/-/shiki-0.14.3.tgz", - "integrity": "sha512-U3S/a+b0KS+UkTyMjoNojvTgrBHjgp7L6ovhFVZsXmBGnVdQ4K4U9oK0z63w538S91ATngv1vXigHCSWOwnr+g==", + "version": "0.14.7", + "resolved": "https://registry.npmjs.org/shiki/-/shiki-0.14.7.tgz", + "integrity": "sha512-dNPAPrxSc87ua2sKJ3H5dQ/6ZaY8RNnaAqK+t0eG7p0Soi2ydiqbGOTaZCqaYvA/uZYfS1LJnemt3Q+mSfcPCg==", "dev": true, "dependencies": { "ansi-sequence-parser": "^1.1.0", @@ -11761,15 +11762,15 @@ } }, "node_modules/typedoc": { - "version": "0.25.3", - "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.25.3.tgz", - "integrity": "sha512-Ow8Bo7uY1Lwy7GTmphRIMEo6IOZ+yYUyrc8n5KXIZg1svpqhZSWgni2ZrDhe+wLosFS8yswowUzljTAV/3jmWw==", + "version": "0.25.6", + "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.25.6.tgz", + "integrity": "sha512-1rdionQMpOkpA58qfym1J+YD+ukyA1IEIa4VZahQI2ZORez7dhOvEyUotQL/8rSoMBopdzOS+vAIsORpQO4cTA==", "dev": true, "dependencies": { "lunr": "^2.3.9", "marked": "^4.3.0", "minimatch": "^9.0.3", - "shiki": "^0.14.1" + "shiki": "^0.14.7" }, "bin": { "typedoc": "bin/typedoc" @@ -11778,13 +11779,13 @@ "node": ">= 16" }, "peerDependencies": { - "typescript": "4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x || 5.1.x || 5.2.x" + "typescript": "4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x || 5.1.x || 5.2.x || 5.3.x" } }, "node_modules/typedoc-plugin-markdown": { - "version": "3.17.0", - "resolved": "https://registry.npmjs.org/typedoc-plugin-markdown/-/typedoc-plugin-markdown-3.17.0.tgz", - "integrity": "sha512-+uh5fHNfNSGdUxae0FWOuJ8Xu9Sl08jkdshOg6dilAqN/ZXmYsUFFDKw70fYfiGxdCLvpUuyr9FYO+WAa2lHeA==", + "version": "3.17.1", + "resolved": "https://registry.npmjs.org/typedoc-plugin-markdown/-/typedoc-plugin-markdown-3.17.1.tgz", + "integrity": "sha512-QzdU3fj0Kzw2XSdoL15ExLASt2WPqD7FbLeaqwT70+XjKyTshBnUlQA5nNREO1C2P8Uen0CDjsBLMsCQ+zd0lw==", "dev": true, "dependencies": { "handlebars": "^4.7.7" @@ -11793,6 +11794,15 @@ "typedoc": ">=0.24.0" } }, + "node_modules/typedoc-plugin-no-inherit": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/typedoc-plugin-no-inherit/-/typedoc-plugin-no-inherit-1.4.0.tgz", + "integrity": "sha512-cAvqQ8X9xh1xztVoDKtF4nYRSBx9XwttN3OBbNNpA0YaJSRM8XvpVVhugq8FoO1HdWjF3aizS0JzdUOMDt0y9g==", + "dev": true, + "peerDependencies": { + "typedoc": ">=0.23.0" + } + }, "node_modules/typedoc/node_modules/brace-expansion": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", @@ -19840,9 +19850,9 @@ "dev": true }, "shiki": { - "version": "0.14.3", - "resolved": "https://registry.npmjs.org/shiki/-/shiki-0.14.3.tgz", - "integrity": "sha512-U3S/a+b0KS+UkTyMjoNojvTgrBHjgp7L6ovhFVZsXmBGnVdQ4K4U9oK0z63w538S91ATngv1vXigHCSWOwnr+g==", + "version": "0.14.7", + "resolved": "https://registry.npmjs.org/shiki/-/shiki-0.14.7.tgz", + "integrity": "sha512-dNPAPrxSc87ua2sKJ3H5dQ/6ZaY8RNnaAqK+t0eG7p0Soi2ydiqbGOTaZCqaYvA/uZYfS1LJnemt3Q+mSfcPCg==", "dev": true, "requires": { "ansi-sequence-parser": "^1.1.0", @@ -20329,15 +20339,15 @@ } }, "typedoc": { - "version": "0.25.3", - "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.25.3.tgz", - "integrity": "sha512-Ow8Bo7uY1Lwy7GTmphRIMEo6IOZ+yYUyrc8n5KXIZg1svpqhZSWgni2ZrDhe+wLosFS8yswowUzljTAV/3jmWw==", + "version": "0.25.6", + "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.25.6.tgz", + "integrity": "sha512-1rdionQMpOkpA58qfym1J+YD+ukyA1IEIa4VZahQI2ZORez7dhOvEyUotQL/8rSoMBopdzOS+vAIsORpQO4cTA==", "dev": true, "requires": { "lunr": "^2.3.9", "marked": "^4.3.0", "minimatch": "^9.0.3", - "shiki": "^0.14.1" + "shiki": "^0.14.7" }, "dependencies": { "brace-expansion": { @@ -20361,14 +20371,21 @@ } }, "typedoc-plugin-markdown": { - "version": "3.17.0", - "resolved": "https://registry.npmjs.org/typedoc-plugin-markdown/-/typedoc-plugin-markdown-3.17.0.tgz", - "integrity": "sha512-+uh5fHNfNSGdUxae0FWOuJ8Xu9Sl08jkdshOg6dilAqN/ZXmYsUFFDKw70fYfiGxdCLvpUuyr9FYO+WAa2lHeA==", + "version": "3.17.1", + "resolved": "https://registry.npmjs.org/typedoc-plugin-markdown/-/typedoc-plugin-markdown-3.17.1.tgz", + "integrity": "sha512-QzdU3fj0Kzw2XSdoL15ExLASt2WPqD7FbLeaqwT70+XjKyTshBnUlQA5nNREO1C2P8Uen0CDjsBLMsCQ+zd0lw==", "dev": true, "requires": { "handlebars": "^4.7.7" } }, + "typedoc-plugin-no-inherit": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/typedoc-plugin-no-inherit/-/typedoc-plugin-no-inherit-1.4.0.tgz", + "integrity": "sha512-cAvqQ8X9xh1xztVoDKtF4nYRSBx9XwttN3OBbNNpA0YaJSRM8XvpVVhugq8FoO1HdWjF3aizS0JzdUOMDt0y9g==", + "dev": true, + "requires": {} + }, "typescript": { "version": "4.9.4", "dev": true diff --git a/package.json b/package.json index 12426a11656..f21a54a945e 100644 --- a/package.json +++ b/package.json @@ -124,6 +124,7 @@ "tslib": "^2.4.1", "typedoc": "^0.25.3", "typedoc-plugin-markdown": "^3.17.0", + "typedoc-plugin-no-inherit": "^1.4.0", "typescript": "^4.9.4", "v8-to-istanbul": "^9.1.0" }, diff --git a/src/shapes/Polyline.ts b/src/shapes/Polyline.ts index 6909fe6499f..601a7088baf 100644 --- a/src/shapes/Polyline.ts +++ b/src/shapes/Polyline.ts @@ -30,6 +30,9 @@ export interface SerializedPolylineProps extends SerializedObjectProps { points: XY[]; } +/** + * @noInheritDoc + */ export class Polyline< Props extends TOptions = Partial, SProps extends SerializedPolylineProps = SerializedPolylineProps, diff --git a/src/shapes/Rect.ts b/src/shapes/Rect.ts index 711f69cde3a..65d54a76a4d 100644 --- a/src/shapes/Rect.ts +++ b/src/shapes/Rect.ts @@ -26,6 +26,9 @@ export interface RectProps extends FabricObjectProps, UniqueRectProps {} const RECT_PROPS = ['rx', 'ry'] as const; +/** + * @noInheritDoc + */ export class Rect< Props extends TOptions = Partial, SProps extends SerializedRectProps = SerializedRectProps, diff --git a/typedoc.json b/typedoc.json index a108f5a67c8..9f3d9088c88 100644 --- a/typedoc.json +++ b/typedoc.json @@ -7,6 +7,7 @@ "tsconfig": "typedoc.config.json", "hideBreadcrumbs": "true", "hideInPageTOC": "true", + "hideMembersSymbol": "true", "publicPath": "/apidocs/", - "plugin": ["typedoc-plugin-markdown"] + "plugin": ["typedoc-plugin-no-inherit", "typedoc-plugin-markdown"] }