Small Doc Bugs

[GoogleCodeExporter]

Two gotchas that might be helpful to include in the docs:

1.  @param

When noting default values, you must not include any spaces between the '='
and the default value.  

So this produces garbled output (and a confusing warning message about
square braces):
  * @param {Integer} [config.height= '480'] Height in pixels
But this works great:
  * @param {Integer} [config.height='480'] Height in pixels

The above is new on the V2 beta build.  It was not a problem on a preview
build obtained about a week ago.

2.  @example

In order to include < and > in an @example, you must use &lt; and &gt;. 

Valid for all V2 builds.

What version of the product are you using? On what operating system?

See above for versions.  Windows XP.  

Original issue reported on code.google.com by ekaynel...@gmail.com on 26 Mar 2008 at 6:41

[GoogleCodeExporter]

I agree! Thanks for pointing this out. I'll emphasize this information in the 
wiki
before the final release is made.

Original comment by micmath on 30 Mar 2008 at 1:29

• Changed state: Accepted
• Added labels: Type-Enhancement
• Removed labels: Type-Defect

[GoogleCodeExporter]

Turns out this was promoted to a code bug in the latest release candidate (I 
must
have been enbugging, instead of debugging that day).

It is fixed now so that spaces are allowed around the equal sign. Committed in
revision 566.

For example:
@param {String} [title = This is untitled.] Specifies the title.

Original comment by micmath on 5 Apr 2008 at 8:28

• Changed state: Fixed

[GoogleCodeExporter]

:)

Verified fix on 2.0beta2.2.  Spaces are now allowed around the equals sign in 
the
syntax shown above.

Original comment by ekaynel...@gmail.com on 8 Apr 2008 at 5:41

[GoogleCodeExporter]

Original comment by micmath on 8 Apr 2008 at 7:43

• Changed state: Verified