RFR: docs/accessibility: JDK-8220251: fix headings in java.management

Jonathan Gibbons jonathan.gibbons at oracle.com
Thu May 30 23:53:24 UTC 2019 

Please review a conceptually simple fix to adjust the rank of the 
headings in the following files in 4 management-related modules:

src/java.management.rmi/share/classes/javax/management/remote/rmi/package.html
src/java.management/share/classes/java/lang/management/LockInfo.java
src/java.management/share/classes/java/lang/management/ManagementFactory.java
src/java.management/share/classes/java/lang/management/MemoryMXBean.java
src/java.management/share/classes/java/lang/management/MemoryPoolMXBean.java
src/java.management/share/classes/java/lang/management/MemoryUsage.java
src/java.management/share/classes/java/lang/management/MonitorInfo.java
src/java.management/share/classes/java/lang/management/ThreadInfo.java
src/java.management/share/classes/java/lang/management/ThreadMXBean.java
src/java.management/share/classes/java/lang/management/package.html
src/java.management/share/classes/javax/management/MXBean.java
src/java.management/share/classes/javax/management/NotificationBroadcaster.java
src/java.management/share/classes/javax/management/NotificationEmitter.java
src/java.management/share/classes/javax/management/remote/package.html
src/jdk.management.jfr/share/classes/jdk/management/jfr/FlightRecorderMXBean.java
src/jdk.management/share/classes/com/sun/management/GcInfo.java

In most files, the headings are simply adjusted "up" to close up "gaps" 
in the sequence of headings. In a couple of files, the headings were 
inconsistent and have been updated as seems best. To help understand the 
changes, I've attached the output of a script that shows the lines 
containing headings before and after the change.

-- Jon

JBS: https://bugs.openjdk.java.net/browse/JDK-8220251
Webrev: http://cr.openjdk.java.net/~jjg/8220251/webrev.00/webrev/index.html
Docs: http://cr.openjdk.java.net/~jjg/8220251/docs/api/index.html

-------------- next part --------------
>>> open/src/java.management.rmi/share/classes/javax/management/remote/rmi/package.html
BEFORE:
    <h3>Creating an RMI connector server</h3>
    <h4>Choosing the RMI transport</h4>
    <h4><a id="servergen">Connector addresses generated by the
	server</a></h4>
    <h4><a id="directory">Connector addresses based on directory
	entries</a></h4>
    <h4>Connector server attributes</h4>
    <h3>Creating an RMI connector client</h3>
    <h3>Dynamic code downloading</h3>

AFTER:
    <h2>Creating an RMI connector server</h2>
    <h3>Choosing the RMI transport</h3>
    <h3><a id="servergen">Connector addresses generated by the
	server</a></h3>
    <h3><a id="directory">Connector addresses based on directory
	entries</a></h3>
    <h3>Connector server attributes</h3>
    <h2>Creating an RMI connector client</h2>
    <h2>Dynamic code downloading</h2>


>>> open/src/java.management/share/classes/java/lang/management/LockInfo.java
BEFORE:
 * <h3><a id="MappedType">MXBean Mapping</a></h3>

AFTER:
 * <h2><a id="MappedType">MXBean Mapping</a></h2>


>>> open/src/java.management/share/classes/java/lang/management/ManagementFactory.java
BEFORE:
 * <h3><a id="MXBean">Platform MXBeans</a></h3>
 * <h4>1. Direct access to an MXBean interface</h4>
 * <h4>2. Indirect access to an MXBean interface via MBeanServer</h4>

AFTER:
 * <h2><a id="MXBean">Platform MXBeans</a></h2>
 * <h3>1. Direct access to an MXBean interface</h3>
 * <h3>2. Indirect access to an MXBean interface via MBeanServer</h3>


>>> open/src/java.management/share/classes/java/lang/management/MemoryMXBean.java
BEFORE:
 * <h3> Memory </h3>
 * <h3> 1. Heap </h3>
 * <h3> 2. Non-Heap Memory</h3>
 * <h3>Memory Pools and Memory Managers</h3>
 * <h3>Memory Usage Monitoring</h3>
 * <h3>Notifications</h3>
 * <h3>NotificationEmitter</h3>

