One really handy feature in javadoc is that classes and interfaces have links to direct known subclasses (for classes) and direct known subinterfaces and implementations (for interfaces). I've found myself missing this many times while browsing the fandocs.
We probably want to have some kind of switch for excluding this listing from the fandoc for certain classes e.g. sys::Obj since pretty much everything extends that.
andyThu 14 May 2009
I had this in there at one time, but took it out, prob due to the excessive noise. But I agree it would be nice, probably hidden be default.
brianThu 14 May 2009
The major problem with that feature is that only works for monolith things like the JDK.
Since everything in Fan is designed to be modular, pods don't know about pods further down in the dependency chain.
But what we could do it is use the type database to discover it at runtime (based on which pods are installed). But that won't work for statically generated docs.
alexlamslThu 14 May 2009
With the javadoc tool, it will only generate such list with to its best knowledge. For instance, it would not generate any links to java.lang.String etc unless I supply the URL in the command line for the JavaSE core library. Same happens downstream.
So I think we should be able to do the same for fandoc tool - i.e. generate subclass lists for all the pods supplied in a given run. So you can generate the docs on this website by supplying all the pods in the distro to the fandoc tool...
qualidafial Thu 14 May 2009
One really handy feature in javadoc is that classes and interfaces have links to direct known subclasses (for classes) and direct known subinterfaces and implementations (for interfaces). I've found myself missing this many times while browsing the fandocs.
We probably want to have some kind of switch for excluding this listing from the fandoc for certain classes e.g.
sys::Objsince pretty much everything extends that.andy Thu 14 May 2009
I had this in there at one time, but took it out, prob due to the excessive noise. But I agree it would be nice, probably hidden be default.
brian Thu 14 May 2009
The major problem with that feature is that only works for monolith things like the JDK.
Since everything in Fan is designed to be modular, pods don't know about pods further down in the dependency chain.
But what we could do it is use the type database to discover it at runtime (based on which pods are installed). But that won't work for statically generated docs.
alexlamsl Thu 14 May 2009
With the javadoc tool, it will only generate such list with to its best knowledge. For instance, it would not generate any links to
java.lang.Stringetc unless I supply the URL in the command line for the JavaSE core library. Same happens downstream.So I think we should be able to do the same for fandoc tool - i.e. generate subclass lists for all the pods supplied in a given run. So you can generate the docs on this website by supplying all the pods in the distro to the fandoc tool...