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

Remove (obsolete) @author info from javadoc source and tests

    Details

    • Type: Bug
    • Status: Resolved
    • Priority: P4
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 14
    • Component/s: tools
    • Labels:

      Description

      The `@author` tags in the comments for the source and tests for the javadoc tool are way out of date. Since the code was moved to an open source Mercurial repository in 2007, the accurate information about contributions has been in the changeset metadata. The tags that predate 2007 are in code that has been heavily modified over the years, such that the original authors probably would not recognize it any more.

      We should remove these tags, and rely on changeset metadata to accurately record contributions.

      For the record, the names being removed are the following:

      A. Sundararajan
      Atul Dambalkar.
      Atul M Dambalkar
      Bhavesh Patel
      Bhavesh Patel (Modified)
      Doug Kramer
      Jamie Ho
      Jamie Ho (Re-write)
      Jamie Ho (rewrite)
      Jesse Glick
      Joe Fialli
      Jonathan Gibbons (rewrite)
      Mahmood Ali
      Mahmood Ali <mali>
      Mike Duigou
      Naoto Sato
      Neal Gafter
      Neal Gafter (rewrite)
      Peter von der Ah\u00e9
      Robert Field
      Robert Field.
      Robert G. Field
      Scott Seligman
      Scott Seligman (generics)
      Yuri Nesterenko
      bpatel
      dkramer
      gafter
      jamieh
      jayashree viswanathan
      jjg
      jvalenta

      --------------
      Please note that the removed occurrences relate to different `@author` tags. Source files contain only javadoc tags, while tests files contain both javadoc tags and jtreg tags.

      Some occurrences of the javadoc `@author` tag cannot (or should not) be removed from the tests without prior analysis. This is because sometimes `@author` tags play a role in the test. An example of such a test would be open/test/langtools/jdk/javadoc/doclet/AuthorDD/AuthorDD.java. Other times, it is not clear if a tag does anything useful. An example would be test/langtools/jdk/javadoc/doclet/testAnnotationOptional/TestAnnotationOptional.java.

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                prappo Pavel Rappo
                Reporter:
                jjg Jonathan Gibbons
              • Votes:
                0 Vote for this issue
                Watchers:
                1 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: