DO NOT REPLY [Bug 30410] - many errors in JavaDoc documentation

[bu...@apache.org]

DO NOT REPLY TO THIS EMAIL, BUT PLEASE POST YOUR BUG 
RELATED COMMENTS THROUGH THE WEB INTERFACE AVAILABLE AT
<http://issues.apache.org/bugzilla/show_bug.cgi?id=30410>.
ANY REPLY MADE TO THIS MESSAGE WILL NOT BE COLLECTED AND 
INSERTED IN THE BUG DATABASE.

http://issues.apache.org/bugzilla/show_bug.cgi?id=30410

many errors in JavaDoc documentation





------- Additional Comments From arittner@gmxpro.net  2004-11-11 08:35 -------
Yes, an additional bug is the documentation for "useexternalfile".

Here is the implementation of "useexternalfile":

/**
  * Write sourcefiles and package names to a temporary file
  * if requested.
  */
  if (useExternalFile) {
    if (tmpList == null) {
      tmpList = fileUtils.createTempFile("javadoc", "", null);
      tmpList.deleteOnExit();
      toExecute.createArgument()
        .setValue("@" + tmpList.getAbsolutePath());
    }
    srcListWriter = new PrintWriter(
      new FileWriter(tmpList.getAbsolutePath(), true));
  }

And the documentation for the @externaloptions at sun:
http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#argumentfiles

"To shorten or simplify the javadoc command line, you can specify one
or more files that themselves contain arguments to the javadoc command
(except -J options). This enables you to create javadoc commands of
any length on any operating system." 
[...]
"Example - Single Arg File
You could use a single argument file named "argfile" to hold all
Javadoc arguments:
  C:> javadoc @argfile"

And here the "wrong" ant documentation for JavaDoc:

useexternalfile (1.2+)

indicates whether the sourcefile name specified in srcfiles or as
nested source elements should be written to a temporary file to make
the command line shorter. Also applies to the package names specified
via the packagenames attribute or nested package elements. (yes | no).
Default is no.

regards, 
  josh.

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