blackberry / WebWorks-API-Docs

BlackBerry WebWorks API Documentation
66 stars 47 forks source link

Issue with the JSDoc template used for WebWorks #330

Open mdandrea opened 12 years ago

mdandrea commented 12 years ago

Hi,

I uncovered this issue when I was updating the push API docs. When adding constants, I noticed that if I put a long string without any spaces in the description for the constant, then it would cut off the end of the description and text would be missing.

Here's an example of a regular constant followed by one with a long string in there. Try adding these to a JSDoc file to see the issue:

/**
* Result error code when attempting to call destroy channel after a content provider has manually suspended a user.
* Similar to the blah error.
* <br/><br/>
* Operations this error can occur on: destroyChannel (only if using public/BIS PPG)
* <br/><br/>
* Recommended action: Most applications will typically want to just ignore this error code when it comes back. 
* @type Number
* @constant
* @static
* @BB10X
*/
SHORT_STRING : 1;

/**
* Result error code when attempting to call destroy channel after a content provider has manually suspended a  user.
* Similar to the CHANNEL_ALREADY_DESTROYED_BY_PROVIDER error.
* <br/><br/>
* Operations this error can occur on: destroyChannel (only if using public/BIS PPG)
* <br/><br/>
* Recommended action: Most applications will typically want to just ignore this error code when it comes back. 
* @type Number
* @constant
* @static
* @BB10X
*/
LONG_STRING : 2;

Let me know if you have any questions.

Thanks,

Matthew D'Andrea

nukulb commented 12 years ago

@jeffheifetz - you knew about this?