| Page 1 of 1 | [ 5 posts ] |
|
Hi !
First of all: thank you so much for distributing this tool ! I've been waiting this for a long time to document the inputEx and WireIt librairies. It would be nice to point to the YUI documentation for classes we extend from YUI. ex: /** * @class MyAnim * @extends YAHOO.util.Anim */ The generated link points to "/docs/generator/YAHOO.util.Anim.html" where I would like to point to http://developer.yahoo.com/yui/docs/YAH ... .Anim.html |
|
A great idea, but one with some tricky problems. Even though this is YUI Doc, I don't think we should hard-code special rules for YUI (or anything else for that matter).
What might work, and I'm just throwing this out off the top of my head, are Namespace-level configuration options, where I can tell YUI Doc that anytime it would generate a link to something in the YUI namespace, the URL should be in relationship to a value I provide. This is potentially more flexible, and it allows for relatively easy linking to arbitrary libraries. I'll look through the code and try to put a proof of concept together. Jeff 'foxxtrot' Craig |
|
Sounds like it would be worth investigating this approach for a future release. yuidoc allows arbitrary markup in most fields, so you can do this today with a bit of effort (by providing the link yourself):
@type <a href="http://developer.yahoo.com/yui/docs/YAHOO.util.Anim.html">YAHOO.util.Anim</a> -Adam |
|
One more thing -- if you add the YUI source to your project, it will parse it along with your source. This means that @extend YAHOO.util.Anim will generate documentation that includes the methods and properties inherited from the animation utility.
|
|
Thanks for your replies.
I finally decided that it would perfectly fit in my template (main.tmpl): Code: #if $extends #if $extends in ('YAHOO.util.Anim', 'YAHOO.util.DD', 'YAHOO.util.DDProxy', 'YAHOO.util.DragDrop','YAHOO.util.Element', .....) - extends <a href="http://developer.yahoo.com/yui/docs/${extends}.html" title="$extends" target="_new">$extends</a> #else - extends <a href="${extends}.html" title="$extends">$extends</a> #end if #end if |
| Page 1 of 1 | [ 5 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