Skip to content

Commit c797bc2

Browse files
s-rigaudSamuel Rigaud
andauthored
Eslint: fix more JSDocs (#30093)
Co-authored-by: Samuel Rigaud <[email protected]>
1 parent 0eae292 commit c797bc2

38 files changed

+260
-213
lines changed

editor/js/commands/AddObjectCommand.js

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
import { Command } from '../Command.js';
22
import { ObjectLoader } from 'three';
33

4-
/**
5-
* @param editor Editor
6-
* @param object THREE.Object3D
7-
* @constructor
8-
*/
94
class AddObjectCommand extends Command {
105

6+
/**
7+
* @param {Editor} editor
8+
* @param {THREE.Object3D|null} [object=null]
9+
* @constructor
10+
*/
1111
constructor( editor, object = null ) {
1212

1313
super( editor );

editor/js/commands/AddScriptCommand.js

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
import { Command } from '../Command.js';
22

3-
/**
4-
* @param editor Editor
5-
* @param object THREE.Object3D
6-
* @param script javascript object
7-
* @constructor
8-
*/
93
class AddScriptCommand extends Command {
104

5+
/**
6+
* @param {Editor} editor
7+
* @param {THREE.Object3D|null} [object=null]
8+
* @param {String} [script='']
9+
* @constructor
10+
*/
1111
constructor( editor, object = null, script = '' ) {
1212

1313
super( editor );

editor/js/commands/MoveObjectCommand.js

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
import { Command } from '../Command.js';
22

3-
/**
4-
* @param editor Editor
5-
* @param object THREE.Object3D
6-
* @param newParent THREE.Object3D
7-
* @param newBefore THREE.Object3D
8-
* @constructor
9-
*/
103
class MoveObjectCommand extends Command {
114

5+
/**
6+
* @param {Editor} editor
7+
* @param {THREE.Object3D|null} [object=null]
8+
* @param {THREE.Object3D|null} [newParent=null]
9+
* @param {THREE.Object3D|null} [newBefore=null]
10+
* @constructor
11+
*/
1212
constructor( editor, object = null, newParent = null, newBefore = null ) {
1313

1414
super( editor );

editor/js/commands/MultiCmdsCommand.js

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
import { Command } from '../Command.js';
22

3-
/**
4-
* @param editor Editor
5-
* @param cmdArray array containing command objects
6-
* @constructor
7-
*/
83
class MultiCmdsCommand extends Command {
94

5+
/**
6+
* @param {Editor} editor
7+
* @param {Array<Command>} [cmdArray=[]]
8+
* @constructor
9+
*/
1010
constructor( editor, cmdArray = [] ) {
1111

1212
super( editor );

editor/js/commands/RemoveObjectCommand.js

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@ import { Command } from '../Command.js';
22

33
import { ObjectLoader } from 'three';
44

5-
/**
6-
* @param editor Editor
7-
* @param object THREE.Object3D
8-
* @constructor
9-
*/
105
class RemoveObjectCommand extends Command {
116

7+
/**
8+
* @param {Editor} editor
9+
* @param {THREE.Object3D|null} [object=null]
10+
* @constructor
11+
*/
1212
constructor( editor, object = null ) {
1313

1414
super( editor );

editor/js/commands/RemoveScriptCommand.js

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
import { Command } from '../Command.js';
22

3-
/**
4-
* @param editor Editor
5-
* @param object THREE.Object3D
6-
* @param script javascript object
7-
* @constructor
8-
*/
93
class RemoveScriptCommand extends Command {
104

5+
/**
6+
* @param {Editor} editor
7+
* @param {THREE.Object3D|null} [object=null]
8+
* @param {String} [script='']
9+
* @constructor
10+
*/
1111
constructor( editor, object = null, script = '' ) {
1212

1313
super( editor );

editor/js/commands/SetColorCommand.js

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
import { Command } from '../Command.js';
22

3-
/**
4-
* @param editor Editor
5-
* @param object THREE.Object3D
6-
* @param attributeName string
7-
* @param newValue integer representing a hex color value
8-
* @constructor
9-
*/
103
class SetColorCommand extends Command {
114

5+
/**
6+
* @param {Editor} editor
7+
* @param {THREE.Object3D|null} [object=null]
8+
* @param {String} attributeName
9+
* @param {Number|null} [newValue=null] Integer representing a hex color value
10+
* @constructor
11+
*/
1212
constructor( editor, object = null, attributeName = '', newValue = null ) {
1313

1414
super( editor );

editor/js/commands/SetGeometryCommand.js

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,14 @@
11
import { Command } from '../Command.js';
22
import { ObjectLoader } from 'three';
33

4-
/**
5-
* @param editor Editor
6-
* @param object THREE.Object3D
7-
* @param newGeometry THREE.Geometry
8-
* @constructor
9-
*/
10-
114
class SetGeometryCommand extends Command {
125

6+
/**
7+
* @param {Editor} editor
8+
* @param {THREE.Object3D|null} [object=null]
9+
* @param {THREE.Geometry|null} [newGeometry=null]
10+
* @constructor
11+
*/
1312
constructor( editor, object = null, newGeometry = null ) {
1413

1514
super( editor );

editor/js/commands/SetGeometryValueCommand.js

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
import { Command } from '../Command.js';
22

3-
/**
4-
* @param editor Editor
5-
* @param object THREE.Object3D
6-
* @param attributeName string
7-
* @param newValue number, string, boolean or object
8-
* @constructor
9-
*/
103
class SetGeometryValueCommand extends Command {
114

5+
/**
6+
* @param {Editor} editor
7+
* @param {THREE.Object3D|null} [object=null]
8+
* @param {String} [attributeName='']
9+
* @param {Number|String|Boolean|Object|null} [newValue=null]
10+
* @constructor
11+
*/
1212
constructor( editor, object = null, attributeName = '', newValue = null ) {
1313

1414
super( editor );

editor/js/commands/SetMaterialColorCommand.js

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
import { Command } from '../Command.js';
22

3-
/**
4-
* @param editor Editor
5-
* @param object THREE.Object3D
6-
* @param attributeName string
7-
* @param newValue integer representing a hex color value
8-
* @constructor
9-
*/
103
class SetMaterialColorCommand extends Command {
114

5+
/**
6+
* @param {Editor} editor
7+
* @param {THREE.Object3D|null} [object=null]
8+
* @param {String} attributeName
9+
* @param {Number|null} [newValue=null] Integer representing a hex color value
10+
* @param {Number} [materialSlot=-1]
11+
* @constructor
12+
*/
1213
constructor( editor, object = null, attributeName = '', newValue = null, materialSlot = - 1 ) {
1314

1415
super( editor );

0 commit comments

Comments
 (0)