diff options
author | gjoranv <gv@oath.com> | 2018-11-20 14:46:37 +0100 |
---|---|---|
committer | gjoranv <gv@oath.com> | 2019-01-21 15:09:27 +0100 |
commit | 81182050f567673fc3180764b3645fb76ca85dc5 (patch) | |
tree | cae51ade6b09ccbe7d316efb7b3d5b93e8bd3f18 | |
parent | 0fb27af8c2d6b8e5ebb0255e21c220a89ce05eba (diff) |
Generate html5 javadoc
31 files changed, 103 insertions, 125 deletions
diff --git a/application/src/main/java/com/yahoo/application/container/handler/Headers.java b/application/src/main/java/com/yahoo/application/container/handler/Headers.java index 8086960df25..ed3018eb430 100644 --- a/application/src/main/java/com/yahoo/application/container/handler/Headers.java +++ b/application/src/main/java/com/yahoo/application/container/handler/Headers.java @@ -155,7 +155,7 @@ public class Headers implements Map<String, List<String>> { /** * <p>Adds all the entries of the given map to this. This is the same as calling {@link #add(String, List)} for each - * entry in <tt>values</tt>.</p> + * entry in <code>values</code>.</p> * * @param values The values to be added to this. */ @@ -169,8 +169,8 @@ public class Headers implements Map<String, List<String>> { * * @param key The key of the entry to put. * @param value The value to put. - * @return The previous value associated with <tt>key</tt>, or <tt>null</tt> if there was no mapping for - * <tt>key</tt>. + * @return The previous value associated with <code>key</code>, or <code>null</code> if there was no mapping for + * <code>key</code>. */ public List<String> put(String key, String value) { return h.put(key, value); diff --git a/config-model/src/main/java/com/yahoo/searchdefinition/processing/IndexingOutputs.java b/config-model/src/main/java/com/yahoo/searchdefinition/processing/IndexingOutputs.java index 4feb5b6103b..8c60de1241e 100644 --- a/config-model/src/main/java/com/yahoo/searchdefinition/processing/IndexingOutputs.java +++ b/config-model/src/main/java/com/yahoo/searchdefinition/processing/IndexingOutputs.java @@ -17,7 +17,7 @@ import java.util.*; /** * This processor modifies all indexing scripts so that they output to the owning field by default. It also prevents - * any output expression from writing to any field except for the owning field. Finally, for <tt>SummaryExpression</tt>, + * any output expression from writing to any field except for the owning field. Finally, for <code>SummaryExpression</code>, * this processor expands to write all appropriate summary fields. * * @author Simon Thoresen Hult diff --git a/config-model/src/main/java/com/yahoo/vespa/model/package-info.java b/config-model/src/main/java/com/yahoo/vespa/model/package-info.java index e5f76dd398e..f88eda4e7a2 100644 --- a/config-model/src/main/java/com/yahoo/vespa/model/package-info.java +++ b/config-model/src/main/java/com/yahoo/vespa/model/package-info.java @@ -99,7 +99,7 @@ com.yahoo.config.model.producer.AbstractConfigProducer </p> - <h3><a name="plugin_loading">Plugin Loading</a></h3> + <h3 id="plugin_loading">Plugin Loading</h3> <p>Each highest-level node in the setup file from the user's application specification corresponds to a {@link @@ -138,7 +138,7 @@ com.yahoo.config.model.producer.AbstractConfigProducer </ul> - <h3><a name="port_allocation">Port Allocation</a></h3> + <h3 id="port_allocation">Port Allocation</h3> <p>Each {@link com.yahoo.vespa.model.Host Host} has an available dynamic port range running from {@link diff --git a/container-core/src/main/java/com/yahoo/container/jdisc/MetricConsumerFactory.java b/container-core/src/main/java/com/yahoo/container/jdisc/MetricConsumerFactory.java index 50052bbf70c..d0cf07584e4 100644 --- a/container-core/src/main/java/com/yahoo/container/jdisc/MetricConsumerFactory.java +++ b/container-core/src/main/java/com/yahoo/container/jdisc/MetricConsumerFactory.java @@ -4,7 +4,7 @@ package com.yahoo.container.jdisc; import com.yahoo.jdisc.application.MetricConsumer; /** - * <p>This is the interface to implement if one wishes to configure a non-default <tt>MetricConsumer</tt>. Simply + * <p>This is the interface to implement if one wishes to configure a non-default <code>MetricConsumer</code>. Simply * add the implementing class as a component in your services.xml file.</p> * * @author Simon Thoresen Hult diff --git a/container-disc/src/main/java/com/yahoo/container/jdisc/metric/ForwardingMetricConsumer.java b/container-disc/src/main/java/com/yahoo/container/jdisc/metric/ForwardingMetricConsumer.java index 7bdd2d9cc7b..c9caaa9d4b5 100644 --- a/container-disc/src/main/java/com/yahoo/container/jdisc/metric/ForwardingMetricConsumer.java +++ b/container-disc/src/main/java/com/yahoo/container/jdisc/metric/ForwardingMetricConsumer.java @@ -8,8 +8,8 @@ import com.yahoo.jdisc.application.MetricConsumer; import java.util.Map; /** - * <p>If more than one {@link MetricConsumerFactory} is registered in a container, calls to <tt>Metric</tt> need to be - * forwarded to all the underlying <tt>MetricConsumers</tt>. That is the responsibility of this class. Instances of this + * <p>If more than one {@link MetricConsumerFactory} is registered in a container, calls to <code>Metric</code> need to be + * forwarded to all the underlying <code>MetricConsumers</code>. That is the responsibility of this class. Instances of this * class is created by the {@link MetricConsumerProvider} in those cases.</p> * * @author Simon Thoresen Hult diff --git a/container-disc/src/main/java/com/yahoo/container/jdisc/metric/MetricConsumerProvider.java b/container-disc/src/main/java/com/yahoo/container/jdisc/metric/MetricConsumerProvider.java index 1e7a4e75385..a300364d848 100644 --- a/container-disc/src/main/java/com/yahoo/container/jdisc/metric/MetricConsumerProvider.java +++ b/container-disc/src/main/java/com/yahoo/container/jdisc/metric/MetricConsumerProvider.java @@ -11,14 +11,14 @@ import com.yahoo.metrics.MetricsPresentationConfig; /** - * <p>The purpose of this class it to be the only provider for the <tt>MetricConsumer</tt> interface in a component + * <p>The purpose of this class it to be the only provider for the <code>MetricConsumer</code> interface in a component * graph. This component is automatically registered in the graph by the config server. Configuring a different - * <tt>MetricConsumer</tt> is done by registering one or more {@link MetricConsumerFactory} in the services-file.</p> + * <code>MetricConsumer</code> is done by registering one or more {@link MetricConsumerFactory} in the services-file.</p> * * <p>Because this class depends on the {@link ComponentRegistry} of {@link MetricConsumerFactory}, any added or removed * {@link MetricConsumerFactory} will cause this component to be reconfigured. Because {@link MetricProvider} depends on - * this class, which means any component that uses <tt>Metric</tt> will be reconfigured. Any component that depends - * directly on <tt>MetricConsumer</tt> will also be reconfigured.</p> + * this class, which means any component that uses <code>Metric</code> will be reconfigured. Any component that depends + * directly on <code>MetricConsumer</code> will also be reconfigured.</p> * * @author Simon Thoresen Hult */ diff --git a/container-disc/src/main/java/com/yahoo/container/jdisc/metric/MetricProvider.java b/container-disc/src/main/java/com/yahoo/container/jdisc/metric/MetricProvider.java index bcd75c0b36b..57613113e73 100644 --- a/container-disc/src/main/java/com/yahoo/container/jdisc/metric/MetricProvider.java +++ b/container-disc/src/main/java/com/yahoo/container/jdisc/metric/MetricProvider.java @@ -6,9 +6,9 @@ import com.yahoo.jdisc.Metric; import com.yahoo.jdisc.application.MetricConsumer; /** - * <p>This class implements a {@link Provider} component of <tt>Metric</tt>. Because this class depends on {@link + * <p>This class implements a {@link Provider} component of <code>Metric</code>. Because this class depends on {@link * MetricConsumerProvider}, any change to the consumer configuration will trigger reconfiguration of this component, - * which in turn triggers reconfiguration of any component that depends on <tt>Metric</tt>.</p> + * which in turn triggers reconfiguration of any component that depends on <code>Metric</code>.</p> * * @author Simon Thoresen Hult */ diff --git a/container-search/src/main/java/com/yahoo/search/grouping/result/BucketGroupId.java b/container-search/src/main/java/com/yahoo/search/grouping/result/BucketGroupId.java index 07729b4524a..e1f74df7172 100644 --- a/container-search/src/main/java/com/yahoo/search/grouping/result/BucketGroupId.java +++ b/container-search/src/main/java/com/yahoo/search/grouping/result/BucketGroupId.java @@ -30,9 +30,9 @@ public abstract class BucketGroupId<T> extends GroupId { * * @param type The type of this id's value. * @param from The inclusive-from of the range. - * @param fromImage The String representation of the <tt>from</tt> argument. + * @param fromImage The String representation of the <code>from</code> argument. * @param to The exclusive-to of the range. - * @param toImage The String representation of the <tt>to</tt> argument. + * @param toImage The String representation of the <code>to</code> argument. */ public BucketGroupId(String type, T from, String fromImage, T to, String toImage) { super(type, fromImage, toImage); diff --git a/container-search/src/main/java/com/yahoo/search/grouping/result/ValueGroupId.java b/container-search/src/main/java/com/yahoo/search/grouping/result/ValueGroupId.java index bebd3fd85b0..a76af885180 100644 --- a/container-search/src/main/java/com/yahoo/search/grouping/result/ValueGroupId.java +++ b/container-search/src/main/java/com/yahoo/search/grouping/result/ValueGroupId.java @@ -27,7 +27,7 @@ public abstract class ValueGroupId<T> extends GroupId { * * @param type The type of this id's value. * @param value The identifying value. - * @param valueImage The String representation of the <tt>value</tt> argument. + * @param valueImage The String representation of the <code>value</code> argument. */ public ValueGroupId(String type, T value, String valueImage) { super(type, valueImage); diff --git a/container-search/src/main/java/com/yahoo/search/query/parser/ParserFactory.java b/container-search/src/main/java/com/yahoo/search/query/parser/ParserFactory.java index 69d46527255..a57c0f98b45 100644 --- a/container-search/src/main/java/com/yahoo/search/query/parser/ParserFactory.java +++ b/container-search/src/main/java/com/yahoo/search/query/parser/ParserFactory.java @@ -18,7 +18,7 @@ public final class ParserFactory { } /** - * Creates a {@link Parser} appropriate for the given <tt>Query.Type</tt>, providing the Parser with access to + * Creates a {@link Parser} appropriate for the given <code>Query.Type</code>, providing the Parser with access to * the {@link ParserEnvironment} given. * * @param type the query type for which to create a Parser diff --git a/jdisc_core/src/main/java/com/yahoo/jdisc/HeaderFields.java b/jdisc_core/src/main/java/com/yahoo/jdisc/HeaderFields.java index 500b1258735..5c35bed2cec 100644 --- a/jdisc_core/src/main/java/com/yahoo/jdisc/HeaderFields.java +++ b/jdisc_core/src/main/java/com/yahoo/jdisc/HeaderFields.java @@ -8,7 +8,7 @@ import java.util.*; /** * This is an encapsulation of the header fields that belong to either a {@link Request} or a {@link Response}. It is * a multimap from String to String, with some additional methods for convenience. The keys of this map are compared by - * ignoring their case, so that <tt>get("foo")</tt> returns the same entry as <tt>get("FOO")</tt>. + * ignoring their case, so that <code>get("foo")</code> returns the same entry as <code>get("FOO")</code>. * * @author Simon Thoresen Hult */ @@ -121,7 +121,7 @@ public class HeaderFields implements Map<String, List<String>> { /** * <p>Adds all the entries of the given map to this. This is the same as calling {@link #add(String, List)} for each - * entry in <tt>values</tt>.</p> + * entry in <code>values</code>.</p> * * @param values The values to be added to this. */ @@ -137,8 +137,8 @@ public class HeaderFields implements Map<String, List<String>> { * * @param key The key of the entry to put. * @param value The value to put. - * @return The previous value associated with <tt>key</tt>, or <tt>null</tt> if there was no mapping for - * <tt>key</tt>. + * @return The previous value associated with <code>key</code>, or <code>null</code> if there was no mapping for + * <code>key</code>. */ public List<String> put(String key, String value) { ArrayList<String> list = new ArrayList<String>(1); diff --git a/jdisc_core/src/main/java/com/yahoo/jdisc/application/BindingMatch.java b/jdisc_core/src/main/java/com/yahoo/jdisc/application/BindingMatch.java index 9f347706dd8..98b0ef870e1 100644 --- a/jdisc_core/src/main/java/com/yahoo/jdisc/application/BindingMatch.java +++ b/jdisc_core/src/main/java/com/yahoo/jdisc/application/BindingMatch.java @@ -49,7 +49,7 @@ public class BindingMatch<T> { * empty string. This method never returns null.</p> * * @param idx The index of the group to return. - * @return The (possibly empty) substring captured by the group during matching, never <tt>null</tt>. + * @return The (possibly empty) substring captured by the group during matching, never <code>null</code>. * @throws IndexOutOfBoundsException If there is no group in the match with the given index. */ public String group(int idx) { diff --git a/jdisc_core/src/main/java/com/yahoo/jdisc/application/MetricConsumer.java b/jdisc_core/src/main/java/com/yahoo/jdisc/application/MetricConsumer.java index d9bf67b530f..f060f1840ff 100644 --- a/jdisc_core/src/main/java/com/yahoo/jdisc/application/MetricConsumer.java +++ b/jdisc_core/src/main/java/com/yahoo/jdisc/application/MetricConsumer.java @@ -39,7 +39,7 @@ import java.util.Map; public interface MetricConsumer { /** - * <p>Consume a call to <tt>Metric.set(String, Number, Metric.Context)</tt>.</p> + * <p>Consume a call to <code>Metric.set(String, Number, Metric.Context)</code>.</p> * * @param key The name of the metric to modify. * @param val The value to assign to the named metric. @@ -48,7 +48,7 @@ public interface MetricConsumer { public void set(String key, Number val, Metric.Context ctx); /** - * <p>Consume a call to <tt>Metric.add(String, Number, Metric.Context)</tt>.</p> + * <p>Consume a call to <code>Metric.add(String, Number, Metric.Context)</code>.</p> * * @param key The name of the metric to modify. * @param val The value to add to the named metric. @@ -57,9 +57,9 @@ public interface MetricConsumer { public void add(String key, Number val, Metric.Context ctx); /** - * <p>Creates a <tt>Metric.Context</tt> object that encapsulates the given properties. The returned Context object - * will be passed along every future call to <tt>set(String, Number, Metric.Context)</tt> and - * <tt>add(String, Number, Metric.Context)</tt> where the properties match those given here.</p> + * <p>Creates a <code>Metric.Context</code> object that encapsulates the given properties. The returned Context object + * will be passed along every future call to <code>set(String, Number, Metric.Context)</code> and + * <code>add(String, Number, Metric.Context)</code> where the properties match those given here.</p> * * @param properties The properties to incorporate in the context. * @return The created context. diff --git a/jdisc_core/src/main/java/com/yahoo/jdisc/application/OsgiFramework.java b/jdisc_core/src/main/java/com/yahoo/jdisc/application/OsgiFramework.java index 85d745d7aaf..5abc95cc610 100644 --- a/jdisc_core/src/main/java/com/yahoo/jdisc/application/OsgiFramework.java +++ b/jdisc_core/src/main/java/com/yahoo/jdisc/application/OsgiFramework.java @@ -18,9 +18,9 @@ public interface OsgiFramework { /** * <p>Installs a bundle from the specified location. The specified location identifier will be used as the identity - * of the bundle. If a bundle containing the same location identifier is already installed, the <tt>Bundle</tt> + * of the bundle. If a bundle containing the same location identifier is already installed, the <code>Bundle</code> * object for that bundle is returned. All bundles listed in the {@link OsgiHeader#PREINSTALL_BUNDLE} manifest - * header are also installed. The bundle at index 0 of the returned list matches the <tt>bundleLocation</tt> + * header are also installed. The bundle at index 0 of the returned list matches the <code>bundleLocation</code> * argument.</p> * * <p><b>NOTE:</b> When this method installs more than one bundle, <em>AND</em> one of those bundles throw an @@ -29,8 +29,8 @@ public interface OsgiFramework { * BundleInstallationException} that contains the list of successfully installed bundles.</p> * * <p>It would be preferable if this method was exception-safe (that it would roll-back all installed bundles in the - * case of an exception), but that can not be implemented thread-safely since an <tt>Application</tt> may choose to - * install bundles concurrently through any available <tt>BundleContext</tt>.</p> + * case of an exception), but that can not be implemented thread-safely since an <code>Application</code> may choose to + * install bundles concurrently through any available <code>BundleContext</code>.</p> * * @param bundleLocation The location identifier of the bundle to install. * @return The list of Bundle objects installed, the object at index 0 matches the given location. @@ -41,7 +41,7 @@ public interface OsgiFramework { List<Bundle> installBundle(String bundleLocation) throws BundleException; /** - * <p>Starts the given {@link Bundle}s. The parameter <tt>privileged</tt> tells the framework whether or not + * <p>Starts the given {@link Bundle}s. The parameter <code>privileged</code> tells the framework whether or not * privileges are available, and is checked against the {@link OsgiHeader#PRIVILEGED_ACTIVATOR} header of each * Bundle being started. Any bundle that is a fragment is silently ignored.</p> * @@ -63,10 +63,10 @@ public interface OsgiFramework { /** * <p>Returns the BundleContext of this framework's system bundle. The returned BundleContext can be used by the - * caller to act on behalf of this bundle. This method may return <tt>null</tt> if it has no valid + * caller to act on behalf of this bundle. This method may return <code>null</code> if it has no valid * BundleContext.</p> * - * @return A <tt>BundleContext</tt> for the system bundle, or <tt>null</tt>. + * @return A <code>BundleContext</code> for the system bundle, or <code>null</code>. * @throws SecurityException If the caller does not have the appropriate permissions. */ BundleContext bundleContext(); diff --git a/jdisc_core/src/main/java/com/yahoo/jdisc/application/ResourcePool.java b/jdisc_core/src/main/java/com/yahoo/jdisc/application/ResourcePool.java index 279d99f63b7..ccbd1693b21 100644 --- a/jdisc_core/src/main/java/com/yahoo/jdisc/application/ResourcePool.java +++ b/jdisc_core/src/main/java/com/yahoo/jdisc/application/ResourcePool.java @@ -87,8 +87,8 @@ public final class ResourcePool extends AbstractResource implements AutoCloseabl * destroyed, it will release the main reference to the resource (by calling {@link SharedResource#release()}).</p> * * @param t The SharedResource to add. - * @param <T> The class of parameter <tt>t</tt>. - * @return The parameter <tt>t</tt>, to allow inlined calls to this function. + * @param <T> The class of parameter <code>t</code>. + * @return The parameter <code>t</code>, to allow inlined calls to this function. */ public <T extends SharedResource> T add(T t) { try { @@ -147,8 +147,8 @@ public final class ResourcePool extends AbstractResource implements AutoCloseabl * {@link SharedResource#refer()} call.</p> * * @param t The SharedResource to retain and add. - * @param <T> The class of parameter <tt>t</tt>. - * @return The parameter <tt>t</tt>, to allow inlined calls to this function. + * @param <T> The class of parameter <code>t</code>. + * @return The parameter <code>t</code>, to allow inlined calls to this function. */ public <T extends SharedResource> T retain(T t) { resources.add(t.refer()); diff --git a/jdisc_core/src/main/java/com/yahoo/jdisc/application/UriPattern.java b/jdisc_core/src/main/java/com/yahoo/jdisc/application/UriPattern.java index 89cb6412181..0e6e5d28260 100644 --- a/jdisc_core/src/main/java/com/yahoo/jdisc/application/UriPattern.java +++ b/jdisc_core/src/main/java/com/yahoo/jdisc/application/UriPattern.java @@ -40,7 +40,7 @@ public class UriPattern implements Comparable<UriPattern> { private final int priority; /** - * <p>Creates a new instance of this class that represents the given pattern string, with a priority of <tt>0</tt>. + * <p>Creates a new instance of this class that represents the given pattern string, with a priority of <code>0</code>. * The input string must be on the form <code><scheme>://<host>[:<port>]<path></code>, where * '*' can be used as a wildcard character at any position.</p> * @@ -207,7 +207,7 @@ public class UriPattern implements Comparable<UriPattern> { * the empty string. This method never returns null.</p> * * @param idx The index of the group to return. - * @return The (possibly empty) substring captured by the group during matching, never <tt>null</tt>. + * @return The (possibly empty) substring captured by the group during matching, never <code>null</code>. * @throws IndexOutOfBoundsException If there is no group in the match with the given index. */ public String group(int idx) { diff --git a/jdisc_core/src/main/java/com/yahoo/jdisc/handler/CallableRequestDispatch.java b/jdisc_core/src/main/java/com/yahoo/jdisc/handler/CallableRequestDispatch.java index cfbd4edcf8f..135a56f2d6b 100644 --- a/jdisc_core/src/main/java/com/yahoo/jdisc/handler/CallableRequestDispatch.java +++ b/jdisc_core/src/main/java/com/yahoo/jdisc/handler/CallableRequestDispatch.java @@ -8,8 +8,8 @@ import java.util.concurrent.Callable; /** * This is a convenient subclass of {@link RequestDispatch} that implements the {@link Callable} interface. This * should be used in place of {@link RequestDispatch} if you intend to schedule its execution. Because {@link #call()} - * does not return until a {@link Response} becomes available, you can use the <tt>Future</tt> return value of - * <tt>ExecutorService.submit(Callable)</tt> to wait for it. + * does not return until a {@link Response} becomes available, you can use the <code>Future</code> return value of + * <code>ExecutorService.submit(Callable)</code> to wait for it. * * @author Simon Thoresen Hult */ diff --git a/jdisc_core/src/main/java/com/yahoo/jdisc/handler/CallableResponseDispatch.java b/jdisc_core/src/main/java/com/yahoo/jdisc/handler/CallableResponseDispatch.java index 0471e05a5f9..e92edf15bba 100644 --- a/jdisc_core/src/main/java/com/yahoo/jdisc/handler/CallableResponseDispatch.java +++ b/jdisc_core/src/main/java/com/yahoo/jdisc/handler/CallableResponseDispatch.java @@ -9,7 +9,7 @@ import java.util.concurrent.Callable; * This is a convenient subclass of {@link ResponseDispatch} that implements the {@link Callable} interface. This * should be used in place of {@link ResponseDispatch} if you intend to schedule its execution. Because {@link #call()} * does not return until the entirety of the {@link Response} and its content have been consumed, you can use the - * <tt>Future</tt> return value of <tt>ExecutorService.submit(Callable)</tt> to wait for it to complete. + * <code>Future</code> return value of <code>ExecutorService.submit(Callable)</code> to wait for it to complete. * * @author Simon Thoresen Hult */ diff --git a/jdisc_core/src/main/java/com/yahoo/jdisc/handler/FutureConjunction.java b/jdisc_core/src/main/java/com/yahoo/jdisc/handler/FutureConjunction.java index 4380ad0cbd2..c48798ca2ab 100644 --- a/jdisc_core/src/main/java/com/yahoo/jdisc/handler/FutureConjunction.java +++ b/jdisc_core/src/main/java/com/yahoo/jdisc/handler/FutureConjunction.java @@ -11,7 +11,7 @@ import java.util.concurrent.*; /** * <p>This class implements a Future<Boolean> that is conjunction of zero or more other Future<Boolean>s, - * i.e. it evaluates to <tt>true</tt> if, and only if, all its operands evaluate to <tt>true</tt>. To use this class, + * i.e. it evaluates to <code>true</code> if, and only if, all its operands evaluate to <code>true</code>. To use this class, * simply create an instance of it and add operands to it using the {@link #addOperand(ListenableFuture)} method.</p> * TODO: consider rewriting usage of FutureConjunction to use CompletableFuture instead. * diff --git a/jdisc_core/src/main/java/com/yahoo/jdisc/handler/RequestDispatch.java b/jdisc_core/src/main/java/com/yahoo/jdisc/handler/RequestDispatch.java index 211c5474fe6..3dc0961cdcb 100644 --- a/jdisc_core/src/main/java/com/yahoo/jdisc/handler/RequestDispatch.java +++ b/jdisc_core/src/main/java/com/yahoo/jdisc/handler/RequestDispatch.java @@ -73,7 +73,7 @@ public abstract class RequestDispatch implements ListenableFuture<Response>, Res /** * <p>This methods calls {@link #newRequest()} to create a new {@link Request}, and then calls {@link - * Request#connect(ResponseHandler)} on that. This method uses a <tt>finally</tt> block to make sure that the + * Request#connect(ResponseHandler)} on that. This method uses a <code>finally</code> block to make sure that the * Request is always {@link Request#release() released}.</p> * * @return The ContentChannel to write the Request's content to. @@ -98,7 +98,7 @@ public abstract class RequestDispatch implements ListenableFuture<Response>, Res /** * <p>This method calls {@link #connect()} to establish a {@link ContentChannel} for the {@link Request}, and then * iterates through all the ByteBuffers returned by {@link #requestContent()} and writes them to that - * ContentChannel. This method uses a <tt>finally</tt> block to make sure that the ContentChannel is always {@link + * ContentChannel. This method uses a <code>finally</code> block to make sure that the ContentChannel is always {@link * ContentChannel#close(CompletionHandler) closed}.</p> * * <p>The returned Future will wait for all CompletionHandlers associated with the Request have been completed, and diff --git a/jdisc_core/src/main/java/com/yahoo/jdisc/handler/ResponseDispatch.java b/jdisc_core/src/main/java/com/yahoo/jdisc/handler/ResponseDispatch.java index e5e6b752716..22a77968dfd 100644 --- a/jdisc_core/src/main/java/com/yahoo/jdisc/handler/ResponseDispatch.java +++ b/jdisc_core/src/main/java/com/yahoo/jdisc/handler/ResponseDispatch.java @@ -82,7 +82,7 @@ public abstract class ResponseDispatch extends ForwardingListenableFuture<Boolea /** * <p>This method calls {@link #connect(ResponseHandler)} to establish a {@link ContentChannel} for the {@link * Response}, and then iterates through all the ByteBuffers returned by {@link #responseContent()} and writes them - * to that ContentChannel. This method uses a <tt>finally</tt> block to make sure that the ContentChannel is always + * to that ContentChannel. This method uses a <code>finally</code> block to make sure that the ContentChannel is always * {@link ContentChannel#close(CompletionHandler) closed}.</p> * <p>The returned Future will wait for all CompletionHandlers associated with the Response have been * completed.</p> diff --git a/jdisc_core/src/main/java/com/yahoo/jdisc/handler/ThreadedRequestHandler.java b/jdisc_core/src/main/java/com/yahoo/jdisc/handler/ThreadedRequestHandler.java index a2bea1566de..6e2895f118b 100644 --- a/jdisc_core/src/main/java/com/yahoo/jdisc/handler/ThreadedRequestHandler.java +++ b/jdisc_core/src/main/java/com/yahoo/jdisc/handler/ThreadedRequestHandler.java @@ -126,7 +126,7 @@ public abstract class ThreadedRequestHandler extends AbstractRequestHandler { /** * <p>Implement this method if you want to access the {@link Request}'s content using a {@link ContentInputStream}. * If you do not override this method, it will dispatch a {@link Response} to the {@link ResponseHandler} with a - * <tt>Response.Status.NOT_IMPLEMENTED</tt> status.</p> + * <code>Response.Status.NOT_IMPLEMENTED</code> status.</p> * * @param request The Request to handle. * @param responseHandler The handler to pass the corresponding {@link Response} to. diff --git a/jdisc_core/src/main/java/com/yahoo/jdisc/test/ServerProviderConformanceTest.java b/jdisc_core/src/main/java/com/yahoo/jdisc/test/ServerProviderConformanceTest.java index e7039e85e5e..7e913456074 100644 --- a/jdisc_core/src/main/java/com/yahoo/jdisc/test/ServerProviderConformanceTest.java +++ b/jdisc_core/src/main/java/com/yahoo/jdisc/test/ServerProviderConformanceTest.java @@ -49,7 +49,7 @@ public abstract class ServerProviderConformanceTest { private static final int NUM_RUNS_EACH_TEST = 10; /** - * <p>This interface declares the adapter between the general conformance test and an actual <tt>ServerProvider</tt> + * <p>This interface declares the adapter between the general conformance test and an actual <code>ServerProvider</code> * implementation. Every test runs as follows:</p> * <ol> * <li>{@link #newConfigModule()} is called to bind server-specific configuration.</li> @@ -59,7 +59,7 @@ public abstract class ServerProviderConformanceTest { * <li>{@link #validateResponse(Object)} is called once per call to {@link #executeRequest(Object, boolean)}.</li> * </ol> * - * @param <T> The <tt>ServerProvider</tt> under test. + * @param <T> The <code>ServerProvider</code> under test. * @param <U> An object that represents a remote client that can connect to the server. * @param <V> An object that holds the response generated by the client when executing a request. */ @@ -80,7 +80,7 @@ public abstract class ServerProviderConformanceTest { /** * <p>An instance of this exception is thrown within the conformance tests that imply that they will throw an - * exception. If your <tt>ServerProvider</tt> is capable of exposing such information, then this class is what you + * exception. If your <code>ServerProvider</code> is capable of exposing such information, then this class is what you * need to look for in the output.</p> */ public static class ConformanceException extends RuntimeException { diff --git a/linguistics/src/main/java/com/yahoo/language/Language.java b/linguistics/src/main/java/com/yahoo/language/Language.java index ab8bcd4459f..655a9003fb1 100644 --- a/linguistics/src/main/java/com/yahoo/language/Language.java +++ b/linguistics/src/main/java/com/yahoo/language/Language.java @@ -529,10 +529,10 @@ public enum Language { } /** - * <p>Convenience method for calling <tt>fromLocale(LocaleFactory.fromLanguageTag(languageTag))</tt>.</p> + * <p>Convenience method for calling <code>fromLocale(LocaleFactory.fromLanguageTag(languageTag))</code>.</p> * - * @param languageTag The language tag for which the <tt>Language</tt> to return. - * @return the corresponding <tt>Language</tt>, or {@link #UNKNOWN} if not known. + * @param languageTag The language tag for which the <code>Language</code> to return. + * @return the corresponding <code>Language</code>, or {@link #UNKNOWN} if not known. */ public static Language fromLanguageTag(String languageTag) { if (languageTag == null) return UNKNOWN; @@ -540,7 +540,7 @@ public enum Language { } /** - * <p>Returns the <tt>Language</tt> whose {@link #languageCode()} is equal to <tt>locale.getLanguage()</tt>, with + * <p>Returns the <code>Language</code> whose {@link #languageCode()} is equal to <code>locale.getLanguage()</code>, with * the following additions:</p> * <ul> * <li>Language code "in" translates to {@link #INDONESIAN}</li> @@ -551,8 +551,8 @@ public enum Language { * is "hans", in which case it translates to {@link #CHINESE_SIMPLIFIED}.</li> * </ul> * - * @param locale The locale for which the <tt>Language</tt> to return. - * @return The corresponding <tt>Language</tt>, or {@link #UNKNOWN} if not known. + * @param locale The locale for which the <code>Language</code> to return. + * @return The corresponding <code>Language</code>, or {@link #UNKNOWN} if not known. */ public static Language fromLocale(Locale locale) { String str = locale.getLanguage(); @@ -582,7 +582,7 @@ public enum Language { /** * Returns the language from an encoding, or {@link #UNKNOWN} if it cannot be determined. * - * @param encoding The name of the encoding to derive the <tt>Language</tt> from. + * @param encoding The name of the encoding to derive the <code>Language</code> from. * @return the language given by the encoding, or {@link #UNKNOWN} if not determined. */ public static Language fromEncoding(String encoding) { diff --git a/messagebus/src/main/java/com/yahoo/messagebus/Routable.java b/messagebus/src/main/java/com/yahoo/messagebus/Routable.java index e761a874ac1..792ec4d27cd 100755 --- a/messagebus/src/main/java/com/yahoo/messagebus/Routable.java +++ b/messagebus/src/main/java/com/yahoo/messagebus/Routable.java @@ -60,7 +60,7 @@ public abstract class Routable { /** * <p>This is a convenience method for calling {@link CallStack#pop(Routable)} on the {@link CallStack} of this - * Routable. It equals calling <tt>routable.getCallStack().pop(routable)</tt>.</p> + * Routable. It equals calling <code>routable.getCallStack().pop(routable)</code>.</p> * * @return The handler that was popped. * @see CallStack#pop(Routable) diff --git a/messagebus/src/main/java/com/yahoo/messagebus/routing/RoutingNode.java b/messagebus/src/main/java/com/yahoo/messagebus/routing/RoutingNode.java index 3049639586d..d2d8031a689 100755 --- a/messagebus/src/main/java/com/yahoo/messagebus/routing/RoutingNode.java +++ b/messagebus/src/main/java/com/yahoo/messagebus/routing/RoutingNode.java @@ -258,7 +258,7 @@ public class RoutingNode implements ReplyHandler { } /** - * If a reply has been set containing an error, and {@link #shouldIgnoreResult()} returns <tt>true</tt>, this method + * If a reply has been set containing an error, and {@link #shouldIgnoreResult()} returns <code>true</code>, this method * replaces that reply with one that has no error. * * @return Whether or not the reply was replaced. diff --git a/parent/pom.xml b/parent/pom.xml index 398d136c155..2e22c36cee3 100644 --- a/parent/pom.xml +++ b/parent/pom.xml @@ -280,28 +280,6 @@ </build> <profiles> <profile> - <!-- TODO: move config into pluginManagement when we don't have to support older jdks --> - <id>jdk10</id> - <activation> - <jdk>[10, )</jdk> - </activation> - <build> - <pluginManagement> - <plugins> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-javadoc-plugin</artifactId> - <configuration> - <quiet>true</quiet> - <!-- Avoid javadoc warning ".. not specified the version of HTML .." --> - <additionalJOption>-html4</additionalJOption> - </configuration> - </plugin> - </plugins> - </pluginManagement> - </build> - </profile> - <profile> <id>attach-sources</id> <activation> <property> diff --git a/searchlib/src/main/java/com/yahoo/searchlib/aggregation/Grouping.java b/searchlib/src/main/java/com/yahoo/searchlib/aggregation/Grouping.java index a9e2bc73d6a..c13bde4b633 100644 --- a/searchlib/src/main/java/com/yahoo/searchlib/aggregation/Grouping.java +++ b/searchlib/src/main/java/com/yahoo/searchlib/aggregation/Grouping.java @@ -209,7 +209,7 @@ public class Grouping extends Identifiable { * * @param level The level to add. * @return This, to allow chaining. - * @throws NullPointerException If <tt>level</tt> argument is null. + * @throws NullPointerException If <code>level</code> argument is null. */ public Grouping addLevel(GroupingLevel level) { level.getClass(); // throws NullPointerException @@ -231,7 +231,7 @@ public class Grouping extends Identifiable { * * @param root The group to set as root. * @return This, to allow chaining. - * @throws NullPointerException If <tt>root</tt> argument is null. + * @throws NullPointerException If <code>root</code> argument is null. */ public Grouping setRoot(Group root) { root.getClass(); // throws NullPointerException @@ -249,7 +249,7 @@ public class Grouping extends Identifiable { } /** - * <p>Sets whether or not grouping should be forced to execute in a single pass. If false, this <tt>Grouping</tt> + * <p>Sets whether or not grouping should be forced to execute in a single pass. If false, this <code>Grouping</code> * might still execute in a single pass due to other constraints.</p> * * @param forceSinglePass True to force execution in single pass. diff --git a/yolean/src/main/java/com/yahoo/yolean/concurrent/ThreadRobustList.java b/yolean/src/main/java/com/yahoo/yolean/concurrent/ThreadRobustList.java index 3f57319cdce..72020bbaf88 100644 --- a/yolean/src/main/java/com/yahoo/yolean/concurrent/ThreadRobustList.java +++ b/yolean/src/main/java/com/yahoo/yolean/concurrent/ThreadRobustList.java @@ -8,15 +8,15 @@ import java.util.NoSuchElementException; /** * <p>This class implements a thread-safe, lock-free list of Objects that supports multiple readers and a single writer. * Because there are no locks or other memory barriers involved, there exists no <i>happens-before</i> relationship - * among calls to either methods of the <tt>ThreadRobustList</tt>. This means that there are no guarantees as to when + * among calls to either methods of the <code>ThreadRobustList</code>. This means that there are no guarantees as to when * (or even if) an item {@link #add(Object)}ed becomes visible through {@link #iterator()}. If visibility is required, * either use explicit synchronization between reader and writer thread, or move to a different concurrent collection - * (e.g. <tt>CopyOnWriteArrayList</tt>).</p> - * <p>Because it is lock-free, the <tt>ThreadRobustList</tt> has minimal overhead to both reading and writing. The + * (e.g. <code>CopyOnWriteArrayList</code>).</p> + * <p>Because it is lock-free, the <code>ThreadRobustList</code> has minimal overhead to both reading and writing. The * iterator offered by this class always observes the list in a consistent state, and it never throws a - * <tt>ConcurrentModificationException</tt>.</p> - * <p>The <tt>ThreadRobustList</tt> does not permit adding <tt>null</tt> items.</p> - * <p>The usage of <tt>ThreadRobustList</tt> has no memory consistency effects. </p> + * <code>ConcurrentModificationException</code>.</p> + * <p>The <code>ThreadRobustList</code> does not permit adding <code>null</code> items.</p> + * <p>The usage of <code>ThreadRobustList</code> has no memory consistency effects. </p> * * @author <a href="mailto:steinar@yahoo-inc.com">Steinar Knutsen</a> * @author bratseth @@ -28,7 +28,7 @@ public class ThreadRobustList<T> implements Iterable<T> { private int next = 0; /** - * <p>Constructs a new instance of this class with an initial capacity of <tt>10</tt>.</p> + * <p>Constructs a new instance of this class with an initial capacity of <code>10</code>.</p> */ public ThreadRobustList() { this(10); @@ -46,18 +46,18 @@ public class ThreadRobustList<T> implements Iterable<T> { /** * <p>Returns whether or not this list is empty.</p> * - * @return <tt>true</tt> if this list has zero items + * @return <code>true</code> if this list has zero items */ public boolean isEmpty() { return next == 0; } /** - * <p>Adds an item to this list. As opposed to <tt>CopyOnWriteArrayList</tt>, items added to this list may become + * <p>Adds an item to this list. As opposed to <code>CopyOnWriteArrayList</code>, items added to this list may become * visible to iterators created <em>before</em> a call to this method.</p> * * @param item the item to add - * @throws NullPointerException if <tt>item</tt> is <tt>null</tt> + * @throws NullPointerException if <code>item</code> is <code>null</code> */ public void add(T item) { if (item == null) { @@ -74,9 +74,9 @@ public class ThreadRobustList<T> implements Iterable<T> { } /** - * <p>Returns an iterator over the items in this list. As opposed to <tt>CopyOnWriteArrayList</tt>, this iterator - * may see items added to the <tt>ThreadRobustList</tt> even if they occur <em>after</em> a call to this method.</p> - * <p>The returned iterator does not support <tt>remove()</tt>.</p> + * <p>Returns an iterator over the items in this list. As opposed to <code>CopyOnWriteArrayList</code>, this iterator + * may see items added to the <code>ThreadRobustList</code> even if they occur <em>after</em> a call to this method.</p> + * <p>The returned iterator does not support <code>remove()</code>.</p> * * @return an iterator over this list */ diff --git a/yolean/src/main/java/com/yahoo/yolean/trace/TraceNode.java b/yolean/src/main/java/com/yahoo/yolean/trace/TraceNode.java index 92e083c9998..b3c4d67db47 100644 --- a/yolean/src/main/java/com/yahoo/yolean/trace/TraceNode.java +++ b/yolean/src/main/java/com/yahoo/yolean/trace/TraceNode.java @@ -10,16 +10,16 @@ import java.util.List; import java.util.NoSuchElementException; /** - * <p>This class represents a single node in a tree of <tt>TraceNodes</tt>. The trace forms a tree where there is a - * branch for each parallel execution, and a node within such a branch for each traced event. As each <tt>TraceNode</tt> + * <p>This class represents a single node in a tree of <code>TraceNodes</code>. The trace forms a tree where there is a + * branch for each parallel execution, and a node within such a branch for each traced event. As each <code>TraceNode</code> * may contain a payload of any type, the trace tree can be used to exchange any thread-safe state between producers and * consumers in different threads, whether or not the shape of the trace tree is relevant to the particular * information.</p> * <p>This class uses a {@link ThreadRobustList} for its children. That list allows multiple threads to inspect the - * hierarchy of a <tt>TraceNode</tt> tree while there are other threads concurrently modifying it, without incurring the - * cost of memory synchronization. The only caveat being that for each <tt>TraceNode</tt> there can never be more than - * exactly one writer thread. If multiple threads need to mutate a single <tt>TraceNode</tt>, then the writer threads - * need to synchronize their access on the <tt>TraceNode</tt>.</p> + * hierarchy of a <code>TraceNode</code> tree while there are other threads concurrently modifying it, without incurring the + * cost of memory synchronization. The only caveat being that for each <code>TraceNode</code> there can never be more than + * exactly one writer thread. If multiple threads need to mutate a single <code>TraceNode</code>, then the writer threads + * need to synchronize their access on the <code>TraceNode</code>.</p> * * @author <a href="mailto:steinar@yahoo-inc.com">Steinar Knutsen</a> * @author bratseth @@ -35,7 +35,7 @@ public class TraceNode { /** * <p>Creates a new instance of this class.</p> * - * @param payload the payload to assign to this, may be <tt>null</tt> + * @param payload the payload to assign to this, may be <code>null</code> * @param timestamp the timestamp to assign to this */ public TraceNode(Object payload, long timestamp) { @@ -44,11 +44,11 @@ public class TraceNode { } /** - * <p>Adds another <tt>TraceNode</tt> as a child to this.</p> + * <p>Adds another <code>TraceNode</code> as a child to this.</p> * * @param child the TraceNode to add * @return this, to allow chaining - * @throws IllegalArgumentException if <tt>child</tt> is not a root TraceNode + * @throws IllegalArgumentException if <code>child</code> is not a root TraceNode * @see #isRoot() */ public TraceNode add(TraceNode child) { @@ -64,12 +64,12 @@ public class TraceNode { } /** - * <p>Returns a read-only iterable of all {@link #payload() payloads} that are instances of <tt>payloadType</tt>, - * in all its decendants. The payload of <em>this</em> <tt>TraceNode</tt> is ignored.</p> + * <p>Returns a read-only iterable of all {@link #payload() payloads} that are instances of <code>payloadType</code>, + * in all its decendants. The payload of <em>this</em> <code>TraceNode</code> is ignored.</p> * <p>The payloads are retrieved in depth-first, prefix order.</p> * * @param payloadType the type of payloads to retrieve - * @return the payloads, never <tt>null</tt> + * @return the payloads, never <code>null</code> */ public <PAYLOADTYPE> Iterable<PAYLOADTYPE> descendants(final Class<PAYLOADTYPE> payloadType) { if (children == null) { @@ -85,7 +85,7 @@ public class TraceNode { } /** - * <p>Returns the payload of this <tt>TraceNode</tt>, or null if none.</p> + * <p>Returns the payload of this <code>TraceNode</code>, or null if none.</p> * * @return the payload */ @@ -94,7 +94,7 @@ public class TraceNode { } /** - * <p>Returns the timestamp of this <tt>TraceNode</tt>.</p> + * <p>Returns the timestamp of this <code>TraceNode</code>.</p> * * @return the timestamp */ @@ -103,7 +103,7 @@ public class TraceNode { } /** - * <p>Returns the parent <tt>TraceNode</tt> of this.</p> + * <p>Returns the parent <code>TraceNode</code> of this.</p> * * @return the parent */ @@ -112,7 +112,7 @@ public class TraceNode { } /** - * <p>Returns the child <tt>TraceNodes</tt> of this.</p> + * <p>Returns the child <code>TraceNodes</code> of this.</p> * * @return the children */ @@ -124,16 +124,16 @@ public class TraceNode { } /** - * <p>Returns whether or not this <tt>TraceNode</tt> is a root node (i.e. it has no parent).</p> + * <p>Returns whether or not this <code>TraceNode</code> is a root node (i.e. it has no parent).</p> * - * @return <tt>true</tt> if {@link #parent()} returns <tt>null</tt> + * @return <code>true</code> if {@link #parent()} returns <code>null</code> */ public boolean isRoot() { return parent == null; } /** - * <p>Returns the root <tt>TraceNode</tt> of the tree that this <tt>TraceNode</tt> belongs to.</p> + * <p>Returns the root <code>TraceNode</code> of the tree that this <code>TraceNode</code> belongs to.</p> * * @return the root */ @@ -146,7 +146,7 @@ public class TraceNode { } /** - * <p>Visits this <tt>TraceNode</tt> and all of its descendants in depth-first, prefix order.</p> + * <p>Visits this <code>TraceNode</code> and all of its descendants in depth-first, prefix order.</p> * * @param visitor The visitor to accept. * @return The <code>visitor</code> parameter. diff --git a/yolean/src/main/java/com/yahoo/yolean/trace/TraceVisitor.java b/yolean/src/main/java/com/yahoo/yolean/trace/TraceVisitor.java index c45823da19a..23525b65571 100644 --- a/yolean/src/main/java/com/yahoo/yolean/trace/TraceVisitor.java +++ b/yolean/src/main/java/com/yahoo/yolean/trace/TraceVisitor.java @@ -13,17 +13,17 @@ public abstract class TraceVisitor { * <p>Visits a {@link TraceNode}. Called by {@link TraceNode#accept(TraceVisitor)}, before visiting its * children.</p> * - * @param node the <tt>TraceNode</tt> being visited + * @param node the <code>TraceNode</code> being visited * @see TraceNode#accept(TraceVisitor) */ public abstract void visit(TraceNode node); /** * <p>Enters a {@link TraceNode}. This method is called after {@link #visit(TraceNode)}, but before visiting its - * children. Note that this method is NOT called if a <tt>TraceNode</tt> has zero children.</p> + * children. Note that this method is NOT called if a <code>TraceNode</code> has zero children.</p> * <p>The default implementation of this method does nothing.</p> * - * @param node the <tt>TraceNode</tt> being entered + * @param node the <code>TraceNode</code> being entered * @see #leaving(TraceNode) */ @SuppressWarnings("UnusedParameters") @@ -33,10 +33,10 @@ public abstract class TraceVisitor { /** * <p>Leaves a {@link TraceNode}. This method is called after {@link #entering(TraceNode)}, and after visiting its - * children. Note that this method is NOT called if a <tt>TraceNode</tt> has zero children.</p> + * children. Note that this method is NOT called if a <code>TraceNode</code> has zero children.</p> * <p>The default implementation of this method does nothing.</p> * - * @param node the <tt>TraceNode</tt> being left + * @param node the <code>TraceNode</code> being left */ @SuppressWarnings("UnusedParameters") public void leaving(TraceNode node) { |