Author: gtrasuk
Date: Thu Dec 11 21:22:46 2014
New Revision: 1644771
URL: http://svn.apache.org/r1644771
Log:
The 'tools' module under the river-rt-tools project now successfully builds its
JavaDoc.
Modified:
river/river-rt-tools/trunk/tools/src/main/java/org/apache/river/tools/rt/CheckConfigurationFile.java
river/river-rt-tools/trunk/tools/src/main/java/org/apache/river/tools/rt/ClassServer.java
river/river-rt-tools/trunk/tools/src/main/java/org/apache/river/tools/rt/ComputeDigest.java
river/river-rt-tools/trunk/tools/src/main/java/org/apache/river/tools/rt/ComputeHttpmdCodebase.java
river/river-rt-tools/trunk/tools/src/main/java/org/apache/river/tools/rt/Config.java
river/river-rt-tools/trunk/tools/src/main/java/org/apache/river/tools/rt/JarWrapper.java
Modified:
river/river-rt-tools/trunk/tools/src/main/java/org/apache/river/tools/rt/CheckConfigurationFile.java
URL:
http://svn.apache.org/viewvc/river/river-rt-tools/trunk/tools/src/main/java/org/apache/river/tools/rt/CheckConfigurationFile.java?rev=1644771&r1=1644770&r2=1644771&view=diff
==============================================================================
---
river/river-rt-tools/trunk/tools/src/main/java/org/apache/river/tools/rt/CheckConfigurationFile.java
(original)
+++
river/river-rt-tools/trunk/tools/src/main/java/org/apache/river/tools/rt/CheckConfigurationFile.java
Thu Dec 11 21:22:46 2014
@@ -63,9 +63,8 @@ import net.jini.config.ConfigurationProv
* <li> <a href="#examples">Examples for running CheckConfigurationFile</a>
* </ul> <p>
*
- * <a name="entry_desc">
+ * <a name="entry_desc"></a>
* <h3>Entry description files</h3>
- * </a>
*
* Checking of the source can be controlled by specifying one or more entry
* description files, each listing the names and types of entries that are
@@ -111,9 +110,8 @@ import net.jini.config.ConfigurationProv
* </pre>
* </blockquote> <p>
*
- * <a name="examples">
+ * <a name="examples"></a>
* <h3>Examples for running CheckConfigurationFile</h3>
- * </a>
*
* This utility can be run from the {@linkplain #main command line}, or by
* calling the {@link #check(String, ClassLoader, String[], String,
@@ -133,8 +131,8 @@ import net.jini.config.ConfigurationProv
*
* where <var><b>install_dir</b></var> is the directory where the Apache River
release
* is installed, and <var><b>your-norm.config</b></var> is a configuration
- * source file intended for use with the transient {@linkplain
- * com.sun.jini.norm Norm} service implementation. This command will print out
+ * source file intended for use with the transient 'Norm'
+ * service implementation. This command will print out
* any problems that it detects in the configuration file, including entries
* that are not recognized or have the wrong type for the Norm service.
*
@@ -215,6 +213,7 @@ public class CheckConfigurationFile {
* provider is created by passing that constructor a <code>Reader</code>
* for the source file to be checked, the location and entry override
* values, and the class loader.
+ * @param args The command-line arguments passed in from the operating
system.
*/
public static void main(String[] args) {
if (args.length == 0) {
Modified:
river/river-rt-tools/trunk/tools/src/main/java/org/apache/river/tools/rt/ClassServer.java
URL:
http://svn.apache.org/viewvc/river/river-rt-tools/trunk/tools/src/main/java/org/apache/river/tools/rt/ClassServer.java?rev=1644771&r1=1644770&r2=1644771&view=diff
==============================================================================
---
river/river-rt-tools/trunk/tools/src/main/java/org/apache/river/tools/rt/ClassServer.java
(original)
+++
river/river-rt-tools/trunk/tools/src/main/java/org/apache/river/tools/rt/ClassServer.java
Thu Dec 11 21:22:46 2014
@@ -59,17 +59,17 @@ import java.util.logging.Logger;
* <li><a href="#running">Examples for running ClassServer</a>
* </ul>
* <p>
- * <a name="logging"><h3>Logging</h3></a>
+ * <a name="logging"></a><h3>Logging</h3>
* <p>
*
* This implementation uses the {@link Logger} named
* <code>com.sun.jini.tool.ClassServer</code> to log information at the
* following logging levels:
- * <p>
+ *
* <table border="1" cellpadding="5"
* summary="Describes logging performed by ClassServer at different
* logging levels">
- * <caption halign="center" valign="top"><b><code>
+ * <caption><b><code>
* com.sun.jini.tool.ClassServer</code></b></caption>
*
* <tr> <th scope="col">Level</th> <th scope="col">Description</th> </tr>
@@ -107,13 +107,13 @@ import java.util.logging.Logger;
* </table>
*
* <p>
- * <a name="running"><h3>Examples for running ClassServer</h3></a>
+ * <a name="running"></a><h3>Examples for running ClassServer</h3>
* <p>
*
* This server can be run directly from the
* {@linkplain #main command line}
* or as a nonactivatable service under the
- * {@linkplain com.sun.jini.start Service Starter}.
+ * {@linkplain org.apache.river.tools.rt.start Service Starter}.
* <p>
* An example of running directly from the command line is:
* <blockquote><pre>
@@ -139,10 +139,10 @@ import java.util.logging.Logger;
* following configuration file:
* <a name="config"></a>
* <blockquote><pre>
- * import com.sun.jini.start.NonActivatableServiceDescriptor;
- * import com.sun.jini.start.ServiceDescriptor;
+ * import org.apache.river.tools.rt.start.NonActivatableServiceDescriptor;
+ * import org.apache.river.tools.rt.start.ServiceDescriptor;
*
- * com.sun.jini.start {
+ * org.apache.river.tools.rt.start {
*
* serviceDescriptors = new ServiceDescriptor[]{
* new NonActivatableServiceDescriptor(
@@ -420,7 +420,7 @@ public class ClassServer extends Thread
Integer.toString(getPort()));
}
- /** Returns the port on which this server is listening. */
+ /** @return the port on which this server is listening. */
public int getPort() {
return server.getLocalPort();
}
@@ -745,6 +745,7 @@ public class ClassServer extends Thread
* file has been completely downloaded.
*
* @param fp The path to the file that was downloaded.
+ * @param addr The address of the client.
*/
protected void fileDownloaded(String fp, InetAddress addr) {
}
@@ -804,6 +805,7 @@ public class ClassServer extends Thread
* directory with a match is used. When this option is used, an open file
* descriptor and cached information is held for each JAR or zip file, for
* the life of the process.
+ * @param args Command line arguments.
*/
public static void main(String[] args) {
int port = DEFAULT_PORT;
Modified:
river/river-rt-tools/trunk/tools/src/main/java/org/apache/river/tools/rt/ComputeDigest.java
URL:
http://svn.apache.org/viewvc/river/river-rt-tools/trunk/tools/src/main/java/org/apache/river/tools/rt/ComputeDigest.java?rev=1644771&r1=1644770&r2=1644771&view=diff
==============================================================================
---
river/river-rt-tools/trunk/tools/src/main/java/org/apache/river/tools/rt/ComputeDigest.java
(original)
+++
river/river-rt-tools/trunk/tools/src/main/java/org/apache/river/tools/rt/ComputeDigest.java
Thu Dec 11 21:22:46 2014
@@ -63,6 +63,7 @@ public class ComputeDigest {
* of a <code>file:</code> URL. The second argument, if present,
* specifies the message digest algorithm, which defaults to
* <code>SHA-1</code>.
+ * @param args Command-line arguments.
*/
public static void main(String[] args) {
if (args.length < 1 || args.length > 2) {
Modified:
river/river-rt-tools/trunk/tools/src/main/java/org/apache/river/tools/rt/ComputeHttpmdCodebase.java
URL:
http://svn.apache.org/viewvc/river/river-rt-tools/trunk/tools/src/main/java/org/apache/river/tools/rt/ComputeHttpmdCodebase.java?rev=1644771&r1=1644770&r2=1644771&view=diff
==============================================================================
---
river/river-rt-tools/trunk/tools/src/main/java/org/apache/river/tools/rt/ComputeHttpmdCodebase.java
(original)
+++
river/river-rt-tools/trunk/tools/src/main/java/org/apache/river/tools/rt/ComputeHttpmdCodebase.java
Thu Dec 11 21:22:46 2014
@@ -48,8 +48,8 @@ import net.jini.url.httpmd.HttpmdUtil;
* is installed, <var><b>your_host</b></var> is the host where the HTTP server
* for the <code>sdm-dl.jar</code> JAR file will be running, and
* <var><b>http_port</b></var> is the port for that server. This command prints
- * out the download codebase for use by a client that uses the {@link
- * net.jini.lookup.ServiceDiscoveryManager}, using an HTTPMD URL to guarantee
+ * out the download codebase for use by a client that uses the
+ * net.jini.lookup.ServiceDiscoveryManager, using an HTTPMD URL to guarantee
* integrity for the classes in the <code>sdm-dl.jar</code> JAR file. The
* message digest will be computed using the <code>md5</code> algorithm, and
* the <code>0</code> will be replaced by the computed digest.
@@ -82,6 +82,7 @@ public class ComputeHttpmdCodebase {
* Do not use a directory on a remote filesystem, or a directory URL, if
* the underlying network access protocol does not provide adequate data
* integrity or authentication of the remote host.
+ * @param args Command-line arguments.
*/
public static void main(String[] args) {
if (args.length < 2) {
Modified:
river/river-rt-tools/trunk/tools/src/main/java/org/apache/river/tools/rt/Config.java
URL:
http://svn.apache.org/viewvc/river/river-rt-tools/trunk/tools/src/main/java/org/apache/river/tools/rt/Config.java?rev=1644771&r1=1644770&r2=1644771&view=diff
==============================================================================
---
river/river-rt-tools/trunk/tools/src/main/java/org/apache/river/tools/rt/Config.java
(original)
+++
river/river-rt-tools/trunk/tools/src/main/java/org/apache/river/tools/rt/Config.java
Thu Dec 11 21:22:46 2014
@@ -30,7 +30,7 @@ import net.jini.config.ConfigurationExce
* <code>net.jini.config</code> to log information at
* the following logging levels:
*
- * <table border=1 cellpadding=5>
+ * <table border=1 cellpadding=5 summary="Logging levels used">
*
* <tr> <th> Level <th> Description
*
@@ -70,8 +70,6 @@ public class Config {
* @return a non-<code>null</code> object obtained from
* calling <code>config.getEntry</code> using
* the other passed arguments
- * @throws NoSuchEntryException if the underlying call to
- * <code>config.getEntry</code> does
* @throws ConfigurationException if the underlying call to
* <code>config.getEntry</code> does, or if the
* returned entry is <code>null</code>.
@@ -112,8 +110,6 @@ public class Config {
* @return a non-<code>null</code> object obtained from
* calling <code>config.getEntry</code> using
* the other passed arguments
- * @throws NoSuchEntryException if the underlying call to
- * <code>config.getEntry</code> does
* @throws ConfigurationException if the underlying call to
* <code>config.getEntry</code> does, or if the
* returned entry is <code>null</code>.
@@ -160,8 +156,6 @@ public class Config {
* @return a non-<code>null</code> object obtained from
* calling <code>config.getEntry</code> using
* the other passed arguments
- * @throws NoSuchEntryException if the underlying call to
- * <code>config.getEntry</code> does
* @throws ConfigurationException if the underlying call to
* <code>config.getEntry</code> does, or if the
* returned entry is <code>null</code>.
@@ -253,8 +247,6 @@ public class Config {
* @return a long obtained from calling <code>config.getEntry</code>
* using <code>component</code>, <code>name</code>,
* and <code>defaultValue</code>.
- * @throws NoSuchEntryException if the underlying call to
- * <code>config.getEntry</code> does
* @throws ConfigurationException if the underlying call to
* <code>config.getEntry</code> does, or if the
* returned entry is <code>null</code>, or if
@@ -322,8 +314,6 @@ public class Config {
* @return a int obtained from calling <code>config.getEntry</code>
* using <code>component</code>, <code>name</code>,
* and <code>defaultValue</code>.
- * @throws NoSuchEntryException if the underlying call to
- * <code>config.getEntry</code> does
* @throws ConfigurationException if the underlying call to
* <code>config.getEntry</code> does, or if the
* returned entry is <code>null</code>, or if
@@ -391,8 +381,6 @@ public class Config {
* @return a float obtained from calling <code>config.getEntry</code>
* using <code>component</code>, <code>name</code>,
* and <code>defaultValue</code>.
- * @throws NoSuchEntryException if the underlying call to
- * <code>config.getEntry</code> does
* @throws ConfigurationException if the underlying call to
* <code>config.getEntry</code> does, or if the
* returned entry is <code>null</code>, or if
Modified:
river/river-rt-tools/trunk/tools/src/main/java/org/apache/river/tools/rt/JarWrapper.java
URL:
http://svn.apache.org/viewvc/river/river-rt-tools/trunk/tools/src/main/java/org/apache/river/tools/rt/JarWrapper.java?rev=1644771&r1=1644770&r2=1644771&view=diff
==============================================================================
---
river/river-rt-tools/trunk/tools/src/main/java/org/apache/river/tools/rt/JarWrapper.java
(original)
+++
river/river-rt-tools/trunk/tools/src/main/java/org/apache/river/tools/rt/JarWrapper.java
Thu Dec 11 21:22:46 2014
@@ -72,7 +72,7 @@ import java.util.regex.Pattern;
* <li> {@linkplain #main Processing Options}
* </ul>
* <p>
- * <a name="applicability"><h3>Applicability</h3></a>
+ * <a name="applicability"></a><h3>Applicability</h3>
* <p>
* The <code>JarWrapper</code> tool is applicable in the following deployment
* situations, which may overlap:
@@ -82,13 +82,13 @@ import java.util.regex.Pattern;
* JAR file with a combined preferred list. Preferred resources are
* described in the documentation for the {@link net.jini.loader.pref}
* package.
- * <p>
+ *
* <li> If a codebase contains multiple JAR files and requires integrity
* protection, <code>JarWrapper</code> can be used to produce a wrapper
* JAR file with a <code>Class-Path</code> attribute that uses HTTPMD
* URLs. HTTPMD URLs are described in the documentation for the
* {@link net.jini.url.httpmd} package.
- * <p>
+ *
* <li> If an application or service packaged as an executable JAR file
* refers to classes specified at deployment time (e.g., via a
* {@link net.jini.config.Configuration Configuration}) which are not
@@ -100,7 +100,7 @@ import java.util.regex.Pattern;
* file.
* </ul>
* <p>
- * <a name="running"><h3>Using the Tool</h3></a>
+ * <a name="running"></a><h3>Using the Tool</h3>
* <code>JarWrapper</code> can be run directly from the
* {@linkplain #main command line} or can be invoked programmatically using the
* {@link #wrap wrap} method.
@@ -140,16 +140,16 @@ import java.util.regex.Pattern;
* </pre></blockquote>
*
* <p>
- * <a name="logging"><h3>Logging</h3></a>
+ * <a name="logging"></a><h3>Logging</h3>
* <p>
* <code>JarWrapper</code> uses the {@link Logger} named
* <code>com.sun.jini.tool.JarWrapper</code> to log information at the
* following logging levels:
- * <p>
+ *
* <table border="1" cellpadding="5"
* summary="Describes logging performed by JarWrapper at different
* logging levels">
- * <caption halign="center" valign="top"><b><code>
+ * <caption><b><code>
* com.sun.jini.tool.JarWrapper</code></b></caption>
*
* <tr> <th scope="col"> Level <th scope="col"> Description </tr>
@@ -324,23 +324,23 @@ public class JarWrapper {
* <code>-manifest</code> option (described below).
* <p>
* Supported options for this tool include:
- * <p>
+ *
* <dl>
* <dt> <code>-verbose</code>
* <dd> Sets the level of the <code>com.sun.jini.tool.JarWrapper</code>
* logger to <code>Level.FINER</code>.
- * <p>
+ *
* <dt> <code>-httpmd[=algorithm]</code>
* <dd> Use (relative) HTTPMD URLs in the <code>Class-Path</code>
* attribute of the generated wrapper JAR file. The default is to
* use HTTP URLs. Digests for HTTPMD URLs are calculated using the
* given algorithm, or SHA-1 if none is specified.
- * <p>
+ *
* <dt> <code>-noindex</code>
* <dd> Do not include a JAR index in the generated wrapper JAR file.
The
* default is to compile an index based on the contents of the
* source JAR files.
- * <p>
+ *
* <dt> <code>-manifest=<I>file</I></code>
* <dd> Specifies a manifest file containing attribute values to include
* in the manifest file inside the generated wrapper JAR file.
@@ -357,6 +357,7 @@ public class JarWrapper {
* these four will be appended to the manifest attribute list and
* will appear in the resultant <code>MANIFEST.MF</code> file.
* </dl>
+ * @param args Command line arguments.
*/
public static void main(String[] args) {
String destJar;
