Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(): Remove inheritance from docs #9486

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
63 changes: 40 additions & 23 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
},
Expand Down
3 changes: 3 additions & 0 deletions src/shapes/Polyline.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@ export interface SerializedPolylineProps extends SerializedObjectProps {
points: XY[];
}

/**
* @noInheritDoc
*/
export class Polyline<
Props extends TOptions<FabricObjectProps> = Partial<FabricObjectProps>,
SProps extends SerializedPolylineProps = SerializedPolylineProps,
Expand Down
3 changes: 3 additions & 0 deletions src/shapes/Rect.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@ export interface RectProps extends FabricObjectProps, UniqueRectProps {}

const RECT_PROPS = ['rx', 'ry'] as const;

/**
* @noInheritDoc
*/
export class Rect<
Props extends TOptions<RectProps> = Partial<RectProps>,
SProps extends SerializedRectProps = SerializedRectProps,
Expand Down
3 changes: 2 additions & 1 deletion typedoc.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
}
Loading