leonardocxavier / jsdoc-toolkit

Automatically exported from code.google.com/p/jsdoc-toolkit
0 stars 0 forks source link

Feature request:@config and @override tag #205

Closed GoogleCodeExporter closed 8 years ago

GoogleCodeExporter commented 8 years ago
hi,

Just an idea or feature request for further development of the amazing
jsdoc-toolkit:
When do some development on object-oriented javascript, i think it would be
a useful feature to have @config and @override tag.
For example:

Ext.BoxComponent = Ext.extend(Ext.Component, {
    /**
     *@config {Boolean} deferHeight
     */
     deferHeight:false,

    /**
     *@override
     */
    onRender:function(){
      //somethting
    }

});

btw:Thx for your nice work!

Best Regards
Jason

Original issue reported on code.google.com by jasonyi...@gmail.com on 13 Feb 2009 at 3:39

GoogleCodeExporter commented 8 years ago
I'm not sure I understand the purpose of these proposed tags. Can you provide a 
short explanation of what 
@override does? Wouldn't @config be the same as a @param?

Original comment by micmath on 15 Feb 2009 at 12:19

GoogleCodeExporter commented 8 years ago
I'm sorry for the  blur explanation. When a method in subclass override a
superclass's method, needed a comment tag just like @override. And @config mean 
a
parameter is a configure option. Maybe you can found the same usage in Extjs 
Component.js

thx.

Jason

Original comment by jasonyi...@gmail.com on 19 Feb 2009 at 3:30

GoogleCodeExporter commented 8 years ago
I believe both these issues can already be addressed by existing tags, for 
example: @augments and @property. If 
you have an example where using those tags to solve your problem is impossible 
I'll reopen this issue.

Original comment by micmath on 21 Jun 2009 at 10:48