Bug 325379

Summary: [editor][views] JSDoc rendering of doc tags needs improvement
Product: [WebTools] JSDT Reporter: Mark Storer <mstorer3772>
Component: GeneralAssignee: Project Inbox <jsdt.javascript-inbox>
Status: NEW --- QA Contact: Chris Jaun <cmjaun>
Severity: normal    
Priority: P2 CC: cmjaun
Version: unspecifiedKeywords: plan
Target Milestone: Future   
Hardware: PC   
OS: Windows 7   
Whiteboard:

Description Mark Storer CLA 2010-09-15 13:41:13 EDT 
Build Identifier: 20100615235519

There are several Suboptimal Behaviors in the JSDoc tooltips displayed when selecting a method from a list of possible code completions:

* Various tags are listed "@raw", but should not be:
**@returns (listed raw, @return supported correctly)
**@type (don't list, should have other effect?)
**@memberOf (don't list)
**@deprecated (don't list, should affect JSDoc in Some Other Way?)
**@public (don't list)
**@name (don't list)
**@version (format?)
**@example (listed raw, should be <code>-ified)
*<code> changes the font but loses whitespace, while <pre> behaves correctly.
* Types defined with the {} wrappers are listed with the "{}".  Ugh.  I know you can't click on the tool tip, so a link is out... but how about some formatting/filtering?


Reproducible: Always

Steps to Reproduce:
Several of these tags are used regularly in system.js.  Thusly:

{}.|

Invoking code completion at the '|' and navigating to just about any function will show memberOf, lots of examples of @returns {type}...
Comment 1 Mark Storer CLA 2010-09-16 15:10:56 EDT 
Hovering over a type name will also pop up JSDoc, which shows @class as well.

You can find a full list of JSDoc tags at their google group:

http://code.google.com/p/jsdoc-toolkit/wiki/TagReference

The (original?) JSDoc project, http://jsdoc.sourceforge.net/, states that it has been superseded by the jsdoc-toolkit, and links to it.


(and the jsdoc-toolkit states that it's no longer being developed in favor of JSDoc3, which the maintainer is currently writing, having released no code)