Permalink
Browse files

YUIdoc thinks the first param is the name

Summary:
YUIdoc does slightly different things than our coding styles.
This fix makes
http://developers.facebook.com/docs/reference/javascript/FB.Canvas.setAutoResize
have the right names in the parameter table

Test Plan:
no code changes

DiffCamp Revision: 119773
Reviewed By: naitik
CC: lshepard, brent, naitik, mattwkelly, selekman
Revert Plan:
OK
  • Loading branch information...
1 parent 30e7e77 commit 2c1bd806154c2d5dcbc10cec825c3d4c6e310224 @ptarjan ptarjan committed Jun 2, 2010
Showing with 3 additions and 3 deletions.
  1. +3 −3 src/core/canvas.js
View
@@ -76,7 +76,7 @@ FB.provide('Canvas', {
* The max width is whatever you picked in your app settings, and there is no
* max height.
*
- * @param {Object} optional
+ * @param {Object} params
*
* Property | Type | Description | Argument | Default
* -------- | ------- | -------------------------------- | ---------- | -------
@@ -140,9 +140,9 @@ FB.provide('Canvas', {
* Note: If there is only 1 parameter and it is a number, it is assumed to be
* the interval.
*
- * @param {Boolean} optional Whether to turn the timer on or off. truthy ==
+ * @param {Boolean} onOrOff Whether to turn the timer on or off. truthy ==
* on, falsy == off. **default** is true
- * @param {Integer} optional How often to resize (in ms). **default** is
+ * @param {Integer} interval How often to resize (in ms). **default** is
* 100ms
*
* @author ptarjan

0 comments on commit 2c1bd80

Please sign in to comment.