AFTER:
 * <h2> Memory </h2>
 * <h3> 1. Heap </h3>
 * <h3> 2. Non-Heap Memory</h3>
 * <h2>Memory Pools and Memory Managers</h2>
 * <h2>Memory Usage Monitoring</h2>
 * <h2>Notifications</h2>
 * <h2>NotificationEmitter</h2>


>>> open/src/java.management/share/classes/java/lang/management/MemoryPoolMXBean.java
BEFORE:
 * <h3>Memory Type</h3>
 * <h3>Memory Usage Monitoring</h3>
 * <h3><a id="Usage">1. Memory Usage</a></h3>
 * <h3><a id="PeakUsage">2. Peak Memory Usage</a></h3>
 * <h3><a id="UsageThreshold">3. Usage Threshold</a></h3>
 * <h3><a id="CollectionThreshold">4. Collection Usage Threshold</a></h3>

AFTER:
 * <h2>Memory Type</h2>
 * <h2>Memory Usage Monitoring</h2>
 * <h3><a id="Usage">1. Memory Usage</a></h3>
 * <h3><a id="PeakUsage">2. Peak Memory Usage</a></h3>
 * <h3><a id="UsageThreshold">3. Usage Threshold</a></h3>
 * <h3><a id="CollectionThreshold">4. Collection Usage Threshold</a></h3>


>>> open/src/java.management/share/classes/java/lang/management/MemoryUsage.java
BEFORE:
 * <h3>MXBean Mapping</h3>

AFTER:
 * <h2>MXBean Mapping</h2>


>>> open/src/java.management/share/classes/java/lang/management/MonitorInfo.java
BEFORE:
 * <h3>MXBean Mapping</h3>

AFTER:
 * <h2>MXBean Mapping</h2>


>>> open/src/java.management/share/classes/java/lang/management/ThreadInfo.java
BEFORE:
 * <h3>General thread information</h3>
 * <h3>Execution information</h3>
 * <h4><a id="SyncStats">Synchronization Statistics</a></h4>
 * <h4>MXBean Mapping</h4>

AFTER:
 * <h2>General thread information</h2>
 * <h2>Execution information</h2>
 * <h3><a id="SyncStats">Synchronization Statistics</a></h3>
 * <h3>MXBean Mapping</h3>


>>> open/src/java.management/share/classes/java/lang/management/ThreadMXBean.java
BEFORE:
 * <h3>Thread ID</h3>
 * <h3>Thread CPU time</h3>
 * <h3>Thread Contention Monitoring</h3>
 * <h3>Synchronization Information and Deadlock Detection</h3>

AFTER:
 * <h2>Thread ID</h2>
 * <h2>Thread CPU time</h2>
 * <h2>Thread Contention Monitoring</h2>
 * <h2>Synchronization Information and Deadlock Detection</h2>


>>> open/src/java.management/share/classes/java/lang/management/package.html
BEFORE:
<h3><a id="MXBean">Platform MXBean</a></h3>
<h3>ManagementFactory</h3>
<h3>Interoperability</h3>
<h3><a id="examples">Ways to Access MXBeans</a></h3>
<h3><a id="extension">Platform Extension</a></h3>

AFTER:
<h2><a id="MXBean">Platform MXBean</a></h2>
<h2>ManagementFactory</h2>
<h2>Interoperability</h2>
<h2><a id="examples">Ways to Access MXBeans</a></h2>
<h2><a id="extension">Platform Extension</a></h2>


