JDK-4469119 : docs: Document @files to work with command line options and filenames - @argfile
  • Type: Bug
  • Component: tools
  • Sub-Component: javadoc(tool)
  • Affected Version: 1.3.0
  • Priority: P3
  • Status: Closed
  • Resolution: Fixed
  • OS: solaris_2.6
  • CPU: sparc
  • Submitted: 2001-06-13
  • Updated: 2014-05-05
  • Resolved: 2002-01-09
The Version table provides details related to the release that this issue/RFE will be addressed.

Unresolved : Release in which this issue/RFE will be addressed.
Resolved: Release in which this issue/RFE has been resolved.
Fixed : Release in which this issue/RFE has been fixed. The release containing this fix may be available for download as an Early Access Release or a General Availabitlity Release.

To download the current JDK release, click here.
Other
1.4.0 betaFixed
Description
** This is a change to only the documentation, not to any code. ** 

 The feature @files was originally documented in javadoc and javac to 
 allow only filenames, not command line options.  This request is to 
 expand the documentation to say @files also allows command line 
 options.  This will enable us to say that it works for -header,
 -footer, and -bottom.  

 We would also rename @files to @argfile.

 Here is the specification for @files:

 To shorten or simplify the javadoc command line, you may
 specify one or more files that themselves contain command
 line options, source filenames and package names in any
 combination.  Filenames are relative to the current directory,
 not the location of the file containing them.
 When executing javadoc or javac, pass each the filename with the
 '@' leading character to specify it as a file list.
 Use of the '@' character to recursively interpret files is not 
 supported.  When javadoc encounters an argument beginning with
 the character `@', it operates on the names in that
 file as if they were on the command line.

 For example, you can list all of the source file names
 in a file named "sourcefiles". This source file list might
 look like:

     MyClass1.java
     MyClass2.java
     MyClass3.java

 You could create an file named "options" that contains options:

     -d /home/docs
     -verbose

 You could then run javac or javadoc with:

     % javac @options @sourcefiles
     % javadoc @options @sourcefiles


Comments
CONVERTED DATA BugTraq+ Release Management Values COMMIT TO FIX: merlin-beta FIXED IN: merlin-beta INTEGRATED IN: merlin-beta VERIFIED IN: merlin-beta3
2004-06-14

EVALUATION The spec was informally approved by David Stoutamire. His biggest concern was about spec'ing that @ does not recursively call argument files. Neal said if it's always worked this way, we cannot change it to no longer work this way, so he's in favor of documenting it. doug.kramer@Eng 2001-06-12
2001-06-12