This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-daemon.git
The following commit(s) were added to refs/heads/master by this push:
new facdeb2 Javadoc: Replace <code></code> HTML tags with Javadoc {@code}
notation.
facdeb2 is described below
commit facdeb2408ed2d50003b9542b0fbda16b6003b22
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Tue Dec 10 10:08:51 2019 -0500
Javadoc: Replace <code></code> HTML tags with Javadoc {@code} notation.
---
.../java/org/apache/commons/daemon/Daemon.java | 20 ++++----
.../org/apache/commons/daemon/DaemonContext.java | 4 +-
.../apache/commons/daemon/DaemonPermission.java | 60 +++++++++++-----------
.../daemon/support/DaemonConfiguration.java | 18 +++----
4 files changed, 51 insertions(+), 51 deletions(-)
diff --git a/src/main/java/org/apache/commons/daemon/Daemon.java
b/src/main/java/org/apache/commons/daemon/Daemon.java
index a9d12af..93fc6ad 100644
--- a/src/main/java/org/apache/commons/daemon/Daemon.java
+++ b/src/main/java/org/apache/commons/daemon/Daemon.java
@@ -20,7 +20,7 @@ package org.apache.commons.daemon;
/**
* Provides support for native daemon invocation. Using
* a platform dependant helper program, classes that implement the
- * <code>Daemon</code> interface can be initialized, started and
+ * {@code Daemon} interface can be initialized, started and
* stopped according to the conventions of the underlying operating
* system.
* <p>
@@ -33,10 +33,10 @@ public interface Daemon
{
/**
- * Initializes this <code>Daemon</code> instance.
+ * Initializes this {@code Daemon} instance.
* <p>
* This method gets called once the JVM process is created and the
- * <code>Daemon</code> instance is created thru its empty public
+ * {@code Daemon} instance is created thru its empty public
* constructor.
* </p>
* <p>
@@ -45,21 +45,21 @@ public interface Daemon
* so, this method might be called with <i>super-user</i> privileges.
* </p>
* <p>
- * For example, it might be wise to create <code>ServerSocket</code>
+ * For example, it might be wise to create {@code ServerSocket}
* instances within the scope of this method, and perform all operations
* requiring <i>super-user</i> privileges in the underlying operating
* system.
* </p>
* <p>
* Apart from set up and allocation of native resources, this method
- * must not start the actual operation of the <code>Daemon</code> (such
- * as starting threads calling the <code>ServerSocket.accept()</code>
+ * must not start the actual operation of the {@code Daemon} (such
+ * as starting threads calling the {@code ServerSocket.accept()}
* method) as this would impose some serious security hazards. The
- * start of operation must be performed in the <code>start()</code>
+ * start of operation must be performed in the {@code start()}
* method.
* </p>
*
- * @param context A <code>DaemonContext</code> object used to
+ * @param context A {@code DaemonContext} object used to
* communicate with the container.
* @throws DaemonInitException An exception that prevented
* initialization where you want to display a nice message to the user,
@@ -71,7 +71,7 @@ public interface Daemon
throws DaemonInitException, Exception;
/**
- * Starts the operation of this <code>Daemon</code> instance. This
+ * Starts the operation of this {@code Daemon} instance. This
* method is to be invoked by the environment after the init()
* method has been successfully invoked and possibly the security
* level of the JVM has been dropped. Implementors of this
@@ -85,7 +85,7 @@ public interface Daemon
throws Exception;
/**
- * Stops the operation of this <code>Daemon</code> instance. Note
+ * Stops the operation of this {@code Daemon} instance. Note
* that the proper place to free any allocated resources such as
* sockets or file descriptors is in the destroy method, as the
* container may restart the Daemon by calling start() after
diff --git a/src/main/java/org/apache/commons/daemon/DaemonContext.java
b/src/main/java/org/apache/commons/daemon/DaemonContext.java
index ddaabda..888d1f0 100644
--- a/src/main/java/org/apache/commons/daemon/DaemonContext.java
+++ b/src/main/java/org/apache/commons/daemon/DaemonContext.java
@@ -27,7 +27,7 @@ public interface DaemonContext
/**
* @return A {@link DaemonController} object that can be used to control
- * the {@link Daemon} instance that this
<code>DaemonContext</code>
+ * the {@link Daemon} instance that this {@code DaemonContext}
* is passed to.
*/
public DaemonController getController();
@@ -35,7 +35,7 @@ public interface DaemonContext
/**
* @return An array of {@link String} arguments supplied by the environment
* corresponding to the array of arguments given in the
- * <code>public static void main()</code> method used as an entry
+ * {@code public static void main()} method used as an entry
* point to most other java programs.
*/
public String[] getArguments();
diff --git a/src/main/java/org/apache/commons/daemon/DaemonPermission.java
b/src/main/java/org/apache/commons/daemon/DaemonPermission.java
index e4bb3d2..ae4d563 100644
--- a/src/main/java/org/apache/commons/daemon/DaemonPermission.java
+++ b/src/main/java/org/apache/commons/daemon/DaemonPermission.java
@@ -22,7 +22,7 @@ import java.util.StringTokenizer;
/**
* Represents the permissions to control and query the status of
- * a <code>Daemon</code>. A <code>DaemonPermission</code> consists of a
+ * a {@code Daemon}. A {@code DaemonPermission} consists of a
* target name and a list of actions associated with it.
* <p>
* In this specification version the only available target name for this
@@ -46,29 +46,29 @@ import java.util.StringTokenizer;
* <td rowspan="5">"control"</td>
* <td>"start"</td>
* <td>
- * The permission to call the <code>start()</code> method in an instance
- * of a <code>DaemonController</code> interface.
+ * The permission to call the {@code start()} method in an instance
+ * of a {@code DaemonController} interface.
* </td>
* </tr>
* <tr>
* <td>"stop"</td>
* <td>
- * The permission to call the <code>stop()</code> method in an instance
- * of a <code>DaemonController</code> interface.
+ * The permission to call the {@code stop()} method in an instance
+ * of a {@code DaemonController} interface.
* </td>
* </tr>
* <tr>
* <td>"shutdown"</td>
* <td>
- * The permission to call the <code>shutdown()</code> method in an instance
- * of a <code>DaemonController</code> interface.
+ * The permission to call the {@code shutdown()} method in an instance
+ * of a {@code DaemonController} interface.
* </td>
* </tr>
* <tr>
* <td>"reload"</td>
* <td>
- * The permission to call the <code>reload()</code> method in an instance
- * of a <code>DaemonController</code> interface.
+ * The permission to call the {@code reload()} method in an instance
+ * of a {@code DaemonController} interface.
* </td>
* </tr>
* <tr>
@@ -103,49 +103,49 @@ public final class DaemonPermission extends Permission
/**
* The action name associated with the permission to call the
- * <code>DaemonController.start()</code> method.
+ * {@code DaemonController.start()} method.
*/
protected static final String CONTROL_START = "start";
/**
* The action name associated with the permission to call the
- * <code>DaemonController.stop()</code> method.
+ * {@code DaemonController.stop()} method.
*/
protected static final String CONTROL_STOP = "stop";
/**
* The action name associated with the permission to call the
- * <code>DaemonController.shutdown()</code> method.
+ * {@code DaemonController.shutdown()} method.
*/
protected static final String CONTROL_SHUTDOWN = "shutdown";
/**
* The action name associated with the permission to call the
- * <code>DaemonController.reload()</code> method.
+ * {@code DaemonController.reload()} method.
*/
protected static final String CONTROL_RELOAD = "reload";
/**
* The action mask associated with the permission to call the
- * <code>DaemonController.start()</code> method.
+ * {@code DaemonController.start()} method.
*/
protected static final int MASK_CONTROL_START = 0x01;
/**
* The action mask associated with the permission to call the
- * <code>DaemonController.stop()</code> method.
+ * {@code DaemonController.stop()} method.
*/
protected static final int MASK_CONTROL_STOP = 0x02;
/**
* The action mask associated with the permission to call the
- * <code>DaemonController.shutdown()</code> method.
+ * {@code DaemonController.shutdown()} method.
*/
protected static final int MASK_CONTROL_SHUTDOWN = 0x04;
/**
* The action mask associated with the permission to call the
- * <code>DaemonController.reload()</code> method.
+ * {@code DaemonController.reload()} method.
*/
protected static final int MASK_CONTROL_RELOAD = 0x08;
@@ -171,10 +171,10 @@ public final class DaemonPermission extends Permission
*/
/**
- * Creates a new <code>DaemonPermission</code> instance with a specified
+ * Creates a new {@code DaemonPermission} instance with a specified
* permission name.
* <p>
- * This constructor will create a new <code>DaemonPermission</code>
+ * This constructor will create a new {@code DaemonPermission}
* instance that <b>will not</b> grant any permission to the caller.
*
* @param target The target name of this permission.
@@ -204,7 +204,7 @@ public final class DaemonPermission extends Permission
}
/**
- * Creates a new <code>DaemonPermission</code> instance with a specified
+ * Creates a new {@code DaemonPermission} instance with a specified
* permission name and a specified list of actions.
*
* @param target The target name of this permission.
@@ -232,7 +232,7 @@ public final class DaemonPermission extends Permission
/**
* Returns the list of actions permitted by this instance of
- * <code>DaemonPermission</code> in its canonical form.
+ * {@code DaemonPermission} in its canonical form.
*
* @return The canonicalized list of actions.
*/
@@ -246,7 +246,7 @@ public final class DaemonPermission extends Permission
}
/**
- * Returns the hash code for this <code>DaemonPermission</code> instance.
+ * Returns the hash code for this {@code DaemonPermission} instance.
*
* @return An hash code value.
*/
@@ -258,10 +258,10 @@ public final class DaemonPermission extends Permission
}
/**
- * Checks if a specified object equals <code>DaemonPermission</code>.
+ * Checks if a specified object equals {@code DaemonPermission}.
*
* @return <b>true</b> or <b>false</b> wether the specified object equals
- * this <code>DaemonPermission</code> instance or not.
+ * this {@code DaemonPermission} instance or not.
*/
@Override
public boolean equals(final Object object)
@@ -283,11 +283,11 @@ public final class DaemonPermission extends Permission
}
/**
- * Checks if this <code>DaemonPermission</code> implies another
- * <code>Permission</code>.
+ * Checks if this {@code DaemonPermission} implies another
+ * {@code Permission}.
*
* @return <b>true</b> or <b>false</b> wether the specified permission
- * is implied by this <code>DaemonPermission</code> instance or
+ * is implied by this {@code DaemonPermission} instance or
* not.
*/
@Override
@@ -310,10 +310,10 @@ public final class DaemonPermission extends Permission
}
/**
- * Returns a <code>String</code> representation of this instance.
+ * Returns a {@code String} representation of this instance.
*
- * @return A <code>String</code> representing this
- * <code>DaemonPermission</code> instance.
+ * @return A {@code String} representing this
+ * {@code DaemonPermission} instance.
*/
@Override
public String toString()
diff --git
a/src/main/java/org/apache/commons/daemon/support/DaemonConfiguration.java
b/src/main/java/org/apache/commons/daemon/support/DaemonConfiguration.java
index 0bdd95f..8178ca9 100644
--- a/src/main/java/org/apache/commons/daemon/support/DaemonConfiguration.java
+++ b/src/main/java/org/apache/commons/daemon/support/DaemonConfiguration.java
@@ -28,21 +28,21 @@ import java.text.ParseException;
* Used by jsvc for Daemon configuration.
* <p>
* Configuration is read from properties file.
- * If no properties file is given the <code>daemon.properties</code>
+ * If no properties file is given the {@code daemon.properties}
* is used from the current directory.
* </p>
* <p>
* The properties file can have property values expanded at runtime
* by using System properties or execution environment. The part
- * of the property value between <code>${</code> and <code>}</code>
+ * of the property value between {@code ${} and {@code }}
* will be used as System property or environment key. If found then
- * the entire <code>${foo}</code> will be replaced by the value of
- * either system property or environment variable named <code>foo</code>.
+ * the entire {@code ${foo}} will be replaced by the value of
+ * either system property or environment variable named {@code foo}.
* </p>
* <p>
- * If no variable is found the <code>${foo}</code> will be passed as is.
- * In case of <code>$${foo}</code> this will be unescaped and resulting
- * value will be <code>${foo}</code>.
+ * If no variable is found the {@code ${foo}} will be passed as is.
+ * In case of {@code $${foo}} this will be unescaped and resulting
+ * value will be {@code ${foo}}.
* </p>
*
*/
@@ -76,7 +76,7 @@ public final class DaemonConfiguration
* Loads the configuration properties file.
*
* @param fileName The properties file to load.
- * @return <code>true</code> if the file was loaded.
+ * @return {@code true} if the file was loaded.
*/
public boolean load(String fileName)
{
@@ -177,7 +177,7 @@ public final class DaemonConfiguration
* Gets the configuration property array.
* <p>
* Property array is constructed form the list of properties
- * which end with <code>[index]</code>
+ * which end with {@code [index]}
* </p>
* <pre>
* daemon.arg[0] = argument 1
