ant-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Jon Skeet" <jon.sk...@peramon.com>
Subject RE: [PATCH] /src/main/org/apache/tools/ant/IntrospectionHelper.java (More JavaDocs)
Date Wed, 20 Feb 2002 09:55:28 GMT
> I think the javadocs should work for all people who compile Ant, which
> means they should work in 1.1, but then again, I'm sure I've added
> {@link a b} constructs in several places myself.

Well, I've now run across what seems to be a *big* problem with this idea - and indeed one
which I should have worked out earlier.

JavaDoc will barf with an error if it can't find referenced classes etc. I already realised
this when trying to build all the JavaDocs to start with - I've downloaded quite a few optional
libraries, but not ones like WebLogic etc. I just deleted those optional classes (as I needed
to be able to compile within Eclipse as well) and things were okay again. However, this does
mean that any optional classes which require Java2 (NoExitSecurityManager for example) cause
JavaDoc to barf under 1.1.

We either need to build JavaDocs conditionally in the same way that we build classes conditionally,
or work out some other way of working - or just say that building the JavaDocs is really only
suitable for people who are willing to either get all the dependencies or prune their source
tree.

The good news is that even under 1.1 the construct:

/**
 * JavaDoc
 */
// Non-JavaDoc
public Foo()
{
}

works.

Maybe it's just under 1.2 that it fails... anyone got 1.2 installed and fancy building the
JavaDocs (given the caveat earlier!) ? If (when building with -private) IntrospectionHelper's
constructor looks okay, we're fine.

Jon

--
To unsubscribe, e-mail:   <mailto:ant-dev-unsubscribe@jakarta.apache.org>
For additional commands, e-mail: <mailto:ant-dev-help@jakarta.apache.org>


Mime
View raw message