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

Update Elements for '///' documentation comments

XMLWordPrintable

    • Icon: Enhancement Enhancement
    • Resolution: Fixed
    • Icon: P3 P3
    • 23
    • 23
    • core-libs
    • None

      JEP 467 introduces the use of `///` for documentation comments using Markdown syntax.

      javax.lang.model.util.Elements.getDocComment(Element) specifies how to obtain the "raw" content of a documentation comment, removing any decorative markers and leading whitespace, to yield a simple string.
      As such, it should be updated to cover the new `///` form of documentation comments.

      In addition, a new method should be added to return the "style" of the comment.

      Note: the method does not mandate any particular interpretation of the content of a documentation comment. It is up to the consumer of the comment to choose how to interpret the contents.

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

              Created:
              Updated:
              Resolved: