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

Add doc comments for optionLength in Configuration.java

XMLWordPrintable

      Name: dk30142 Date: 04/27/2002

      Add the following doc comments to doclets/Configuration.java

      % diff Configuration.java Configuration-NEW.java
      2c2
      < * @(#)Configuration.java 1.43 01/12/03
      ---
      > * %W% %E%
      279c288
      < * Check for doclet added options here. This works exactly like
      ---
      > * Check for doclet-added options here. This works exactly like

      282a292,296
      > * <p>
      > * Returns the number of terms an option has, including the option name
      > * -- its so-called "length". An option that takes no arguments has
      > * only an option name, so has a length of 1. If it takes one argument,
      > * its length is 2, and so on.

      284,286c298,301
      < * @param option Option whose length is requested.
      < * @return number of arguments to option. Zero return means
      < * option not known. Negative value means error occurred.
      ---
      > * @param option the name of the option whose length is requested.
      > * @return the number of terms of an option, including the
      > * option name. Zero means option not known.
      > * Negative value means error occurred.

      289a305
      > // For options that take no arguments, return 1
      297c313,315
      < } else if (option.equals("-docencoding") ||
      ---
      > }
      > // For options that take one argument, return 2
      > else if (option.equals("-docencoding") ||
      ======================================================================

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

              Created:
              Updated:
              Resolved:
              Imported:
              Indexed: