Improve documentation for Path#removeSegments().

This commit is contained in:
Jürg Lehni 2011-06-17 17:54:37 +01:00
parent 7dcdb5ca2f
commit 5bc4f69856

View file

@ -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
*