Skip to content

Commit 88e2a1e

Browse files
author
James Bradford
committed
remove @param {types}
1 parent d402531 commit 88e2a1e

File tree

5 files changed

+29
-29
lines changed

5 files changed

+29
-29
lines changed

types/scenegraph/Polygon.d.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ export class Polygon extends GraphicNode {
6060

6161
/**
6262
* Set the corner radius of all corners of the Polygon to the same value.
63-
* @param {number} radius
63+
* radius
6464
*/
6565
setAllCornerRadii(radius: number): void;
6666

types/scenegraph/RootNode.d.ts

+6-6
Original file line numberDiff line numberDiff line change
@@ -12,22 +12,22 @@ export interface RootNode extends RootNodeClass {
1212
export class RootNodeClass extends SceneNodeClass {
1313
/**
1414
* Adds a child node to this container node. You can only add leaf nodes this way; to create structured subtrees of content, use commands.
15-
* @param {SceneNode} node Child to add
16-
* @param {number} index Optional: index to insert child at. Child is appended to end of children list (top of z order) otherwise.
15+
* node Child to add
16+
* index Optional: index to insert child at. Child is appended to end of children list (top of z order) otherwise.
1717
*/
1818
addChild(node: SceneNode, index?: number): void;
1919

2020
/**
2121
* Inserts a child node after the given reference node.
22-
* @param {SceneNode} node Child to add
23-
* @param {SceneNode} relativeTo New child is added immediately after this existing child
22+
* node Child to add
23+
* relativeTo New child is added immediately after this existing child
2424
*/
2525
addChildAfter(node: SceneNode, relativeTo: SceneNode): void;
2626

2727
/**
2828
* Inserts a child node before the given reference node.
29-
* @param {SceneNode} node Child to add
30-
* @param {SceneNode} relativeTo New child is added immediately before this existing child
29+
* node Child to add
30+
* relativeTo New child is added immediately before this existing child
3131
*/
3232
addChildBefore(node: SceneNode, relativeTo: SceneNode): void;
3333

types/scenegraph/SceneNode.d.ts

+9-9
Original file line numberDiff line numberDiff line change
@@ -267,17 +267,17 @@ export abstract class SceneNodeClass {
267267
*
268268
* The third parameter, deltaZ (optional), allows the movement of the object on Z axis.
269269
*
270-
* @param {number} deltaX Amount to move along X axis
271-
* @param {number} deltaY Amount to move along Y axis
272-
* @param {number} deltaZ Optional: number of pixels to change depth with
270+
* deltaX Amount to move along X axis
271+
* deltaY Amount to move along Y axis
272+
* deltaZ Optional: number of pixels to change depth with
273273
*/
274274
moveInParentCoordinates(deltaX: number, deltaY: number, deltaZ?: number): void;
275275

276276
/**
277277
* 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.).
278278
* For an overview of node positioning & coordinate systems, see Coordinate spaces.
279-
* @param {Point} registrationPoint Point in this node’s local coordinate space to align with parentPoint
280-
* @param {Point} parentPoint Point in this node’s parent’s coordinate space to move registrationPoint to
279+
* registrationPoint Point in this node’s local coordinate space to align with parentPoint
280+
* parentPoint Point in this node’s parent’s coordinate space to move registrationPoint to
281281
*/
282282
placeInParentCoordinates(registrationPoint: Point, parentPoint: Point): void;
283283

@@ -320,8 +320,8 @@ export abstract class SceneNodeClass {
320320

321321
/**
322322
* 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.
323-
* @param {number} deltaAngle In degrees.
324-
* @param {Point} rotationCenter Point to rotate around, in node’s local coordinates.
323+
* deltaAngle In degrees.
324+
* rotationCenter Point to rotate around, in node’s local coordinates.
325325
*/
326326
rotateAround(deltaAngle: number, rotationCenter: Point): void;
327327

@@ -358,8 +358,8 @@ export abstract class SceneNodeClass {
358358

359359
/**
360360
* 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.
361-
* @param {number} width
362-
* @param {number} height
361+
* width
362+
* height
363363
*/
364364
resize(width: number, height: number): void;
365365

types/uxp.d.ts

+5-5
Original file line numberDiff line numberDiff line change
@@ -307,7 +307,7 @@ declare module 'uxp' {
307307

308308
/**
309309
* 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.
310-
* @param {string} name the name of the file to create
310+
* name the name of the file to create
311311
* @param options additional options
312312
*
313313
* @returns the created entry
@@ -322,23 +322,23 @@ declare module 'uxp' {
322322

323323
/**
324324
* Creates a Folder within this folder and returns the appropriate instance.
325-
* @param {string} name the name of the folder to create
325+
* name the name of the folder to create
326326
* @returns the created entry
327327
*/
328328
createFolder(name: string): Promise<Folder>;
329329

330330
/**
331331
* Gets an entry from within this folder and returns the appropriate instance.
332-
* @param {string} filePath the name/path of the entry to fetch
332+
* filePath the name/path of the entry to fetch
333333
*
334334
* @returns the fetched entry.
335335
*/
336336
getEntry(filePath: string): Promise<File | Folder>;
337337

338338
/**
339339
* 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.
340-
* @param {Entry} entry entry to rename (File or Folder). Must exist.
341-
* @param {string} newName the new name to assign
340+
* entry entry to rename (File or Folder). Must exist.
341+
* newName the new name to assign
342342
* @param options additional options
343343
*/
344344
renameEntry(entry: Entry, newName: string, options?: {

types/viewport.d.ts

+8-8
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ declare module 'viewport' {
1212
* 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).
1313
*
1414
* The region can be defined by passing a {@link SceneNode}, or by explicitly specifying a rectangle in global coordinates.
15-
* @param {!SceneNode} node The node that gets scrolled into view
15+
* @param node The node that gets scrolled into view
1616
*/
1717
export function scrollIntoView(node: SceneNode): void;
1818

@@ -29,27 +29,27 @@ declare module 'viewport' {
2929

3030
/**
3131
* 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.
32-
* @param {number} x The x-coordinate of the centered point (in the document's global coordinates)
33-
* @param {number} y The y-coordinate of the centered point (in the document's global coordinates)
32+
* x The x-coordinate of the centered point (in the document's global coordinates)
33+
* y The y-coordinate of the centered point (in the document's global coordinates)
3434
*/
3535
export function scrollToCenter(x: number, y: number): void;
3636

3737
/**
3838
* 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.
3939
*
4040
* The region can be defined by passing a {@link SceneNode}, or by explicitly specifying a rectangle in global coordinates.
41-
* @param {!SceneNode} node
41+
* @param node
4242
*/
4343
export function zoomToRect(node: SceneNode): void;
4444

4545
/**
4646
* 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.
4747
*
4848
* The region can be defined by passing a {@link SceneNode}, or by explicitly specifying a rectangle in global coordinates.
49-
* @param {number} x
50-
* @param {number} y
51-
* @param {number} width
52-
* @param {number} height
49+
* x
50+
* y
51+
* width
52+
* height
5353
*/
5454
export function zoomToRect(x: number, y: number, width: number, height: number): void;
5555

0 commit comments

Comments
 (0)