Skip to content

Commit

Permalink
Fix jsdoc connection to types in Anchor
Browse files Browse the repository at this point in the history
  • Loading branch information
jonobr1 committed Oct 3, 2024
1 parent 6b2684a commit 0b01e96
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
8 changes: 4 additions & 4 deletions src/anchor.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ import { Vector } from './vector.js';
* @name Two.Anchor
* @param {Number} [x=0] - The x position of the root anchor point.
* @param {Number} [y=0] - The y position of the root anchor point.
* @param {Number} [lx=0] - The x position of the left handle point.
* @param {Number} [ly=0] - The y position of the left handle point.
* @param {Number} [rx=0] - The x position of the right handle point.
* @param {Number} [ry=0] - The y position of the right handle point.
* @param {Number} [ax=0] - The x position of the left handle point.
* @param {Number} [ay=0] - The y position of the left handle point.
* @param {Number} [bx=0] - The x position of the right handle point.
* @param {Number} [by=0] - The y position of the right handle point.
* @param {String} [command=Two.Commands.move] - The command to describe how to render. Applicable commands are {@link Two.Commands}
* @extends Two.Vector
* @description An object that holds 3 {@link Two.Vector}s, the anchor point and its corresponding handles: `left` and `right`. In order to properly describe the bezier curve about the point there is also a command property to describe what type of drawing should occur when Two.js renders the anchors.
Expand Down
10 changes: 5 additions & 5 deletions types.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -523,10 +523,10 @@ declare module "two.js/src/anchor" {
* @name Two.Anchor
* @param {Number} [x=0] - The x position of the root anchor point.
* @param {Number} [y=0] - The y position of the root anchor point.
* @param {Number} [lx=0] - The x position of the left handle point.
* @param {Number} [ly=0] - The y position of the left handle point.
* @param {Number} [rx=0] - The x position of the right handle point.
* @param {Number} [ry=0] - The y position of the right handle point.
* @param {Number} [ax=0] - The x position of the left handle point.
* @param {Number} [ay=0] - The y position of the left handle point.
* @param {Number} [bx=0] - The x position of the right handle point.
* @param {Number} [by=0] - The y position of the right handle point.
* @param {String} [command=Two.Commands.move] - The command to describe how to render. Applicable commands are {@link Two.Commands}
* @description An object that holds 3 {@link Two.Vector}s, the anchor point and its corresponding handles: `left` and `right`. In order to properly describe the bezier curve about the point there is also a command property to describe what type of drawing should occur when Two.js renders the anchors.
Expand Down Expand Up @@ -4444,7 +4444,7 @@ declare module "two.js" {
* @function
* @param {SVGElement} svg - The SVG node to be parsed.
* @param {Boolean} shallow - Don't create a top-most group but append all content directly.
* @param {Boolean} [add=true] – Automatically add the reconstructed SVG node to scene.
* @param {Boolean} [add=true] Automatically add the reconstructed SVG node to scene.
* @returns {Group}
* @description Interpret an SVG Node and add it to this instance's scene. The distinction should be made that this doesn't `import` svg's, it solely interprets them into something compatible for Two.js - this is slightly different than a direct transcription.
*/
Expand Down

0 comments on commit 0b01e96

Please sign in to comment.