History | Log In     View a printable version of the current page.  
Issue Details (XML | Word | Printable)

Key: IDEADEV-7723
Type: New Feature New Feature
Status: Resolved Resolved
Resolution: Fixed
Priority: Major Major
Assignee: Maxim Mossienko
Reporter: Vitaly Harisov
Votes: 4
Watchers: 1
Operations

If you were logged in you would be able to see more operations.
IDEA: Development

Full JavaDoc (JsDoc) support for JavaScript

Created: 26 Jul 06 16:11   Updated: 16 Jul 07 16:19
Component/s: JavaScript
Fix Version/s: Selena 7087

Original Estimate: Unknown Remaining Estimate: Unknown Time Spent: Unknown
File Attachments: None
Image Attachments:

1. JS-JAVADOC.JPG
(134 kb)

2. JS-JAVADOC.JPG
(134 kb)
Issue Links:
Depend
 
This issue is required for:
IDEADEV-11800 JavaScript documentation not properly... Normal Resolved
Relates
 
This issue is related to:
IDEADEV-12412 JavaScript improvements Normal Open

Build: 5,382
Fixed in build: 7,070
Severity: Medium

Sub-Tasks  All   Open   
 Sub-Task Progress: 

 Description  « Hide
I think it is not too hard to port full javadoc support from java editor to js editor, at least:

1. Support Ctrl+Q for class names. Currently documentation showed, but leading * not removed and HTML not rendered correctly.

2. Support for Enter after /**



 All   Comments   Work Log   Change History      Sort Order:
Arik Kfir - 17 Aug 06 21:47
This would be EXCELLENT!!

Another suggestion: ability to generate javadocs site from such javascript as well (I think there's a tool that does this already, though I can't remember its name).



Richard Bondi - 03 Nov 06 00:27
Comments formatted with // should also be revealed with Ctrl-Q. Example:
///////////////////////////////////////////////////////////////////////////////
// Empties an html SELECT menu, and repopulates it using the name/value
// pairs in the oOptions collection/array.
//
// Parameters:
// oOptions:  any object collection or array of objects, where the i-th OPTION
//            tag would be (as a string): "<OPTION VALUE='" + oOptions[i][lbl]
//            + "'>" + oOptions[i][val] = "</OPTION>".
// lbl, val:  see oOptions
// selectTag: a js object representing a SELECT menu. For example, for
//            <SELECT id="123"> you would pass in ${"123"} (using prototype).
// noneLabel,
// noneValue: If oOptions is empty, then the select menu is populated
//            with a single <OPTION> tag whose value is noneValue, and whose
//            content is noneLabel.
//
// Example use with prototype Ajax:
//    onComplete: function(req) {
//      populateSelectTag(eval(req), "commodityName", "commodityId", selectTag, "None", "0" )
//    }
// 11/2/2006 rb
///////////////////////////////////////////////////////////////////////////////
function foo( oOptions, lbl, val, selectTag, noneLabel, noneValue) { ... }

Richard Bondi - 13 Apr 07 17:27
The Ctr-Q /** */ support has an inconsistency when used on methods declared on an object:
  • Ctrl-Q works at the point the method is declared, but not anywhere it is called.
  • Weirdly though, Ctrl-P does work in this case.

See attached screenshot.


Richard Bondi - 13 Apr 07 17:32
Comment to follow.

Maxim Mossienko - 13 Apr 07 17:50
Please, create separate JIRA bug request, and if possible, js code fragment