Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-4469119

docs: Document @files to work with command line options and filenames - @argfile

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Fixed
    • Icon: P3 P3
    • 1.4.0
    • 1.3.0
    • tools
    • beta
    • sparc
    • solaris_2.6
    • Verified

      ** 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

            dkramersunw Douglas Kramer (Inactive)
            dkramersunw Douglas Kramer (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

              Created:
              Updated:
              Resolved:
              Imported:
              Indexed: