This Bugzilla instance is a read-only archive of historic NetBeans bug reports. To report a bug in NetBeans please follow the project's instructions for reporting issues.
| Summary: | Document supported tags | ||
|---|---|---|---|
| Product: | javascript | Reporter: | _ gtzabari <gtzabari> |
| Component: | Documentation | Assignee: | Martin Fousek <marfous> |
| Status: | RESOLVED FIXED | ||
| Severity: | normal | ||
| Priority: | P3 | ||
| Version: | 7.3 | ||
| Hardware: | PC | ||
| OS: | Windows 7 | ||
| Issue Type: | ENHANCEMENT | Exception Reporter: | |
|
Description
_ gtzabari
2012-11-15 19:25:54 UTC
For now we are supporting all JsDoc2 tags: http://code.google.com/p/jsdoc-toolkit/wiki/TagReference Not all of them will be connected to the JavaScript model since it's quite expensive but at least the base one are. If you would need any improvement there, feel free to enter defect/enhancement for that. About the link you mentioned it looks that it's even evaluated for now so once it would be in the JsDoc support please enter an issue for that, thanks. Not sure whether or where this should be documented. I think that answer, we support whole JsDoc2 in NB73 could be enough - you can check it in code completion inside the /** */ doc -> /** @<CChere> */. BTW, feel free to raise an enhancement for support also of all JsDoc3 tags - but it could be in the next release at first. I'm closing as wontfix for now since we don't document such things - the support should be always complete. Rather enter issues what is missing. Thanks a lot... BTW, we are working on establishing a new Blog for HTML5, CSS3, JS projects so I think that this could be good idea for one blog post and I'm adding that to my todo list. Martin, I suggest adding a note in the New and Noteworthy page, among other places. OK, can be. I'm reopening that and I take a look on that on Monday. (In reply to comment #2) > Martin, > > I suggest adding a note in the New and Noteworthy page, among other places. i added a JsDoc section to the wiki http://wiki.netbeans.org/JavaScript2 "For now we are supporting all JsDoc2 tags" which of the tags are connected to the model ? eg, i've been unable to get @lends to work in 7.3beta2 (the Sub-class Pattern from https://code.google.com/p/jsdoc-toolkit/wiki/CookBook). should i file a bug for @lends, or is that tag not connected to the model ? > Not all of them will be connected to the JavaScript model since it's quite > expensive but at least the base one are (In reply to comment #4) > i added a JsDoc section to the wiki http://wiki.netbeans.org/JavaScript2 > "For now we are supporting all JsDoc2 tags" Sorry I forgot to update the N&N document. I did it now and added information about JSDoc version 2 and included links to all tags references we are supporting (at least their syntax) > which of the tags are connected to the model ? eg, i've been unable to get > @lends to work in 7.3beta2 (the Sub-class Pattern from > https://code.google.com/p/jsdoc-toolkit/wiki/CookBook). should i file a bug for > @lends, or is that tag not connected to the model ? As I mentioned connect all of them could provide performance troubles, it's case by case. For now should be connected @class, @constructs/@constructor, @deprecated, @private/@public/@static, @returns, @type, @property, @param and the documentation takes advantage of @since, @author, @description, @example, @fileOverview, @throws. As you can see quite a lot tags are already supported. About the @lends, you are right, it is not supported yet, so please enter a new issue for that, ideally with sample code you would like to have supported. Thanks a lot! |