Skip to content

Commit e23282f

Browse files
puckeypuckey
committed
Documentation: convert Array return types to Type[].
1 parent 55724b0 commit e23282f

4 files changed

Lines changed: 8 additions & 8 deletions

File tree

‎src/basic/Matrix.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -330,10 +330,10 @@ var Matrix = this.Matrix = Base.extend({
330330
*
331331
* @param {Point} point The point to be transformed.
332332
*
333-
* @param {Array} src The array containing the source points
333+
* @param {Number[]} src The array containing the source points
334334
* as x, y value pairs.
335335
* @param {Number} srcOff The offset to the first point to be transformed.
336-
* @param {Array} dst The array into which to store the transformed
336+
* @param {Number[]} dst The array into which to store the transformed
337337
* point pairs.
338338
* @param {Number} dstOff The offset of the location of the first
339339
* transformed point in the destination array.

‎src/item/Item.js‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -843,20 +843,20 @@ var Item = this.Item = Base.extend({
843843
*
844844
* @name Item#removeChildren
845845
* @function
846-
* @return {Array} an array containing the removed items
846+
* @return {Item[]} an array containing the removed items
847847
*/
848848
/**
849849
* Removes all of the item's {@link #children} (if any).
850850
*
851-
* @return {Array} an array containing the removed items
851+
* @return {Item[]} an array containing the removed items
852852
*/
853853
/**
854854
* Removes the children from the specified {@code from} index to the
855855
* {@code to} index from the parent's {@link #children} array.
856856
*
857857
* @param {Number} from the beginning index, inclusive
858858
* @param {Number} [to=children.length] the ending index, exclusive
859-
* @return {Array} an array containing the removed items
859+
* @return {Item[]} an array containing the removed items
860860
*/
861861
removeChildren: function(from, to) {
862862
if (!this._children)
@@ -1433,7 +1433,7 @@ var Item = this.Item = Base.extend({
14331433
* Transform the item.
14341434
*
14351435
* @param {Matrix} matrix
1436-
* @param {Array} flags Array of any of the following: 'objects', 'children',
1436+
* @param {String[]} flags Array of any of the following: 'objects', 'children',
14371437
* 'fill-gradients', 'fill-patterns', 'stroke-patterns', 'lines'.
14381438
* Default: ['objects', 'children']
14391439
*/

‎src/item/Layer.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ var Layer = this.Layer = Group.extend({
2323
* {@link Project#layers} array. The newly created layer will be activated,
2424
* so all newly created items will be placed within it.
2525
*
26-
* @param {Array} [children] An array of items that will be added to the
26+
* @param {Item[]} [children] An array of items that will be added to the
2727
* newly created layer.
2828
*
2929
* @example

‎src/path/Path.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -508,7 +508,7 @@ var Path = this.Path = PathItem.extend({
508508
*
509509
* @param {Number} from the beginning index, inclusive
510510
* @param {Number} [to=segments.length] the ending index, exclusive
511-
* @return {Array} an array containing the removed segments
511+
* @return {Segment[]} an array containing the removed segments
512512
*
513513
* @example {@paperscript}
514514
* // Removing segments from a path:

0 commit comments

Comments
 (0)