HADOOP-12087. [JDK8] Fix javadoc errors caused by incorrect or illegal tags. (Akira AJISAKA via stevel).

This commit is contained in:
Steve Loughran 2015-09-13 14:25:06 +01:00
parent 0c7d3f4805
commit 7269906254
10 changed files with 21 additions and 17 deletions

View File

@ -62,7 +62,8 @@ public AuthenticationToken(String userName, String principal, String type) {
/** /**
* Sets the max inactive time of the token. * Sets the max inactive time of the token.
* *
* @param max inactive time of the token in milliseconds since the epoch. * @param maxInactives inactive time of the token in milliseconds
* since the epoch.
*/ */
public void setMaxInactives(long maxInactives) { public void setMaxInactives(long maxInactives) {
if (this != AuthenticationToken.ANONYMOUS) { if (this != AuthenticationToken.ANONYMOUS) {

View File

@ -1060,6 +1060,9 @@ Release 2.8.0 - UNRELEASED
HADOOP-12348. MetricsSystemImpl creates MetricsSourceAdapter with wrong HADOOP-12348. MetricsSystemImpl creates MetricsSourceAdapter with wrong
time unit parameter. (zxu via rkanter) time unit parameter. (zxu via rkanter)
HADOOP-12087. [JDK8] Fix javadoc errors caused by incorrect or illegal
tags. (Akira AJISAKA via stevel).
OPTIMIZATIONS OPTIMIZATIONS
HADOOP-12051. ProtobufRpcEngine.invoke() should use Exception.toString() HADOOP-12051. ProtobufRpcEngine.invoke() should use Exception.toString()

View File

@ -32,9 +32,10 @@
/** /**
* ProducerConsumer class encapsulates input and output queues and a * ProducerConsumer class encapsulates input and output queues and a
* thread-pool of Workers that loop on WorkRequest<T> inputQueue and for each * thread-pool of Workers that loop on WorkRequest{@literal <T>} inputQueue
* consumed WorkRequest Workers invoke WorkRequestProcessor.processItem() * and for each consumed WorkRequest Workers invoke
* and output resulting WorkReport<R> to the outputQueue. * WorkRequestProcessor.processItem() and output resulting
* WorkReport{@literal <R>} to the outputQueue.
*/ */
public class ProducerConsumer<T, R> { public class ProducerConsumer<T, R> {
private Log LOG = LogFactory.getLog(ProducerConsumer.class); private Log LOG = LogFactory.getLog(ProducerConsumer.class);
@ -57,9 +58,9 @@ public ProducerConsumer(int numThreads) {
} }
/** /**
* Add another worker that will consume WorkRequest<T> items from input * Add another worker that will consume WorkRequest{@literal <T>} items
* queue, process each item using supplied processor, and for every * from input queue, process each item using supplied processor, and for
* processed item output WorkReport<R> to output queue. * every processed item output WorkReport{@literal <R>} to output queue.
* *
* @param processor Processor implementing WorkRequestProcessor interface. * @param processor Processor implementing WorkRequestProcessor interface.
* *
@ -102,7 +103,7 @@ public boolean hasWork() {
/** /**
* Blocking put workRequest to ProducerConsumer input queue. * Blocking put workRequest to ProducerConsumer input queue.
* *
* @param WorkRequest<T> item to be processed. * @param workRequest item to be processed.
*/ */
public void put(WorkRequest<T> workRequest) { public void put(WorkRequest<T> workRequest) {
boolean isDone = false; boolean isDone = false;
@ -120,7 +121,7 @@ public void put(WorkRequest<T> workRequest) {
/** /**
* Blocking take from ProducerConsumer output queue that can be interrupted. * Blocking take from ProducerConsumer output queue that can be interrupted.
* *
* @return WorkReport<R> item returned by processor's processItem(). * @return item returned by processor's processItem().
*/ */
public WorkReport<R> take() throws InterruptedException { public WorkReport<R> take() throws InterruptedException {
WorkReport<R> report = outputQueue.take(); WorkReport<R> report = outputQueue.take();
@ -132,7 +133,7 @@ public WorkReport<R> take() throws InterruptedException {
* Blocking take from ProducerConsumer output queue (catches exceptions and * Blocking take from ProducerConsumer output queue (catches exceptions and
* retries forever). * retries forever).
* *
* @return WorkReport<R> item returned by processor's processItem(). * @return item returned by processor's processItem().
*/ */
public WorkReport<R> blockingTake() { public WorkReport<R> blockingTake() {
while (true) { while (true) {

View File

@ -19,7 +19,7 @@
package org.apache.hadoop.tools.util; package org.apache.hadoop.tools.util;
/** /**
* WorkReport<T> is a simple container for items of class T and its * WorkReport{@literal <T>} is a simple container for items of class T and its
* corresponding retry counter that indicates how many times this item * corresponding retry counter that indicates how many times this item
* was previously attempted to be processed. * was previously attempted to be processed.
*/ */

View File

@ -19,7 +19,7 @@
package org.apache.hadoop.tools.util; package org.apache.hadoop.tools.util;
/** /**
* WorkRequest<T> is a simple container for items of class T and its * WorkRequest{@literal <T>} is a simple container for items of class T and its
* corresponding retry counter that indicates how many times this item * corresponding retry counter that indicates how many times this item
* was previously attempted to be processed. * was previously attempted to be processed.
*/ */

View File

@ -404,7 +404,7 @@ public abstract void setLogAggregationStatus(
public abstract boolean isUnmanagedApp(); public abstract boolean isUnmanagedApp();
/** /**
* @param value true if RM should not manage the AM * @param unmanagedApplication true if RM should not manage the AM
*/ */
@Public @Public
@Unstable @Unstable

View File

@ -27,7 +27,6 @@
* <li>{@link #APPLICATION_MASTER} * <li>{@link #APPLICATION_MASTER}
* <li>{@link #TASK} * <li>{@link #TASK}
* </ul> * </ul>
* </p>
*/ */
public enum ContainerType { public enum ContainerType {
APPLICATION_MASTER, TASK APPLICATION_MASTER, TASK

View File

@ -827,7 +827,7 @@ public Map<NodeLabel, Set<NodeId>> getLabelsInfoToNodes() {
/** /**
* Get mapping of labels info to nodes for specified set of labels. * Get mapping of labels info to nodes for specified set of labels.
* *
* @param nodelabels * @param labels
* set of nodelabels for which labels to nodes mapping will be * set of nodelabels for which labels to nodes mapping will be
* returned. * returned.
* @return labels to nodes map * @return labels to nodes map

View File

@ -46,7 +46,7 @@ public abstract class NodeStatus {
* @param containerStatuses Status of the containers running in this node. * @param containerStatuses Status of the containers running in this node.
* @param keepAliveApplications Applications to keep alive. * @param keepAliveApplications Applications to keep alive.
* @param nodeHealthStatus Health status of the node. * @param nodeHealthStatus Health status of the node.
* @param containersUtilizations Utilization of the containers in this node. * @param containersUtilization Utilization of the containers in this node.
* @param nodeUtilization Utilization of the node. * @param nodeUtilization Utilization of the node.
* @return New {@code NodeStatus} with the provided information. * @return New {@code NodeStatus} with the provided information.
*/ */

View File

@ -107,7 +107,7 @@ public void containerReleased(S schedulableEntity,
void demandUpdated(S schedulableEntity); void demandUpdated(S schedulableEntity);
/** /**
* Display information regarding configuration & status * Display information regarding configuration and status
*/ */
public String getInfo(); public String getInfo();