mirror of
https://github.com/scratchfoundation/paper.js.git
synced 2025-01-20 22:39:50 -05:00
Improve documentation for Path#removeSegments().
This commit is contained in:
parent
7dcdb5ca2f
commit
5bc4f69856
1 changed files with 10 additions and 3 deletions
|
@ -499,10 +499,17 @@ var Path = this.Path = PathItem.extend({
|
|||
|
||||
// PORT: Add to Scriptographer
|
||||
/**
|
||||
* Removes the segments from the specified {@code from} index to the
|
||||
* specified {@code to} index from the path's {@link #segments} array.
|
||||
* Removes all segments from the path's {@link #segments} array.
|
||||
*
|
||||
* @param {Number} [from=0] the beginning index, inclusive
|
||||
* @name Path#removeSegments
|
||||
* @function
|
||||
* @return {Array} an array containing the removed segments
|
||||
*/
|
||||
/**
|
||||
* Removes the segments from the specified {@code from} index to the
|
||||
* {@code to} index from the path's {@link #segments} array.
|
||||
*
|
||||
* @param {Number} from the beginning index, inclusive
|
||||
* @param {Number} [to=segments.length] the ending index, exclusive
|
||||
* @return {Array} an array containing the removed segments
|
||||
*
|
||||
|
|
Loading…
Reference in a new issue