stan/jdk-24
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

8020308: Fix doclint issues in java.lang.management

Browse Source 
Reviewed-by: darcy
This commit is contained in:
Serguei Spitsyn 2013-07-10 14:20:19 -07:00 committed by Serguei Spitsyn
parent 9123d3fed3
commit a809f3b3f0
10 changed files with 56 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
jdk/src/share/classes/java/lang/management/LockInfo.java
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -42,7 +42,7 @@ import sun.management.LockInfoCompositeData;
* {@link ReentrantReadWriteLock ReentrantReadWriteLock} are
* two examples of ownable synchronizers provided by the platform.
*
* <h4><a name="MappedType">MXBean Mapping</a></h4>
* <h3><a name="MappedType">MXBean Mapping</a></h3>
* <tt>LockInfo</tt> is mapped to a {@link CompositeData CompositeData}
* as specified in the {@link #from from} method.
*
@ -105,7 +105,7 @@ public class LockInfo {
* given {@code CompositeData}.
* The given {@code CompositeData} must contain the following attributes:
* <blockquote>
* <table border>
* <table border summary="The attributes and the types the given CompositeData contains">
* <tr>
* <th align=left>Attribute Name</th>
* <th align=left>Type</th>

22
jdk/src/share/classes/java/lang/management/ManagementFactory.java
View File

@ -61,7 +61,7 @@ import sun.management.ManagementFactoryHelper;
* the management interface of a component of the Java virtual
* machine.
* <p>
* <h4><a name="MXBean">Platform MXBeans</a></h4>
* <h3><a name="MXBean">Platform MXBeans</a></h3>
* <p>
* A platform MXBean is a <i>managed bean</i> that
* conforms to the <a href="../../../javax/management/package-summary.html">JMX</a>
@ -87,7 +87,7 @@ import sun.management.ManagementFactoryHelper;
*
* <p>
* An application can access a platform MXBean in the following ways:
* <h5>1. Direct access to an MXBean interface</h5>
* <h4>1. Direct access to an MXBean interface</h4>
* <blockquote>
* <ul>
* <li>Get an MXBean instance by calling the
@ -107,7 +107,7 @@ import sun.management.ManagementFactoryHelper;
* an MXBean of another running virtual machine.
* </li>
* </ul>
* <h5>2. Indirect access to an MXBean interface via MBeanServer</h5>
* <h4>2. Indirect access to an MXBean interface via MBeanServer</h4>
* <ul>
* <li>Go through the platform {@code MBeanServer} to access MXBeans
* locally or a specific <tt>MBeanServerConnection</tt> to access
@ -135,7 +135,7 @@ import sun.management.ManagementFactoryHelper;
* interfaces:
*
* <blockquote>
* <table border>
* <table border summary="The list of Management Interfaces and their single instances">
* <tr>
* <th>Management Interface</th>
* <th>ObjectName</th>
@ -178,7 +178,7 @@ import sun.management.ManagementFactoryHelper;
* the following management interfaces.
*
* <blockquote>
* <table border>
* <table border summary="The list of Management Interfaces and their single instances">
* <tr>
* <th>Management Interface</th>
* <th>ObjectName</th>
@ -195,7 +195,7 @@ import sun.management.ManagementFactoryHelper;
* A Java virtual machine may have one or more instances of the following
* management interfaces.
* <blockquote>
* <table border>
* <table border summary="The list of Management Interfaces and their single instances">
* <tr>
* <th>Management Interface</th>
* <th>ObjectName</th>
@ -561,6 +561,12 @@ public class ManagementFactory {
* in the format of {@link ObjectName ObjectName}.
* @param mxbeanInterface the MXBean interface to be implemented
* by the proxy.
* @param <T> an {@code mxbeanInterface} type parameter
*
* @return a proxy for a platform MXBean interface of a
* given <a href="#MXBeanNames">MXBean name</a>
* that forwards its method calls through the given
* <tt>MBeanServerConnection</tt>, or {@code null} if not exist.
*
* @throws IllegalArgumentException if
* <ul>
@ -635,6 +641,7 @@ public class ManagementFactory {
* @param mxbeanInterface a management interface for a platform
* MXBean with one single instance in the Java virtual machine
* if implemented.
* @param <T> an {@code mxbeanInterface} type parameter
*
* @return the platform MXBean that implements
* {@code mxbeanInterface}, or {@code null} if not exist.
@ -670,6 +677,7 @@ public class ManagementFactory {
*
* @param mxbeanInterface a management interface for a platform
* MXBean
* @param <T> an {@code mxbeanInterface} type parameter
*
* @return the list of platform MXBeans that implement
* {@code mxbeanInterface}.
@ -707,6 +715,7 @@ public class ManagementFactory {
* @param mxbeanInterface a management interface for a platform
* MXBean with one single instance in the Java virtual machine
* being monitored, if implemented.
* @param <T> an {@code mxbeanInterface} type parameter
*
* @return the platform MXBean proxy for
* forwarding the method calls of the {@code mxbeanInterface}
@ -750,6 +759,7 @@ public class ManagementFactory {
* @param connection the {@code MBeanServerConnection} to forward to.
* @param mxbeanInterface a management interface for a platform
* MXBean
* @param <T> an {@code mxbeanInterface} type parameter
*
* @return the list of platform MXBean proxies for
* forwarding the method calls of the {@code mxbeanInterface}

16
jdk/src/share/classes/java/lang/management/MemoryMXBean.java
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 2003, 2008, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -49,11 +49,11 @@ import javax.management.openmbean.CompositeData;
* It can be obtained by calling the
* {@link PlatformManagedObject#getObjectName} method.
*
* <h4> Memory </h4>
* <h3> Memory </h3>
* The memory system of the Java virtual machine manages
* the following kinds of memory:
*
* <h4> 1. Heap </h4>
* <h3> 1. Heap </h3>
* The Java virtual machine has a <i>heap</i> that is the runtime
* data area from which memory for all class instances and arrays
* are allocated. It is created at the Java virtual machine start-up.
@ -63,7 +63,7 @@ import javax.management.openmbean.CompositeData;
* <p>The heap may be of a fixed size or may be expanded and shrunk.
* The memory for the heap does not need to be contiguous.
*
* <h4> 2. Non-Heap Memory</h4>
* <h3> 2. Non-Heap Memory</h3>
* The Java virtual machine manages memory other than the heap
* (referred as <i>non-heap memory</i>).
*
@ -87,7 +87,7 @@ import javax.management.openmbean.CompositeData;
* machine code translated from the Java virtual machine code for
* high performance.
*
* <h4>Memory Pools and Memory Managers</h4>
* <h3>Memory Pools and Memory Managers</h3>
* {@link MemoryPoolMXBean Memory pools} and
* {@link MemoryManagerMXBean memory managers} are the abstract entities
* that monitor and manage the memory system
@ -105,7 +105,7 @@ import javax.management.openmbean.CompositeData;
* add or remove memory managers during execution.
* A memory pool can be managed by more than one memory manager.
*
* <h4>Memory Usage Monitoring</h4>
* <h3>Memory Usage Monitoring</h3>
*
* Memory usage is a very important monitoring attribute for the memory system.
* The memory usage, for example, could indicate:
@ -131,7 +131,7 @@ import javax.management.openmbean.CompositeData;
* certain threshold. It is not intended for an application to detect
* and recover from a low memory condition.
*
* <h4>Notifications</h4>
* <h3>Notifications</h3>
*
* <p>This <tt>MemoryMXBean</tt> is a
* {@link javax.management.NotificationEmitter NotificationEmitter}
@ -169,7 +169,7 @@ import javax.management.openmbean.CompositeData;
* MemoryNotificationInfo}.
*
* <hr>
* <h4>NotificationEmitter</h4>
* <h3>NotificationEmitter</h3>
* The <tt>MemoryMXBean</tt> object returned by
* {@link ManagementFactory#getMemoryMXBean} implements
* the {@link javax.management.NotificationEmitter NotificationEmitter}

4
jdk/src/share/classes/java/lang/management/MemoryNotificationInfo.java
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 2003, 2006, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -212,7 +212,7 @@ public class MemoryNotificationInfo {
* The given <tt>CompositeData</tt> must contain
* the following attributes:
* <blockquote>
* <table border>
* <table border summary="The attributes and the types the given CompositeData contains">
* <tr>
* <th align=left>Attribute Name</th>
* <th align=left>Type</th>

14
jdk/src/share/classes/java/lang/management/MemoryPoolMXBean.java
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 2003, 2008, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -49,7 +49,7 @@ package java.lang.management;
* It can be obtained by calling the
* {@link PlatformManagedObject#getObjectName} method.
*
* <h4>Memory Type</h4>
* <h3>Memory Type</h3>
* <p>The Java virtual machine has a heap for object allocation and also
* maintains non-heap memory for the method area and the Java virtual
* machine execution. The Java virtual machine can have one or more
@ -60,7 +60,7 @@ package java.lang.management;
* <li>{@link MemoryType#NON_HEAP non-heap}</li>
* </ul>
*
* <h4>Memory Usage Monitoring</h4>
* <h3>Memory Usage Monitoring</h3>
*
* A memory pool has the following attributes:
* <ul>
@ -71,7 +71,7 @@ package java.lang.management;
* (only supported by some <em>garbage-collected</em> memory pools)</li>
* </ul>
*
* <h4><a name="Usage">1. Memory Usage</a></h4>
* <h3><a name="Usage">1. Memory Usage</a></h3>
*
* The {@link #getUsage} method provides an estimate
* of the current usage of a memory pool.
@ -86,14 +86,14 @@ package java.lang.management;
* the current memory usage. An implementation should document when
* this is the case.
*
* <h4><a name="PeakUsage">2. Peak Memory Usage</a></h4>
* <h3><a name="PeakUsage">2. Peak Memory Usage</a></h3>
*
* The Java virtual machine maintains the peak memory usage of a memory
* pool since the virtual machine was started or the peak was reset.
* The peak memory usage is returned by the {@link #getPeakUsage} method
* and reset by calling the {@link #resetPeakUsage} method.
*
* <h4><a name="UsageThreshold">3. Usage Threshold</a></h4>
* <h3><a name="UsageThreshold">3. Usage Threshold</a></h3>
*
* Each memory pool has a manageable attribute
* called the <i>usage threshold</i> which has a default value supplied
@ -304,7 +304,7 @@ package java.lang.management;
* </li>
* </ol>
*
* <h4><a name="CollectionThreshold">4. Collection Usage Threshold</a></h4>
* <h3><a name="CollectionThreshold">4. Collection Usage Threshold</a></h3>
*
* Collection usage threshold is a manageable attribute only applicable
* to some garbage-collected memory pools.

10
jdk/src/share/classes/java/lang/management/MemoryUsage.java
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 2003, 2004, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -36,8 +36,7 @@ import sun.management.MemoryUsageCompositeData;
* the heap or non-heap memory of the Java virtual machine as a whole.
*
* <p> A <tt>MemoryUsage</tt> object contains four values:
* <ul>
* <table>
* <table summary="Describes the MemoryUsage object content">
* <tr>
* <td valign=top> <tt>init</tt> </td>
* <td valign=top> represents the initial amount of memory (in bytes) that
@ -78,7 +77,6 @@ import sun.management.MemoryUsageCompositeData;
* </td>
* </tr>
* </table>
* </ul>
*
* Below is a picture showing an example of a memory pool:
* <p>
@ -98,7 +96,7 @@ import sun.management.MemoryUsageCompositeData;
* max
* </pre>
*
* <h4>MXBean Mapping</h4>
* <h3>MXBean Mapping</h3>
* <tt>MemoryUsage</tt> is mapped to a {@link CompositeData CompositeData}
* with attributes as specified in the {@link #from from} method.
*
@ -254,7 +252,7 @@ public class MemoryUsage {
* must contain the following attributes:
* <p>
* <blockquote>
* <table border>
* <table border summary="The attributes and the types the given CompositeData contains">
* <tr>
* <th align=left>Attribute Name</th>
* <th align=left>Type</th>

6
jdk/src/share/classes/java/lang/management/MonitorInfo.java
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 2005, 2006, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -32,7 +32,7 @@ import sun.management.MonitorInfoCompositeData;
* Information about an object monitor lock. An object monitor is locked
* when entering a synchronization block or method on that object.
*
* <h4>MXBean Mapping</h4>
* <h3>MXBean Mapping</h3>
* <tt>MonitorInfo</tt> is mapped to a {@link CompositeData CompositeData}
* with attributes as specified in
* the {@link #from from} method.
@ -106,7 +106,7 @@ public class MonitorInfo extends LockInfo {
* <a href="LockInfo.html#MappedType">
* mapped type</a> for the {@link LockInfo} class:
* <blockquote>
* <table border>
* <table border summary="The attributes and their types the given CompositeData contains">
* <tr>
* <th align=left>Attribute Name</th>
* <th align=left>Type</th>

6
jdk/src/share/classes/java/lang/management/RuntimeMXBean.java
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 2003, 2008, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -272,7 +272,7 @@ public interface RuntimeMXBean extends PlatformManagedObject {
*
* <p>
* <b>MBeanServer access</b>:<br>
* The mapped type of <tt>List<String></tt> is <tt>String[]</tt>.
* The mapped type of {@code List<String>} is <tt>String[]</tt>.
*
* @return a list of <tt>String</tt> objects; each element
* is an argument passed to the Java virtual machine.
@ -312,7 +312,7 @@ public interface RuntimeMXBean extends PlatformManagedObject {
* {@link javax.management.openmbean.TabularData TabularData}
* with two items in each row as follows:
* <blockquote>
* <table border>
* <table border summary="Name and Type for each item">
* <tr>
* <th>Item Name</th>
* <th>Item Type</th>

10
jdk/src/share/classes/java/lang/management/ThreadInfo.java
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 2003, 2012, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -33,13 +33,13 @@ import static java.lang.Thread.State.*;
/**
* Thread information. <tt>ThreadInfo</tt> contains the information
* about a thread including:
* <h4>General thread information</h4>
* <h3>General thread information</h3>
* <ul>
* <li>Thread ID.</li>
* <li>Name of the thread.</li>
* </ul>
*
* <h4>Execution information</h4>
* <h3>Execution information</h3>
* <ul>
* <li>Thread state.</li>
* <li>The object upon which the thread is blocked due to:
@ -652,7 +652,7 @@ public class ThreadInfo {
* The given <tt>CompositeData</tt> must contain the following attributes
* unless otherwise specified below:
* <blockquote>
* <table border>
* <table border summary="The attributes and their types the given CompositeData contains">
* <tr>
* <th align=left>Attribute Name</th>
* <th align=left>Type</th>
@ -722,7 +722,7 @@ public class ThreadInfo {
* Each element is a <tt>CompositeData</tt> representing
* StackTraceElement containing the following attributes:
* <blockquote>
* <table cellspacing=1 cellpadding=0>
* <table cellspacing=1 cellpadding=0 summary="The attributes and their types the given CompositeData contains">
* <tr>
* <th align=left>Attribute Name</th>
* <th align=left>Type</th>

10
jdk/src/share/classes/java/lang/management/ThreadMXBean.java
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 2003, 2008, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -49,7 +49,7 @@ import java.util.Map;
* It can be obtained by calling the
* {@link PlatformManagedObject#getObjectName} method.
*
* <h4>Thread ID</h4>
* <h3>Thread ID</h3>
* Thread ID is a positive long value returned by calling the
* {@link java.lang.Thread#getId} method for a thread.
* The thread ID is unique during its lifetime. When a thread
@ -58,7 +58,7 @@ import java.util.Map;
* <p> Some methods in this interface take a thread ID or an array
* of thread IDs as the input parameter and return per-thread information.
*
* <h4>Thread CPU time</h4>
* <h3>Thread CPU time</h3>
* A Java virtual machine implementation may support measuring
* the CPU time for the current thread, for any thread, or for no threads.
*
@ -83,7 +83,7 @@ import java.util.Map;
* Enabling thread CPU measurement could be expensive in some
* Java virtual machine implementations.
*
* <h4>Thread Contention Monitoring</h4>
* <h3>Thread Contention Monitoring</h3>
* Some Java virtual machines may support thread contention monitoring.
* When thread contention monitoring is enabled, the accumulated elapsed
* time that the thread has blocked for synchronization or waited for
@ -96,7 +96,7 @@ import java.util.Map;
* {@link #setThreadContentionMonitoringEnabled} method can be used to enable
* thread contention monitoring.
*
* <h4>Synchronization Information and Deadlock Detection</h4>
* <h3>Synchronization Information and Deadlock Detection</h3>
* Some Java virtual machines may support monitoring of
* {@linkplain #isObjectMonitorUsageSupported object monitor usage} and
* {@linkplain #isSynchronizerUsageSupported ownable synchronizer usage}.