>>> open/src/java.management/share/classes/javax/management/MXBean.java
BEFORE:
    <h3 id="MXBean-spec">MXBean specification</h3>
        <h4>Standard MBean</h4>
        <h4>MXBean</h4>
        <h4>Standard MBean</h4>
        <h4>MXBean</h4>
        <h4>Standard MBean</h4>
        <h4>MXBean</h4>
        <h4>Standard MBean</h4>
        <h4>MXBean</h4>
        <h4>Standard MBean</h4>
        <h4>MXBean</h4>
        <h4>Standard MBean</h4>
        <h4>MXBean</h4>
    <h2 id="mxbean-def">Definition of an MXBean</h2>
    <h2 id="naming-conv">Naming conventions</h2>
    <h2 id="mapping-rules">Type mapping rules</h2>
    <h3>Mappings for primitive types</h3>
    <h3>Mappings for collections ({@code List<}<em>E</em>{@code >} etc)</h3>
    <h3>Mappings for maps ({@code Map<}<em>K</em>,<em>V</em>{@code >} etc)</h3>
    <h3 id="mxbean-map">Mappings for MXBean interfaces</h3>
    <h3 id="composite-map">Mappings for other types</h3>
    <h4>Reconstructing an instance of Java type <em>J</em> from
      a {@code CompositeData}</h4>
    <h3>Recursive types</h3>
    <h3>MBeanInfo contents for an MXBean</h3>
    <h3 id="type-names">Type Names</h3>
    <h3>Exceptions</h3>

AFTER:
    <h2 id="MXBean-spec">MXBean specification</h2>
        <h3>Standard MBean</h3>
        <h3>MXBean</h3>
        <h3>Standard MBean</h3>
        <h3>MXBean</h3>
        <h3>Standard MBean</h3>
        <h3>MXBean</h3>
        <h3>Standard MBean</h3>
        <h3>MXBean</h3>
        <h3>Standard MBean</h3>
        <h3>MXBean</h3>
        <h3>Standard MBean</h3>
        <h3>MXBean</h3>
    <h2 id="mxbean-def">Definition of an MXBean</h2>
    <h2 id="naming-conv">Naming conventions</h2>
    <h2 id="mapping-rules">Type mapping rules</h2>
    <h3>Mappings for primitive types</h3>
    <h3>Mappings for collections ({@code List<}<em>E</em>{@code >} etc)</h3>
    <h3>Mappings for maps ({@code Map<}<em>K</em>,<em>V</em>{@code >} etc)</h3>
    <h3 id="mxbean-map">Mappings for MXBean interfaces</h3>
    <h3 id="composite-map">Mappings for other types</h3>
    <h4>Reconstructing an instance of Java type <em>J</em> from
      a {@code CompositeData}</h4>
    <h3>Recursive types</h3>
    <h3>MBeanInfo contents for an MXBean</h3>
    <h3 id="type-names">Type Names</h3>
    <h3>Exceptions</h3>


>>> open/src/java.management/share/classes/javax/management/NotificationBroadcaster.java
BEFORE:
 * <h3>Notification dispatch</h3>

AFTER:
 * <h2>Notification dispatch</h2>


>>> open/src/java.management/share/classes/javax/management/NotificationEmitter.java
BEFORE:
 * <h3>Notification dispatch</h3>

AFTER:
 * <h2>Notification dispatch</h2>


>>> open/src/java.management/share/classes/javax/management/remote/package.html
BEFORE:
      <h3>Connector addresses</h3>
      <h3>Creating a connector server</h3>
      <h3>Creating a connector client</h3>
      <h3>Additional client or server parameters</h3>
      <h3>Connection identifiers</h3>

AFTER:
      <h2>Connector addresses</h2>
      <h2>Creating a connector server</h2>
      <h2>Creating a connector client</h2>
      <h2>Additional client or server parameters</h2>
      <h2>Connection identifiers</h2>


>>> open/src/jdk.management.jfr/share/classes/jdk/management/jfr/FlightRecorderMXBean.java
BEFORE:
 * <h3>Recording options</h3>

AFTER:
 * <h2>Recording options</h2>


>>> open/src/jdk.management/share/classes/com/sun/management/GcInfo.java
BEFORE:
 * <h3>MXBean Mapping</h3>

AFTER:
 * <h2>MXBean Mapping</h2>

More information about the serviceability-dev mailing list