Remove the mention of optional parameters in documentation, as they are marked optional already.

This commit is contained in:
Jürg Lehni 2011-06-19 21:52:52 +01:00
parent 1e436b2980
commit 2594a41b7d
4 changed files with 9 additions and 9 deletions

View file

@ -110,7 +110,7 @@ var Matrix = this.Matrix = Base.extend({
* @name Matrix#scale * @name Matrix#scale
* @function * @function
* @param {Number} scale The scaling factor. * @param {Number} scale The scaling factor.
* @param {Point} [center] The optional center for the scaling * @param {Point} [center] The center for the scaling
* transformation. * transformation.
* @return {Matrix} This affine transform. * @return {Matrix} This affine transform.
*/ */
@ -121,7 +121,7 @@ var Matrix = this.Matrix = Base.extend({
* @function * @function
* @param {Number} sx The x-axis scaling factor. * @param {Number} sx The x-axis scaling factor.
* @param {Number} sy The y-axis scaling factor. * @param {Number} sy The y-axis scaling factor.
* @param {Point} [center] The optional center for the scaling * @param {Point} [center] The center for the scaling
* transformation. * transformation.
* @return {Matrix} This affine transform. * @return {Matrix} This affine transform.
*/ */
@ -203,7 +203,7 @@ var Matrix = this.Matrix = Base.extend({
* @name Matrix#shear * @name Matrix#shear
* @function * @function
* @param {Point} point The shear factor in x and y direction. * @param {Point} point The shear factor in x and y direction.
* @param {Point} [center] The optional center for the shear transformation. * @param {Point} [center] The center for the shear transformation.
* @return {Matrix} This affine transform. * @return {Matrix} This affine transform.
*/ */
/** /**
@ -213,7 +213,7 @@ var Matrix = this.Matrix = Base.extend({
* @function * @function
* @param {Number} shx The x shear factor. * @param {Number} shx The x shear factor.
* @param {Number} shy The y shear factor. * @param {Number} shy The y shear factor.
* @param {Point} [center] The optional center for the shear transformation. * @param {Point} [center] The center for the shear transformation.
* @return {Matrix} This affine transform. * @return {Matrix} This affine transform.
*/ */
shear: function(shx, shy, center) { shear: function(shx, shy, center) {

View file

@ -21,8 +21,8 @@ var Group = this.Group = Item.extend({
/** /**
* Creates a new Group item and places it at the top of the active layer. * Creates a new Group item and places it at the top of the active layer.
* *
* @param {Item[]} [children] An optional array of children that will be * @param {Item[]} [children] An array of children that will be added to the
* added to the newly created group. * newly created group.
* *
* @example {@paperscript split=true height=200} * @example {@paperscript split=true height=200}
* // Create a group containing two paths: * // Create a group containing two paths:

View file

@ -23,8 +23,8 @@ var Layer = this.Layer = Group.extend({
* {@link Project#layers} array. The newly created layer will be activated, * {@link Project#layers} array. The newly created layer will be activated,
* so all newly created items will be placed within it. * so all newly created items will be placed within it.
* *
* @param {Array} [children] An optional array of items that will be * @param {Array} [children] An array of items that will be added to the
* added to the newly created layer. * newly created layer.
* *
* @example * @example
* var layer = new Layer(); * var layer = new Layer();

View file

@ -20,7 +20,7 @@ var Path = this.Path = PathItem.extend({
/** /**
* Creates a new Path item and places it at the top of the active layer. * Creates a new Path item and places it at the top of the active layer.
* *
* @param {Segment[]} [segments] An optional array of segments (or points to be * @param {Segment[]} [segments] An array of segments (or points to be
* converted to segments) that will be added to the path. * converted to segments) that will be added to the path.
* *
* @example * @example