Skip to content

Commit

Permalink
remove @param {types}
Browse files Browse the repository at this point in the history
  • Loading branch information
James Bradford committed Nov 22, 2021
1 parent d402531 commit 88e2a1e
Show file tree
Hide file tree
Showing 5 changed files with 29 additions and 29 deletions.
2 changes: 1 addition & 1 deletion types/scenegraph/Polygon.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ export class Polygon extends GraphicNode {

/**
* Set the corner radius of all corners of the Polygon to the same value.
* @param {number} radius
* radius
*/
setAllCornerRadii(radius: number): void;

Expand Down
12 changes: 6 additions & 6 deletions types/scenegraph/RootNode.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,22 +12,22 @@ export interface RootNode extends RootNodeClass {
export class RootNodeClass extends SceneNodeClass {
/**
* Adds a child node to this container node. You can only add leaf nodes this way; to create structured subtrees of content, use commands.
* @param {SceneNode} node Child to add
* @param {number} index Optional: index to insert child at. Child is appended to end of children list (top of z order) otherwise.
* node Child to add
* index Optional: index to insert child at. Child is appended to end of children list (top of z order) otherwise.
*/
addChild(node: SceneNode, index?: number): void;

/**
* Inserts a child node after the given reference node.
* @param {SceneNode} node Child to add
* @param {SceneNode} relativeTo New child is added immediately after this existing child
* node Child to add
* relativeTo New child is added immediately after this existing child
*/
addChildAfter(node: SceneNode, relativeTo: SceneNode): void;

/**
* Inserts a child node before the given reference node.
* @param {SceneNode} node Child to add
* @param {SceneNode} relativeTo New child is added immediately before this existing child
* node Child to add
* relativeTo New child is added immediately before this existing child
*/
addChildBefore(node: SceneNode, relativeTo: SceneNode): void;

Expand Down
18 changes: 9 additions & 9 deletions types/scenegraph/SceneNode.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -267,17 +267,17 @@ export abstract class SceneNodeClass {
*
* The third parameter, deltaZ (optional), allows the movement of the object on Z axis.
*
* @param {number} deltaX Amount to move along X axis
* @param {number} deltaY Amount to move along Y axis
* @param {number} deltaZ Optional: number of pixels to change depth with
* deltaX Amount to move along X axis
* deltaY Amount to move along Y axis
* deltaZ Optional: number of pixels to change depth with
*/
moveInParentCoordinates(deltaX: number, deltaY: number, deltaZ?: number): void;

/**
* Move the node so the given point in its local coordinates is placed at the given point in its parent’s coordinates (taking into account any rotation on this node, etc.).
* For an overview of node positioning & coordinate systems, see Coordinate spaces.
* @param {Point} registrationPoint Point in this node’s local coordinate space to align with parentPoint
* @param {Point} parentPoint Point in this node’s parent’s coordinate space to move registrationPoint to
* registrationPoint Point in this node’s local coordinate space to align with parentPoint
* parentPoint Point in this node’s parent’s coordinate space to move registrationPoint to
*/
placeInParentCoordinates(registrationPoint: Point, parentPoint: Point): void;

Expand Down Expand Up @@ -320,8 +320,8 @@ export abstract class SceneNodeClass {

/**
* Rotate the node clockwise by the given number of degrees around the given point in the plugin’s local coordinate space. If this node already has nonzero rotation, this operation adds to its existing angle.
* @param {number} deltaAngle In degrees.
* @param {Point} rotationCenter Point to rotate around, in node’s local coordinates.
* deltaAngle In degrees.
* rotationCenter Point to rotate around, in node’s local coordinates.
*/
rotateAround(deltaAngle: number, rotationCenter: Point): void;

Expand Down Expand Up @@ -358,8 +358,8 @@ export abstract class SceneNodeClass {

/**
* Attempts to change localBounds.width & height to match the specified sizes. This operation may not succeed, since some nodes are not resizable. Resizing one dimension may affect the other, if the node’s aspect ratio is locked.
* @param {number} width
* @param {number} height
* width
* height
*/
resize(width: number, height: number): void;

Expand Down
10 changes: 5 additions & 5 deletions types/uxp.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -307,7 +307,7 @@ declare module 'uxp' {

/**
* Creates a File Entry object within this folder and returns the appropriate instance. Note that this method just create a file entry object and not the actual file on the disk. The file actually gets created when you call for eg: write method on the file entry object.
* @param {string} name the name of the file to create
* name the name of the file to create
* @param options additional options
*
* @returns the created entry
Expand All @@ -322,23 +322,23 @@ declare module 'uxp' {

/**
* Creates a Folder within this folder and returns the appropriate instance.
* @param {string} name the name of the folder to create
* name the name of the folder to create
* @returns the created entry
*/
createFolder(name: string): Promise<Folder>;

/**
* Gets an entry from within this folder and returns the appropriate instance.
* @param {string} filePath the name/path of the entry to fetch
* filePath the name/path of the entry to fetch
*
* @returns the fetched entry.
*/
getEntry(filePath: string): Promise<File | Folder>;

/**
* Renames an item on disk to a new name within the same folder. The Entry object passed to this function is automatically updated to reference the new name, however any other Entry objects referencing the original item will not be updated, and will thus no longer point to an item that exists on disk.
* @param {Entry} entry entry to rename (File or Folder). Must exist.
* @param {string} newName the new name to assign
* entry entry to rename (File or Folder). Must exist.
* newName the new name to assign
* @param options additional options
*/
renameEntry(entry: Entry, newName: string, options?: {
Expand Down
16 changes: 8 additions & 8 deletions types/viewport.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ declare module 'viewport' {
* Smoothly pan the viewport to bring the entire given region into view. If the region is already fully in view, does nothing. If the given region is too large to fit entirely in view, it is simply centered (zoom remains unchanged).
*
* The region can be defined by passing a {@link SceneNode}, or by explicitly specifying a rectangle in global coordinates.
* @param {!SceneNode} node The node that gets scrolled into view
* @param node The node that gets scrolled into view
*/
export function scrollIntoView(node: SceneNode): void;

Expand All @@ -29,27 +29,27 @@ declare module 'viewport' {

/**
* Smoothly pan the viewport to center on a specific point in the document's global coordinates. Even if the point is already in view, the view pans until it is centered.
* @param {number} x The x-coordinate of the centered point (in the document's global coordinates)
* @param {number} y The y-coordinate of the centered point (in the document's global coordinates)
* x The x-coordinate of the centered point (in the document's global coordinates)
* y The y-coordinate of the centered point (in the document's global coordinates)
*/
export function scrollToCenter(x: number, y: number): void;

/**
* Zoom & pan the view as needed so the given region fills the viewport (with some padding). If the region is large, zooms out as needed so it fits entirely in view. If the region is smaller, zooms in so the region fills the entire viewport - may zoom in past 100% to achieve this.
*
* The region can be defined by passing a {@link SceneNode}, or by explicitly specifying a rectangle in global coordinates.
* @param {!SceneNode} node
* @param node
*/
export function zoomToRect(node: SceneNode): void;

/**
* Zoom & pan the view as needed so the given region fills the viewport (with some padding). If the region is large, zooms out as needed so it fits entirely in view. If the region is smaller, zooms in so the region fills the entire viewport - may zoom in past 100% to achieve this.
*
* The region can be defined by passing a {@link SceneNode}, or by explicitly specifying a rectangle in global coordinates.
* @param {number} x
* @param {number} y
* @param {number} width
* @param {number} height
* x
* y
* width
* height
*/
export function zoomToRect(x: number, y: number, width: number, height: number): void;

Expand Down

0 comments on commit 88e2a1e

Please sign in to comment.