| Page 1 of 1 | [ 6 posts ] |
|
Is there some special way I'm supposed to be using the @Override tag?
I have some custom classes that extend other classes, and sometimes I have methods inside the custom subclasses that override the ones in the original class. Sometimes I just use: Code: /** * Description * * @Override * @method methodname */ And it works fine. It displays one method that has an override note. Other times it just doesn't work at all and displays both methods separately. Is there some trick I'm not getting? |
|
In the current YUIDoc 0.3.x there is no such tag as `@override`. AFAIK there never was a tag for that.
|
|
How is this effect achieved then?
Quote: renderFields () Inherited from class1 but overwritten in thisfile.js:143 New overwritten description. I see this happening in one of my subclasses but not others, when the method names are the same... |
|
If you use the `@extends` tag and point to the class that you extended YUIDoc fixes it all for you.
Example: http://yuilibrary.com/yui/docs/api/classes/DD.Drag.html http://yuilibrary.com/yui/docs/api/file ... js.html#l7 Note the "Extends: Base" part.. |
|
I am using @extends and pointing to the correct class.
YUIDoc is even loading all of the superclass methods that are not being defined in my subclass. I'm getting duplicate methods instead of overwritten methods in some cases but not all: Quote: renderFields () Defined in thisfile.js:17 Description that is supposed to override the old one renderFields () Inherited from Superclass: superclassfile.js:1207 Superclass description |
|
Please file a repro case here:
https://github.com/yui/yuidoc/issues Also note that YUIDoc has a support forum here: https://groups.google.com/forum/?hl=en& ... rum/yuidoc |
| Page 1 of 1 | [ 6 posts ] |
| You cannot post new topics in this forum You cannot reply to topics in this forum You cannot edit your posts in this forum You cannot delete your posts in this forum |
© 2006-2013 Yahoo! Inc. All rights reserved.
All code on this site is licensed under the BSD License unless stated otherwise.
About This Site · Security Contact Info
Powered by phpBB® Forum Software © phpBB Group