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

Unnecessary <p> tags in jfr classes

XMLWordPrintable

    • jfr
    • b24

        doccheck reports:

        build/linux-x86_64-server-release/images/docs/api/jdk.jfr/jdk/jfr/package-summary.html:171:2: Warning: trimming empty <p>

        build/linux-x86_64-server-release/images/docs/api/jdk.management.jfr/jdk/management/jfr/FlightRecorderMXBean.html:984:2: Warning: trimming empty <p>

        The first is caused by <p> before <table>:
        open/src/jdk.jfr/share/classes/jdk/jfr/package-info.java:108

         * <b>Predefined settings</b>
         * <p>
         * <table class="striped">

        The second is caused by <p> before </div> in the generated file, caused by <p> at the end of a description, and before @param in the source file:
        open/src/jdk.management.jfr/share/classes/jdk/management/jfr/FlightRecorderMXBean.java:520:


             * A list of available event names is retrieved by invoking
             * {@link jdk.jfr.FlightRecorder#getEventTypes()} and
             * {@link jdk.jfr.EventType#getName()}. A list of available settings for an
             * event type is obtained by invoking
             * {@link jdk.jfr.EventType#getSettingDescriptors()} and
             * {@link jdk.jfr.ValueDescriptor#getName()}.
             * <p>
             *
             * @param recordingId ID of the recording

              egahlin Erik Gahlin
              jjg Jonathan Gibbons
              Votes:
              0 Vote for this issue
              Watchers:
              6 Start watching this issue

                Created:
                Updated:
                Resolved: