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

JFR: Improve javadoc for @Name

    XMLWordPrintable

    Details

    • Type: Enhancement
    • Status: Resolved
    • Priority: P3
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 16
    • Component/s: hotspot
    • Labels:
      None
    • Subcomponent:
      jfr
    • Resolved In Build:
      b06

      Description

      The documentation of the jdk.jfr.Name annotation should contain more information to guide users. In particular,

      - The event in the example should not be called "MyEvent". Using the "Event"-suffix is not recommended.

      - We should provide information of what constitutes a good name, reverse domain notation etc.

      See:

      https://github.com/flight-recorder/samples/blob/master/Sample_13_Name.java

        Attachments

          Activity

            People

            Assignee:
            egahlin Erik Gahlin
            Reporter:
            egahlin Erik Gahlin
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved: