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

Rename javadoc Messager class to JavadocLog

    XMLWordPrintable

Details

    • Enhancement
    • Resolution: Fixed
    • P4
    • 17
    • 17
    • tools

    Description

      The name `Messager` as a class providing reporting facilities is an anachronism. The name is also confusingly similar to the name of the internal `Messages` class in the doclet world.

      `Messager` is built on top of the javac `Log` class (it's a subtype), and there is a separate convention in the javadoc tool world of using a prefix of `Javadoc` for javadoc subtypes of javac classes ... e.g. JavadocEnter, JavadocClassFinder, etc.

      With that in mind, it would make sense to rename `Messager` to `JavadocLog`.

      Notes:
      This only affects the internal "javadoc tool" world; doclets use the public `Reporter` interface.
      Generally, the preferred capitalization of `javadoc` is `JavaDoc` ... but there is string/historical precedent in this specific context to use `Javadoc`.

      Attachments

        Issue Links

          Activity

            People

              jjg Jonathan Gibbons
              jjg Jonathan Gibbons
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: