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

Doclet API: Document how doclets must ignore options to pass them to javadoc

    XMLWordPrintable

Details

    • Enhancement
    • Resolution: Not an Issue
    • P4
    • None
    • 1.4.2
    • tools

    Description

      Document in com.sun.javadoc.Doclet class

      The standard doclet does not have any special code to support the -source
      option. The validation for that option is handled in the javadoc tool. Does
      the stubmaker doclet meet these 2 requirements?

      1. Ignore unknown options during validation (Doclet.validOptions()).

      2. Return a negative number for unknown options when checking "option length"
      (Doclet.optionLength()).

      I suspect that stubmaker does not meet requirement #1. I can't think of any
      other reason why it would not support -source option. We need to improve the
      API documentation so that other doclet writers know about this.

      Attachments

        Activity

          People

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

            Dates

              Created:
              Updated:
              Resolved:
              Imported:
              Indexed: