Re: [jboss-cvs] build/jboss build.xml

[David J. <dav...@di...>]

On 2002.05.11 00:45:12 -0400 Jason Dillon wrote:
> > In principle javadocs are great.  I don't think ours are accurate
> enough to
> > be looked at outside of the source code without excessive confusion.
> 
> Yes, that is the sad truth... I think that we need to fix this.  One of
> the key
> featurees of JBoss is its fanatical pluggability.  To sport this off we
> should
> at leat make sure that the interfaces are documented to show how things
> work.
> 
> It is too bad the aliens didn't impart some super-advanced automatic-code
> documentation system...
> 
> Until then we will have to doc this up ourselves.  I believe that this is
> important, as better javadocs empower developers to create better code,
> which
> makes JBoss better.

Agreed.  I try to add some docs wherever I go, but don't always succeed.

> 
> Anyways, the build system is designed to use the 'most' targets for
> development
> and the 'all' targets for releases.  Since doc gen takes a bit of time it
> should
> be included in the 'all' targets.

Fine, if the all target is really used for releases.  I don't think it is.
> 
>  
> > Also--the real point-- the jmx-api stuff is a configuration guide for
> the
> > mbeans.  It should be useful to jboss users who need to configure
> mbeans. 
> > javadocs IMO are usually more useful for developers or users of java
> > classes/interfaces, which jboss users usually aren't.
> 
> I think this is great... as it is closer to that super-advanced
> automatic-code
> documentation system.  Last I checked I didn't really care for the actual
> html
> it generated, but whatever. 

It's kind of experimental still.  I am no graphic designer, and all
suggestions are appreciated.  At least you looked.  I have received 0
feedback besides this comment.

> 
> More docs good... but lets not make the build slower for development. 
> Lets make
> use of the build system as it was meant to be used.
> 
> Sound reasonable?

yes

david
> 
> --jason
> 
> 
> -------------------------------------------------
> This mail sent through IMP: http://horde.org/imp/
> 
>