diff --git a/cli/src/main/java/hudson/cli/PrivateKeyProvider.java b/cli/src/main/java/hudson/cli/PrivateKeyProvider.java index d7753a750498aff78325fc04326eb63b7e45209d..9f87dd4a7b38a174229ccfc02b04779b51002951 100644 --- a/cli/src/main/java/hudson/cli/PrivateKeyProvider.java +++ b/cli/src/main/java/hudson/cli/PrivateKeyProvider.java @@ -71,7 +71,7 @@ public class PrivateKeyProvider { /** * Read keys from default keyFiles * - * .ssh/id_rsa, .ssh/id_dsa and .ssh/identity. + * {@code .ssh/id_rsa}, {@code .ssh/id_dsa} and {@code .ssh/identity}. * * @return true if some key was read successfully. */ diff --git a/core/src/main/java/hudson/CopyOnWrite.java b/core/src/main/java/hudson/CopyOnWrite.java index efe21357c4405e122651a284c0cb4c30157fce62..891cbf04bb9ffef6d6f657d05eb4708d94fa0f5e 100644 --- a/core/src/main/java/hudson/CopyOnWrite.java +++ b/core/src/main/java/hudson/CopyOnWrite.java @@ -43,7 +43,7 @@ import java.lang.annotation.Target; * *
* The field marked with this annotation usually needs to be marked as - * volatile. + * {@code volatile}. * * @author Kohsuke Kawaguchi */ diff --git a/core/src/main/java/hudson/EnvVars.java b/core/src/main/java/hudson/EnvVars.java index 1849ecbf66aebaf6ca6a4df5ce197b5b825c8b36..a4d581802e3401b873fa37cd506dedb3fb284b64 100644 --- a/core/src/main/java/hudson/EnvVars.java +++ b/core/src/main/java/hudson/EnvVars.java @@ -54,7 +54,7 @@ import javax.annotation.Nonnull; * but case insensitive way (that is, cmd.exe can get both FOO and foo as environment variables * when it's launched, and the "set" command will display it accordingly, but "echo %foo%" results in * echoing the value of "FOO", not "foo" — this is presumably caused by the behavior of the underlying - * Win32 API GetEnvironmentVariable acting in case insensitive way.) Windows users are also + * Win32 API {@code GetEnvironmentVariable} acting in case insensitive way.) Windows users are also * used to write environment variable case-insensitively (like %Path% vs %PATH%), and you can see many * documents on the web that claims Windows environment variables are case insensitive. * @@ -65,10 +65,10 @@ import javax.annotation.Nonnull; *
* In Jenkins, often we need to build up "environment variable overrides"
* on master, then to execute the process on agents. This causes a problem
- * when working with variables like PATH. So to make this work,
- * we introduce a special convention PATH+FOO — all entries
- * that starts with PATH+ are merged and prepended to the inherited
- * PATH variable, on the process where a new process is executed.
+ * when working with variables like {@code PATH}. So to make this work,
+ * we introduce a special convention {@code PATH+FOO} — all entries
+ * that starts with {@code PATH+} are merged and prepended to the inherited
+ * {@code PATH} variable, on the process where a new process is executed.
*
* @author Kohsuke Kawaguchi
*/
@@ -107,7 +107,7 @@ public class EnvVars extends TreeMap
- * Handles PATH+XYZ notation.
+ * Handles {@code PATH+XYZ} notation.
*/
public void override(String key, String value) {
if(value==null || value.length()==0) {
diff --git a/core/src/main/java/hudson/FileSystemProvisionerDescriptor.java b/core/src/main/java/hudson/FileSystemProvisionerDescriptor.java
index 1e02e11f7f4dfdbedf2f00b853535725c1d43f86..9e162d666feb466d4487911fb4b2b2cdbd81a99a 100644
--- a/core/src/main/java/hudson/FileSystemProvisionerDescriptor.java
+++ b/core/src/main/java/hudson/FileSystemProvisionerDescriptor.java
@@ -50,12 +50,12 @@ public abstract class FileSystemProvisionerDescriptor extends Descriptor
* If the workspace isn't the one created by this {@link FileSystemProvisioner}, or if the
* workspace can be simply deleted by {@link FilePath#deleteRecursive()}, then simply
- * return false to give other {@link FileSystemProvisionerDescriptor}s a chance to
+ * return {@code false} to give other {@link FileSystemProvisionerDescriptor}s a chance to
* discard them.
*
* @param ws
diff --git a/core/src/main/java/hudson/Functions.java b/core/src/main/java/hudson/Functions.java
index e18264f914ab965bc1a4c7c69d47805b5608d44c..ef2a7671a3f777f5f6a4b6c849b40799857ae636 100644
--- a/core/src/main/java/hudson/Functions.java
+++ b/core/src/main/java/hudson/Functions.java
@@ -396,11 +396,11 @@ public class Functions {
* is chosen, this part remains intact.
*
*
- * The 524 is the path from {@link Job} to {@link Run}.
+ * The {@code 524} is the path from {@link Job} to {@link Run}.
*
*
- * The bbb portion is the path after that till the last
- * {@link Run} subtype. The ccc portion is the part
+ * The {@code bbb} portion is the path after that till the last
+ * {@link Run} subtype. The {@code ccc} portion is the part
* after that.
*/
public static final class RunUrl {
@@ -618,7 +618,7 @@ public class Functions {
private static final SimpleFormatter formatter = new SimpleFormatter();
/**
- * Used by layout.jelly to control the auto refresh behavior.
+ * Used by {@code layout.jelly} to control the auto refresh behavior.
*
* @param noAutoRefresh
* On certain pages, like a page with forms, will have annoying interference
@@ -772,7 +772,7 @@ public class Functions {
}
/**
- * This version is so that the 'checkPermission' on layout.jelly
+ * This version is so that the 'checkPermission' on {@code layout.jelly}
* degrades gracefully if "it" is not an {@link AccessControlled} object.
* Otherwise it will perform no check and that problem is hard to notice.
*/
@@ -1693,7 +1693,7 @@ public class Functions {
/**
* Obtains the host name of the Hudson server that clients can use to talk back to.
*
- * This is primarily used in slave-agent.jnlp.jelly to specify the destination
+ * This is primarily used in {@code slave-agent.jnlp.jelly} to specify the destination
* that the agents talk to.
*/
public String getServerName() {
@@ -1746,7 +1746,7 @@ public class Functions {
/**
* If the given href link is matching the current page, return true.
*
- * Used in task.jelly to decide if the page should be highlighted.
+ * Used in {@code task.jelly} to decide if the page should be highlighted.
*/
public boolean hyperlinkMatchesCurrentPage(String href) throws UnsupportedEncodingException {
String url = Stapler.getCurrentRequest().getRequestURL().toString();
diff --git a/core/src/main/java/hudson/Indenter.java b/core/src/main/java/hudson/Indenter.java
index c1f6971b6540a6b66c36f34e0378b605835bd290..aa4348b57a9bbc54b2a5b89fe272e4ed663562c5 100644
--- a/core/src/main/java/hudson/Indenter.java
+++ b/core/src/main/java/hudson/Indenter.java
@@ -26,7 +26,7 @@ package hudson;
import hudson.model.Job;
/**
- * Used by projectView.jelly to indent modules.
+ * Used by {@code projectView.jelly} to indent modules.
*
* @author Kohsuke Kawaguchi
*/
diff --git a/core/src/main/java/hudson/Launcher.java b/core/src/main/java/hudson/Launcher.java
index 5932cef9ef0920c95debdca7ed5771cba0b25b46..0c14a4bbdd2c61b6f55c2099f07aa0720c24cd84 100644
--- a/core/src/main/java/hudson/Launcher.java
+++ b/core/src/main/java/hudson/Launcher.java
@@ -282,7 +282,7 @@ public abstract class Launcher {
* Sets STDOUT destination.
*
* @param out Output stream.
- * Use {@code null} to send STDOUT to /dev/null.
+ * Use {@code null} to send STDOUT to {@code /dev/null}.
* @return {@code this}
*/
public ProcStarter stdout(@CheckForNull OutputStream out) {
@@ -334,7 +334,7 @@ public abstract class Launcher {
/**
* Controls where the stdin of the process comes from.
- * By default, /dev/null.
+ * By default, {@code /dev/null}.
*
* @return {@code this}
*/
diff --git a/core/src/main/java/hudson/Plugin.java b/core/src/main/java/hudson/Plugin.java
index 7455099ad8de377f7459f15ac8e43cf9a240c37b..2f065102becc4c8a3a247a9869a6ebb8a0150844 100644
--- a/core/src/main/java/hudson/Plugin.java
+++ b/core/src/main/java/hudson/Plugin.java
@@ -62,20 +62,20 @@ import jenkins.model.GlobalConfiguration;
* to plugin functionality.
*
*
- * A plugin is bound to URL space of Hudson as ${rootURL}/plugin/foo/,
+ * A plugin is bound to URL space of Hudson as {@code ${rootURL}/plugin/foo/},
* where "foo" is taken from your plugin name "foo.jpi". All your web resources
* in src/main/webapp are visible from this URL, and you can also define Jelly
* views against your Plugin class, and those are visible in this URL, too.
*
*
- * {@link Plugin} can have an optional config.jelly page. If present,
+ * {@link Plugin} can have an optional {@code config.jelly} page. If present,
* it will become a part of the system configuration page (http://server/hudson/configure).
* This is convenient for exposing/maintaining configuration that doesn't
* fit any {@link Descriptor}s.
*
*
* Up until Hudson 1.150 or something, subclasses of {@link Plugin} required
- * @plugin javadoc annotation, but that is no longer a requirement.
+ * {@code @plugin} javadoc annotation, but that is no longer a requirement.
*
* @author Kohsuke Kawaguchi
* @since 1.42
@@ -194,11 +194,11 @@ public abstract class Plugin implements Saveable {
* Handles the submission for the system configuration.
*
*
- * If this class defines config.jelly view, be sure to
+ * If this class defines {@code config.jelly} view, be sure to
* override this method and persists the submitted values accordingly.
*
*
- * The following is a sample config.jelly that you can start yours with:
+ * The following is a sample {@code config.jelly} that you can start yours with:
*
- * A plug-in is packaged into a jar file whose extension is ".jpi" (or ".hpi" for backward compatibility),
+ * A plug-in is packaged into a jar file whose extension is {@code ".jpi"} (or {@code ".hpi"} for backward compatibility),
* A plugin needs to have a special manifest entry to identify what it is.
*
*
@@ -126,7 +126,7 @@ public class PluginWrapper implements Comparable
* Unlike shell, undefined variables are left as-is (this behavior is the same as Ant.)
@@ -150,7 +150,7 @@ public class Util {
}
/**
- * Replaces the occurrence of '$key' by resolver.get('key').
+ * Replaces the occurrence of '$key' by {@code resolver.get('key')}.
*
*
* Unlike shell, undefined variables are left as-is (this behavior is the same as Ant.)
diff --git a/core/src/main/java/hudson/XmlFile.java b/core/src/main/java/hudson/XmlFile.java
index e2db72a3654140a61f56af3513792b3b12a055d3..7f630dfb33dc23bf1021ae16f0a0cfd081a82f7a 100644
--- a/core/src/main/java/hudson/XmlFile.java
+++ b/core/src/main/java/hudson/XmlFile.java
@@ -72,12 +72,12 @@ import org.apache.commons.io.IOUtils;
* not have any data, the newly added field is left to the VM-default
* value (if you let XStream create the object, such as
* {@link #read()} — which is the majority), or to the value initialized by the
- * constructor (if the object is created via new and then its
+ * constructor (if the object is created via {@code new} and then its
* value filled by XStream, such as {@link #unmarshal(Object)}.)
*
*
* Removing a field requires that you actually leave the field with
- * transient keyword. When you read the old XML, XStream
+ * {@code transient} keyword. When you read the old XML, XStream
* will set the value to this field. But when the data is saved,
* the field will no longer will be written back to XML.
* (It might be possible to tweak XStream so that we can simply
@@ -85,13 +85,13 @@ import org.apache.commons.io.IOUtils;
*
*
* Changing the data structure is usually a combination of the two
- * above. You'd leave the old data store with transient,
+ * above. You'd leave the old data store with {@code transient},
* and then add the new data. When you are reading the old XML,
* only the old field will be set. When you are reading the new XML,
* only the new field will be set. You'll then need to alter the code
* so that it will be able to correctly handle both situations,
* and that as soon as you see data in the old field, you'll have to convert
- * that into the new data structure, so that the next save operation
+ * that into the new data structure, so that the next {@code save} operation
* will write the new data (otherwise you'll end up losing the data, because
* old fields will be never written back.)
*
@@ -154,7 +154,7 @@ public final class XmlFile {
* Loads the contents of this file into an existing object.
*
* @return
- * The unmarshalled object. Usually the same as o, but would be different
+ * The unmarshalled object. Usually the same as {@code o}, but would be different
* if the XML representation is completely new.
*/
public Object unmarshal( Object o ) throws IOException {
diff --git a/core/src/main/java/hudson/cli/CLICommand.java b/core/src/main/java/hudson/cli/CLICommand.java
index 3593ebf259690b37474dbc07a9cdd7c1f47970cb..91d88118d1dcf99ca57a3bdc407c010e509b3d74 100644
--- a/core/src/main/java/hudson/cli/CLICommand.java
+++ b/core/src/main/java/hudson/cli/CLICommand.java
@@ -84,7 +84,7 @@ import javax.annotation.Nonnull;
*
* The users starts {@linkplain CLI the "CLI agent"} on a remote system, by specifying arguments, like
- * "java -jar jenkins-cli.jar command arg1 arg2 arg3". The CLI agent creates
+ * {@code "java -jar jenkins-cli.jar command arg1 arg2 arg3"}. The CLI agent creates
* a remoting channel with the server, and it sends the entire arguments to the server, along with
* the remoted stdin/out/err.
*
@@ -183,7 +183,7 @@ public abstract class CLICommand implements ExtensionPoint, Cloneable {
* Gets the command name.
*
*
- * For example, if the CLI is invoked as java -jar cli.jar foo arg1 arg2 arg4,
+ * For example, if the CLI is invoked as {@code java -jar cli.jar foo arg1 arg2 arg4},
* on the server side {@link CLICommand} that returns "foo" from {@link #getName()}
* will be invoked.
*
diff --git a/core/src/main/java/hudson/cli/declarative/CLIMethod.java b/core/src/main/java/hudson/cli/declarative/CLIMethod.java
index d4e6c96ed4c2bf762a415b15297d9e764a7038ce..6366e4409ed667f116f64c06af8f37e9fd38d230 100644
--- a/core/src/main/java/hudson/cli/declarative/CLIMethod.java
+++ b/core/src/main/java/hudson/cli/declarative/CLIMethod.java
@@ -38,8 +38,8 @@ import java.lang.annotation.Target;
* Annotates methods on model objects to expose them as CLI commands.
*
*
- * You need to have Messages.properties in the same package with the
- * CLI.command-name.shortDescription key to describe the command.
+ * You need to have {@code Messages.properties} in the same package with the
+ * {@code CLI.command-name.shortDescription} key to describe the command.
* This is used for the same purpose as {@link CLICommand#getShortDescription()}.
*
*
diff --git a/core/src/main/java/hudson/cli/declarative/CLIResolver.java b/core/src/main/java/hudson/cli/declarative/CLIResolver.java
index 2b31b47f2790f61d9c4b93ec142a0e6611b53967..5c4b93444e8e27f5ece3869135317d5b97a3616c 100644
--- a/core/src/main/java/hudson/cli/declarative/CLIResolver.java
+++ b/core/src/main/java/hudson/cli/declarative/CLIResolver.java
@@ -40,12 +40,12 @@ import java.lang.annotation.Target;
*
* Hudson uses the return type of the resolver method
* to pick the resolver method to use, of all the resolver methods it discovers. That is,
- * if Hudson is looking to find an instance of type T for the current command, it first
- * looks for the resolver method whose return type is T, then it checks for the base type of T,
+ * if Hudson is looking to find an instance of type {@code T} for the current command, it first
+ * looks for the resolver method whose return type is {@code T}, then it checks for the base type of {@code T},
* and so on.
*
*
- * If the chosen resolver method is an instance method on type S, the "parent resolver" is then
+ * If the chosen resolver method is an instance method on type {@code S}, the "parent resolver" is then
* located to resolve an instance of type 'S'. This process repeats until a static resolver method is discovered
* (since most of Hudson's model objects are anchored to the root {@link jenkins.model.Jenkins} object, normally that would become
* the top-most resolver method.)
diff --git a/core/src/main/java/hudson/cli/handlers/ViewOptionHandler.java b/core/src/main/java/hudson/cli/handlers/ViewOptionHandler.java
index e1888db0e1a3111666d8c6bc97a903cd3bf1151c..6107855812c3de7b8b16c35dd1fd8f6b1c836b2f 100644
--- a/core/src/main/java/hudson/cli/handlers/ViewOptionHandler.java
+++ b/core/src/main/java/hudson/cli/handlers/ViewOptionHandler.java
@@ -48,7 +48,7 @@ import javax.annotation.CheckForNull;
* For example:
*
diff --git a/core/src/main/java/hudson/console/ConsoleAnnotatorFactory.java b/core/src/main/java/hudson/console/ConsoleAnnotatorFactory.java
index f71b25e53edccf2497f08da4ef06a3779b243c2c..f9feac4a95a6d427c1506c56a9b8dbf416f808b0 100644
--- a/core/src/main/java/hudson/console/ConsoleAnnotatorFactory.java
+++ b/core/src/main/java/hudson/console/ConsoleAnnotatorFactory.java
@@ -58,7 +58,7 @@ import java.net.URL;
*
*
- * {@link ConsoleNote} can have associated script.js and style.css (put them
+ * {@link ConsoleNote} can have associated {@code script.js} and {@code style.css} (put them
* in the same resource directory that you normally put Jelly scripts), which will be loaded into
* the HTML page whenever the console notes are used. This allows you to use minimal markup in
* code generation, and do the styling in CSS and perform the rest of the interesting work as a CSS behaviour/JavaScript.
diff --git a/core/src/main/java/hudson/console/ConsoleNote.java b/core/src/main/java/hudson/console/ConsoleNote.java
index 165e6d9ae7f469a726866a80a51599f7fc56bbe4..a572a966b614a2b8f10b451ecd8ae696eab6cbc2 100644
--- a/core/src/main/java/hudson/console/ConsoleNote.java
+++ b/core/src/main/java/hudson/console/ConsoleNote.java
@@ -109,7 +109,7 @@ import org.jenkinsci.remoting.util.AnonymousClassWarnings;
*
*
- * {@link ConsoleNote} can have associated script.js and style.css (put them
+ * {@link ConsoleNote} can have associated {@code script.js} and {@code style.css} (put them
* in the same resource directory that you normally put Jelly scripts), which will be loaded into
* the HTML page whenever the console notes are used. This allows you to use minimal markup in
* code generation, and do the styling in CSS and perform the rest of the interesting work as a CSS behaviour/JavaScript.
diff --git a/core/src/main/java/hudson/diagnosis/HudsonHomeDiskUsageChecker.java b/core/src/main/java/hudson/diagnosis/HudsonHomeDiskUsageChecker.java
index 3d842e1d79c5b9bf9535339a4952abd5876c3ee2..56eaf7d941a0f281dd45a3f219204fce04719353 100644
--- a/core/src/main/java/hudson/diagnosis/HudsonHomeDiskUsageChecker.java
+++ b/core/src/main/java/hudson/diagnosis/HudsonHomeDiskUsageChecker.java
@@ -31,7 +31,7 @@ import org.jenkinsci.Symbol;
import java.util.logging.Logger;
/**
- * Periodically checks the disk usage of JENKINS_HOME,
+ * Periodically checks the disk usage of {@code JENKINS_HOME},
* and activate {@link HudsonHomeDiskUsageMonitor} if necessary.
*
* @author Kohsuke Kawaguchi
diff --git a/core/src/main/java/hudson/diagnosis/HudsonHomeDiskUsageMonitor.java b/core/src/main/java/hudson/diagnosis/HudsonHomeDiskUsageMonitor.java
index 337f739dcb827d0d718d83208ff47cc909bf6b00..177141f746fa872774cc63aa1adea6d8fd52cd1b 100644
--- a/core/src/main/java/hudson/diagnosis/HudsonHomeDiskUsageMonitor.java
+++ b/core/src/main/java/hudson/diagnosis/HudsonHomeDiskUsageMonitor.java
@@ -38,7 +38,7 @@ import java.io.IOException;
import java.util.List;
/**
- * Monitors the disk usage of JENKINS_HOME, and if it's almost filled up, warn the user.
+ * Monitors the disk usage of {@code JENKINS_HOME}, and if it's almost filled up, warn the user.
*
* @author Kohsuke Kawaguchi
*/
diff --git a/core/src/main/java/hudson/init/Initializer.java b/core/src/main/java/hudson/init/Initializer.java
index d41f45da52edba6cc1637d7c33f0bfb4eee50c29..d24a412ae8a30e5d6dacd61f56924e6646aeabd2 100644
--- a/core/src/main/java/hudson/init/Initializer.java
+++ b/core/src/main/java/hudson/init/Initializer.java
@@ -92,7 +92,7 @@ public @interface Initializer {
String[] attains() default {};
/**
- * Key in Messages.properties that represents what this task is about. Used for rendering the progress.
+ * Key in {@code Messages.properties} that represents what this task is about. Used for rendering the progress.
* Defaults to "${short class name}.${method Name}".
*/
String displayName() default "";
diff --git a/core/src/main/java/hudson/init/Terminator.java b/core/src/main/java/hudson/init/Terminator.java
index 3e1155babdcfee7954b507a33d93d81fd4a24be9..24bc781fb10a1d5ef8f2a037a8c5b2ef9eb51202 100644
--- a/core/src/main/java/hudson/init/Terminator.java
+++ b/core/src/main/java/hudson/init/Terminator.java
@@ -52,7 +52,7 @@ public @interface Terminator {
String[] attains() default {};
/**
- * Key in Messages.properties that represents what this task is about. Used for rendering the progress.
+ * Key in {@code Messages.properties} that represents what this task is about. Used for rendering the progress.
* Defaults to "${short class name}.${method Name}".
*/
String displayName() default "";
diff --git a/core/src/main/java/hudson/init/package-info.java b/core/src/main/java/hudson/init/package-info.java
index 9833d2090ec5adc3f1444d1a8828a2a9f1f519c9..5f66063ca3b2ef245b9491cdf4488513d8421b9d 100644
--- a/core/src/main/java/hudson/init/package-info.java
+++ b/core/src/main/java/hudson/init/package-info.java
@@ -33,7 +33,7 @@
*
*
* Such micro-scopic dependencies are organized into a bigger directed acyclic graph, which is then executed
- * via Session. During execution of the reactor, additional tasks can be discovered and added to
+ * via {@code Session}. During execution of the reactor, additional tasks can be discovered and added to
* the DAG. We use this additional indirection to:
*
*
@@ -131,7 +131,7 @@ public abstract class Lifecycle implements ExtensionPoint {
*
*
* On some system, most notably Windows, a file being in use cannot be changed,
- * so rewriting jenkins.war requires some special trick. Override this method
+ * so rewriting {@code jenkins.war} requires some special trick. Override this method
* to do so.
*/
public void rewriteHudsonWar(File by) throws IOException {
diff --git a/core/src/main/java/hudson/lifecycle/WindowsServiceLifecycle.java b/core/src/main/java/hudson/lifecycle/WindowsServiceLifecycle.java
index 42519eb21b0b2dc090df02b2331cc928b1e0af61..ad3940b4a4feab58375654f6a0f0bb870c18ad1b 100644
--- a/core/src/main/java/hudson/lifecycle/WindowsServiceLifecycle.java
+++ b/core/src/main/java/hudson/lifecycle/WindowsServiceLifecycle.java
@@ -54,7 +54,7 @@ public class WindowsServiceLifecycle extends Lifecycle {
}
/**
- * If jenkins.exe is old compared to our copy,
+ * If {@code jenkins.exe} is old compared to our copy,
* schedule an overwrite (except that since it's currently running,
* we can only do it when Jenkins restarts next time.)
*/
diff --git a/core/src/main/java/hudson/markup/MarkupFormatter.java b/core/src/main/java/hudson/markup/MarkupFormatter.java
index d722fb6aa248854296df770cdfb58f0af6e9e425..be8004136ab2646a9ea2c7627643ebd778404548 100644
--- a/core/src/main/java/hudson/markup/MarkupFormatter.java
+++ b/core/src/main/java/hudson/markup/MarkupFormatter.java
@@ -51,7 +51,7 @@ import org.kohsuke.stapler.QueryParameter;
*
*
- * This extension point must have a valid config.jelly that feeds the constructor.
+ * This extension point must have a valid {@code config.jelly} that feeds the constructor.
*
* TODO: allow {@link MarkupFormatter} to control the UI that the user uses to edit.
*
diff --git a/core/src/main/java/hudson/model/AbstractBuild.java b/core/src/main/java/hudson/model/AbstractBuild.java
index 0f49ac47f36cb54fcf5d3429e11005826fdf0078..2268f3dd9967c69df673fede3e6bf159c59a28dd 100644
--- a/core/src/main/java/hudson/model/AbstractBuild.java
+++ b/core/src/main/java/hudson/model/AbstractBuild.java
@@ -297,7 +297,7 @@ public abstract class AbstractBuild ,R extends Abs
/**
* Returns the root directory of the checked-out module.
*
- * This is usually where pom.xml, build.xml
+ * This is usually where {@code pom.xml}, {@code build.xml}
* and so on exists.
*/
public final FilePath getModuleRoot() {
diff --git a/core/src/main/java/hudson/model/AbstractItem.java b/core/src/main/java/hudson/model/AbstractItem.java
index 23f1ccb270bc2c6a1edb969e50047f050231f244..aced1805e5af4c2fccb24c313c3fa1882d6d4533 100644
--- a/core/src/main/java/hudson/model/AbstractItem.java
+++ b/core/src/main/java/hudson/model/AbstractItem.java
@@ -790,7 +790,7 @@ public abstract class AbstractItem extends Actionable implements Item, HttpDelet
}
/**
- * Accepts config.xml submission, as well as serve it.
+ * Accepts {@code config.xml} submission, as well as serve it.
*/
@WebMethod(name = "config.xml")
public void doConfigDotXml(StaplerRequest req, StaplerResponse rsp)
diff --git a/core/src/main/java/hudson/model/AbstractProject.java b/core/src/main/java/hudson/model/AbstractProject.java
index 1cb3fcfbc7799ec3226ef09074071c25450ae3b1..3b60e8618519d41c5dc5b6a23a357377296d1d6a 100644
--- a/core/src/main/java/hudson/model/AbstractProject.java
+++ b/core/src/main/java/hudson/model/AbstractProject.java
@@ -573,7 +573,7 @@ public abstract class AbstractProject ,R extends A
/**
* Returns the root directory of the checked-out module.
*
- * This is usually where pom.xml, build.xml
+ * This is usually where {@code pom.xml}, {@code build.xml}
* and so on exists.
*
* @deprecated as of 1.319
@@ -642,7 +642,7 @@ public abstract class AbstractProject ,R extends A
}
/**
- * Used in sidepanel.jelly to decide whether to display
+ * Used in {@code sidepanel.jelly} to decide whether to display
* the config/delete/build links.
*/
public boolean isConfigurable() {
@@ -751,7 +751,7 @@ public abstract class AbstractProject ,R extends A
* Returns the live list of all {@link Publisher}s configured for this project.
*
*
- * This method couldn't be called getPublishers() because existing methods
+ * This method couldn't be called {@code getPublishers()} because existing methods
* in sub-classes return different inconsistent types.
*/
public abstract DescribableList
* Some actions use the latter without the former (for example, to add a link to an external website),
- * while others do the former without the latter (for example, to just draw some graphs in floatingBox.jelly),
+ * while others do the former without the latter (for example, to just draw some graphs in {@code floatingBox.jelly}),
* and still some others do both.
*
*
- * If an action has a view named floatingBox.jelly,
+ * If an action has a view named {@code floatingBox.jelly},
* it will be displayed as a floating box on the top page of
* the target {@link ModelObject}. (For example, this is how
* the JUnit test result trend shows up in the project top page.
@@ -82,7 +82,7 @@ public interface Action extends ModelObject {
*
* @return
* If just a file name (like "abc.gif") is returned, it will be
- * interpreted as a file name inside /images/24x24.
+ * interpreted as a file name inside {@code /images/24x24}.
* This is useful for using one of the stock images.
*
* If an absolute file name that starts from '/' is returned (like
@@ -91,7 +91,7 @@ public interface Action extends ModelObject {
* image files from a plugin.
*
* Finally, return null to hide it from the task list. This is normally not very useful,
- * but this can be used for actions that only contribute floatBox.jelly
+ * but this can be used for actions that only contribute {@code floatBox.jelly}
* and no task list item. The other case where this is useful is
* to avoid showing links that require a privilege when the user is anonymous.
* @see Functions#isAnonymous()
diff --git a/core/src/main/java/hudson/model/AdministrativeMonitor.java b/core/src/main/java/hudson/model/AdministrativeMonitor.java
index 537f6d092ce63dd90cac459c1efb2da031ca2f71..ce81dd56aa3d1b01c52ed72386d1cec6769f5f61 100644
--- a/core/src/main/java/hudson/model/AdministrativeMonitor.java
+++ b/core/src/main/java/hudson/model/AdministrativeMonitor.java
@@ -65,9 +65,9 @@ import org.kohsuke.stapler.interceptor.RequirePOST;
*
- * If the parent object has a _api.jelly view, it will be included
+ * If the parent object has a {@code _api.jelly} view, it will be included
* in the api index page.
*
* @author Kohsuke Kawaguchi
diff --git a/core/src/main/java/hudson/model/BuildBadgeAction.java b/core/src/main/java/hudson/model/BuildBadgeAction.java
index fe35eddd6052cea7c00489eea24e502c4a78378d..3a673f95583521e29e904342ca2a09c148e55cd2 100644
--- a/core/src/main/java/hudson/model/BuildBadgeAction.java
+++ b/core/src/main/java/hudson/model/BuildBadgeAction.java
@@ -32,7 +32,7 @@ package hudson.model;
* with {@link Run}.
*
*
- * Actions with this marker should have a view badge.jelly,
+ * Actions with this marker should have a view {@code badge.jelly},
* which will be called to render the badges. The expected visual appearance
* of a badge is a 16x16 icon.
*
diff --git a/core/src/main/java/hudson/model/Computer.java b/core/src/main/java/hudson/model/Computer.java
index 924aa27ff2a205a29fff532bbf279c310e72b08a..641d82fc27ea758fd2087abd86a19205adff31f7 100644
--- a/core/src/main/java/hudson/model/Computer.java
+++ b/core/src/main/java/hudson/model/Computer.java
@@ -1493,7 +1493,7 @@ public /*transient*/ abstract class Computer extends Actionable implements Acces
}
/**
- * Accepts config.xml submission, as well as serve it.
+ * Accepts {@code config.xml} submission, as well as serve it.
*/
@WebMethod(name = "config.xml")
public void doConfigDotXml(StaplerRequest req, StaplerResponse rsp)
diff --git a/core/src/main/java/hudson/model/Descriptor.java b/core/src/main/java/hudson/model/Descriptor.java
index f8e4c2cfeb2e89efbb9a8515beeea701a84b18b2..d51edc0c397ea44a8395ec4108c6e3c09fbc0e46 100644
--- a/core/src/main/java/hudson/model/Descriptor.java
+++ b/core/src/main/java/hudson/model/Descriptor.java
@@ -538,7 +538,7 @@ public abstract class Descriptor
- * Hudson only invokes this method when the user wants an instance of T.
+ * Hudson only invokes this method when the user wants an instance of {@code T}.
* So there's no need to check that in the implementation.
*
*
@@ -714,9 +714,9 @@ public abstract class Descriptor
* This value is relative to the context root of Hudson, so normally
- * the values are something like "/plugin/emma/help.html" to
- * refer to static resource files in a plugin, or "/publisher/EmmaPublisher/abc"
- * to refer to Jelly script abc.jelly or a method EmmaPublisher.doAbc().
+ * the values are something like {@code "/plugin/emma/help.html"} to
+ * refer to static resource files in a plugin, or {@code "/publisher/EmmaPublisher/abc"}
+ * to refer to Jelly script {@code abc.jelly} or a method {@code EmmaPublisher.doAbc()}.
*
* @return
* null to indicate that there's no help.
@@ -915,7 +915,7 @@ public abstract class Descriptor
- * Configuration screen should be defined in config.jelly.
+ * Configuration screen should be defined in {@code config.jelly}.
* Within this page, the {@link JobProperty} instance is available
- * as instance variable (while it refers to {@link Job}.
+ * as {@code instance} variable (while {@code it} refers to {@link Job}.
*
*
* Starting 1.150, {@link JobProperty} implements {@link BuildStep},
diff --git a/core/src/main/java/hudson/model/ManagementLink.java b/core/src/main/java/hudson/model/ManagementLink.java
index 041fda35d05ef0b18b8405a21701236517205813..00d6871097cc66730ad6a50caa3bb3d3bf15b67a 100644
--- a/core/src/main/java/hudson/model/ManagementLink.java
+++ b/core/src/main/java/hudson/model/ManagementLink.java
@@ -37,7 +37,7 @@ import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;
/**
- * Extension point to add icon to http://server/hudson/manage page.
+ * Extension point to add icon to {@code http://server/hudson/manage} page.
*
*
* This is a place for exposing features that are only meant for system admins
diff --git a/core/src/main/java/hudson/model/ModelObject.java b/core/src/main/java/hudson/model/ModelObject.java
index 5467b2a7a77e6e02ec2b073148d670ce55a92f3f..166a2cbcf2f20cf0469a77d602d15226e677e7fd 100644
--- a/core/src/main/java/hudson/model/ModelObject.java
+++ b/core/src/main/java/hudson/model/ModelObject.java
@@ -27,7 +27,7 @@ package hudson.model;
* A model object has a human readable name.
*
* And it normally has URL, but this interface doesn't define one.
- * (Since there're so many classes that define the getUrl method
+ * (Since there're so many classes that define the {@code getUrl} method
* we should have such one.)
*
* @author Kohsuke Kawaguchi
diff --git a/core/src/main/java/hudson/model/ParameterDefinition.java b/core/src/main/java/hudson/model/ParameterDefinition.java
index fa08b2f0f24ddd71bdb1ac1bcc3d5c8481f0dbe6..d535a90a051433cb5050b96730e05404a1a0f1e4 100644
--- a/core/src/main/java/hudson/model/ParameterDefinition.java
+++ b/core/src/main/java/hudson/model/ParameterDefinition.java
@@ -75,18 +75,18 @@ import org.kohsuke.stapler.export.ExportedBean;
*
*
- * Instances of {@link ParameterDefinition}s are persisted into job config.xml
+ * Instances of {@link ParameterDefinition}s are persisted into job {@code config.xml}
* through XStream.
*
*
*
- * Instances of {@link ParameterValue}s are persisted into build's build.xml
+ * Instances of {@link ParameterValue}s are persisted into build's {@code build.xml}
* through XStream (via {@link ParametersAction}), so instances need to be persistable.
*
*
- * This class also implements {@link Action} so that index.jelly provides
+ * This class also implements {@link Action} so that {@code index.jelly} provides
* a form to enter build parameters.
* The owning job needs a {@code sidepanel.jelly} and should have web methods delegating to {@link ParameterizedJobMixIn#doBuild} and {@link ParameterizedJobMixIn#doBuildWithParameters}.
* The builds also need a {@code sidepanel.jelly}.
diff --git a/core/src/main/java/hudson/model/Queue.java b/core/src/main/java/hudson/model/Queue.java
index 121e3e6f304d7d355abce801d32845c4c81b3ac9..01a43ea299875e51da3eaadb4a4097d5b87f10d1 100644
--- a/core/src/main/java/hudson/model/Queue.java
+++ b/core/src/main/java/hudson/model/Queue.java
@@ -2004,7 +2004,7 @@ public class Queue extends ResourceController implements Saveable {
*
*
- * Implementation must have executorCell.jelly, which is
+ * Implementation must have {@code executorCell.jelly}, which is
* used to render the HTML that indicates this executable is executing.
*/
public interface Executable extends Runnable {
@@ -3036,7 +3036,7 @@ public class Queue extends ResourceController implements Saveable {
}
/**
- * Schedule Queue.save() call for near future once items change. Ignore all changes until the time the save
+ * Schedule {@code Queue.save()} call for near future once items change. Ignore all changes until the time the save
* takes place.
*
* Once queue is restored after a crash, items stages might not be accurate until the next #maintain() - this is not
diff --git a/core/src/main/java/hudson/model/Run.java b/core/src/main/java/hudson/model/Run.java
index ffceeebfb7d2c3742fbcac060717b9d1a68fa949..3fc6905f507ddaed72980e42b8e2c33608e09d62 100644
--- a/core/src/main/java/hudson/model/Run.java
+++ b/core/src/main/java/hudson/model/Run.java
@@ -1471,7 +1471,7 @@ public abstract class Run
- * Ideally this would have been in the hudson.slaves package,
+ * Ideally this would have been in the {@code hudson.slaves} package,
* but for compatibility reasons, it can't.
*
*
diff --git a/core/src/main/java/hudson/model/TopLevelItemDescriptor.java b/core/src/main/java/hudson/model/TopLevelItemDescriptor.java
index ff5101faa8ec7854e9ef2219942a7a129b966ff6..91488a22cc72f833f45322dd68704dfb0f4e473f 100644
--- a/core/src/main/java/hudson/model/TopLevelItemDescriptor.java
+++ b/core/src/main/java/hudson/model/TopLevelItemDescriptor.java
@@ -125,7 +125,7 @@ public abstract class TopLevelItemDescriptor extends Descriptor
* Used as the caption when the user chooses what item type to create.
- * The descriptor implementation also needs to have newInstanceDetail.jelly
+ * The descriptor implementation also needs to have {@code newInstanceDetail.jelly}
* script, which will be used to render the text below the caption
* that explains the item type.
*/
diff --git a/core/src/main/java/hudson/model/UpdateCenter.java b/core/src/main/java/hudson/model/UpdateCenter.java
index d457bd4ba221c2505531dc2728009a18485b53e7..dc43a4ef908a0f1575754bfe97ab50ec23c02279 100644
--- a/core/src/main/java/hudson/model/UpdateCenter.java
+++ b/core/src/main/java/hudson/model/UpdateCenter.java
@@ -574,7 +574,7 @@ public class UpdateCenter extends AbstractModelObject implements Saveable, OnMas
}
/**
- * Gets the {@link UpdateSite} from which we receive updates for jenkins.war.
+ * Gets the {@link UpdateSite} from which we receive updates for {@code jenkins.war}.
*
* @return
* {@code null} if no such update center is provided.
@@ -1218,8 +1218,8 @@ public class UpdateCenter extends AbstractModelObject implements Saveable, OnMas
*
* @deprecated as of 1.333
* With the introduction of multiple update center capability, this information
- * is now a part of the update-center.json file. See
- * http://jenkins-ci.org/update-center.json as an example.
+ * is now a part of the {@code update-center.json} file. See
+ * {@code http://jenkins-ci.org/update-center.json} as an example.
*/
@Deprecated
public String getConnectionCheckUrl() {
@@ -1245,7 +1245,7 @@ public class UpdateCenter extends AbstractModelObject implements Saveable, OnMas
* Returns the URL of the server that hosts plugins and core updates.
*
* @deprecated as of 1.333
- * update-center.json is now signed, so we don't have to further make sure that
+ * {@code update-center.json} is now signed, so we don't have to further make sure that
* we aren't downloading from anywhere unsecure.
*/
@Deprecated
@@ -1279,7 +1279,7 @@ public class UpdateCenter extends AbstractModelObject implements Saveable, OnMas
/**
* Things that {@link UpdateCenter#installerService} executes.
*
- * This object will have the row.jelly which renders the job on UI.
+ * This object will have the {@code row.jelly} which renders the job on UI.
*/
@ExportedBean
public abstract class UpdateCenterJob implements Runnable {
diff --git a/core/src/main/java/hudson/model/UpdateSite.java b/core/src/main/java/hudson/model/UpdateSite.java
index 0a27890a12059f7e5946b2c4e2e659ea72317193..10ccfb1508d269d7ee7b4ce540a973f498064266 100644
--- a/core/src/main/java/hudson/model/UpdateSite.java
+++ b/core/src/main/java/hudson/model/UpdateSite.java
@@ -131,7 +131,7 @@ public class UpdateSite {
private final String id;
/**
- * Path to update-center.json, like http://jenkins-ci.org/update-center.json.
+ * Path to {@code update-center.json}, like {@code http://jenkins-ci.org/update-center.json}.
*/
private final String url;
diff --git a/core/src/main/java/hudson/model/UserProperty.java b/core/src/main/java/hudson/model/UserProperty.java
index 48198a28ebbe9400139f48735b15067cf33bbfcc..ec02b1211b99d78fa15d5024b8ce69f6311fb006 100644
--- a/core/src/main/java/hudson/model/UserProperty.java
+++ b/core/src/main/java/hudson/model/UserProperty.java
@@ -41,10 +41,10 @@ import org.kohsuke.stapler.export.ExportedBean;
* configuration screen, and they are persisted with the user object.
*
*
- * Configuration screen should be defined in config.jelly.
+ * Configuration screen should be defined in {@code config.jelly}.
* Within this page, the {@link UserProperty} instance is available
- * as instance variable (while it refers to {@link User}.
- * See {@link hudson.search.UserSearchProperty}'s config.jelly for an example.
+ * as {@code instance} variable (while {@code it} refers to {@link User}.
+ * See {@link hudson.search.UserSearchProperty}'s {@code config.jelly} for an example.
* A property may also define a {@code summary.jelly} view to show in the main user screen.
*
* @author Kohsuke Kawaguchi
diff --git a/core/src/main/java/hudson/model/View.java b/core/src/main/java/hudson/model/View.java
index 50228d0647233e13b14035fbb4587df57b6766e5..cc75811fa1056613e76d8d80cab62105e6053354 100644
--- a/core/src/main/java/hudson/model/View.java
+++ b/core/src/main/java/hudson/model/View.java
@@ -134,7 +134,7 @@ import org.xml.sax.SAXException;
*
diff --git a/core/src/main/java/hudson/node_monitors/AbstractAsyncNodeMonitorDescriptor.java b/core/src/main/java/hudson/node_monitors/AbstractAsyncNodeMonitorDescriptor.java
index 05eed5fc24d638c6896c8e942ec95f982c26cd82..e35ae80a7e133c7ff6ca20b3d1344b979ced0735 100644
--- a/core/src/main/java/hudson/node_monitors/AbstractAsyncNodeMonitorDescriptor.java
+++ b/core/src/main/java/hudson/node_monitors/AbstractAsyncNodeMonitorDescriptor.java
@@ -134,16 +134,16 @@ public abstract class AbstractAsyncNodeMonitorDescriptor This can typically have a few different reasons:
* This class implements the action that tags the modules. Derived classes
- * need to provide tagForm.jelly view that displays a form for
+ * need to provide {@code tagForm.jelly} view that displays a form for
* letting user start tagging.
*
* @author Kohsuke Kawaguchi
diff --git a/core/src/main/java/hudson/scm/SCM.java b/core/src/main/java/hudson/scm/SCM.java
index 2b1e94bb11eab7f2cb954f8fcb34ae816eef8cac..b49f3f10fbcd6a11aa35d1d2bee223a6a914e1e8 100644
--- a/core/src/main/java/hudson/scm/SCM.java
+++ b/core/src/main/java/hudson/scm/SCM.java
@@ -572,7 +572,7 @@ public abstract class SCM implements Describable
* Many builders, like Ant or Maven, works off the specific user file
* at the top of the checked out module (in the above case, that would
- * be xyz/build.xml), yet the builder doesn't know the "xyz"
+ * be {@code xyz/build.xml}), yet the builder doesn't know the "xyz"
* part; that comes from SCM.
*
*
@@ -678,7 +678,7 @@ public abstract class SCM implements Describable
* When an HTTP request arrives with an HTTP basic auth header, this filter detects
- * that and emulate an invocation of /j_security_check
+ * that and emulate an invocation of {@code /j_security_check}
* (see this page for the original technique.)
*
*
* This causes the container to perform authentication, but there's no way
* to find out whether the user has been successfully authenticated or not.
* So to find this out, we then redirect the user to
- * {@link jenkins.model.Jenkins#doSecured(StaplerRequest, StaplerResponse) /secured/... page}.
+ * {@link jenkins.model.Jenkins#doSecured(StaplerRequest, StaplerResponse) {@code /secured/...} page}.
*
*
* The handler of the above URL checks if the user is authenticated,
@@ -79,7 +79,7 @@ import java.net.URLEncoder;
*
* The salt is prepended to the hashed password and returned. So the encoded password is of the form
- * SALT ':' hash(PASSWORD,SALT).
+ * {@code SALT ':' hash(PASSWORD,SALT)}.
*
*
* This abbreviates the need to store the salt separately, which in turn allows us to hide the salt handling
diff --git a/core/src/main/java/hudson/security/SecurityRealm.java b/core/src/main/java/hudson/security/SecurityRealm.java
index 5a8325b242bbe9b4cf4c8ecaed4227e72b1d50de..90d60b7deb83ab1daacacfff9243bdc02be89654 100644
--- a/core/src/main/java/hudson/security/SecurityRealm.java
+++ b/core/src/main/java/hudson/security/SecurityRealm.java
@@ -75,7 +75,7 @@ import java.util.logging.Logger;
*
*
* If additional views/URLs need to be exposed,
- * an active {@link SecurityRealm} is bound to CONTEXT_ROOT/securityRealm/
+ * an active {@link SecurityRealm} is bound to {@code CONTEXT_ROOT/securityRealm/}
* through {@link jenkins.model.Jenkins#getSecurityRealm()}, so you can define additional pages and
* operations on your {@link SecurityRealm}.
*
@@ -143,7 +143,7 @@ public abstract class SecurityRealm extends AbstractDescribableImpl
@@ -205,8 +205,8 @@ public abstract class SecurityRealm extends AbstractDescribableImpl
@@ -315,12 +315,12 @@ public abstract class SecurityRealm extends AbstractDescribableImpl
* If the implementation needs to redirect the user to a different URL
- * for signing up, use the following jelly script as signup.jelly
+ * for signing up, use the following jelly script as {@code signup.jelly}
*
*
- * This object can have an optional config.jelly to configure the Captcha Support
+ * This object can have an optional {@code config.jelly} to configure the Captcha Support
*
* A default constructor is needed to create CaptchaSupport in
* the default configuration.
diff --git a/core/src/main/java/hudson/slaves/Cloud.java b/core/src/main/java/hudson/slaves/Cloud.java
index e436441abece190c59ec24a4e4f6ed6d2f51ad8d..d9cc5f2039ea4c8f690f04e5f0d06972516da231 100644
--- a/core/src/main/java/hudson/slaves/Cloud.java
+++ b/core/src/main/java/hudson/slaves/Cloud.java
@@ -67,7 +67,7 @@ import java.util.concurrent.Future;
*
* To do this, have your {@link Slave} subtype remember the necessary handle (such as EC2 instance ID)
* as a field. Such fields need to survive the user-initiated re-configuration of {@link Slave}, so you'll need to
- * expose it in your {@link Slave} configure-entries.jelly and read it back in through {@link DataBoundConstructor}.
+ * expose it in your {@link Slave} {@code configure-entries.jelly} and read it back in through {@link DataBoundConstructor}.
*
*
* You then implement your own {@link Computer} subtype, override {@link Slave#createComputer()}, and instantiate
@@ -80,9 +80,9 @@ import java.util.concurrent.Future;
*
*
- * This object needs to have newInstanceDetail.jelly view, which shows up in
- * http://server/hudson/computers/new page as an explanation of this job type.
+ * This object needs to have {@code newInstanceDetail.jelly} view, which shows up in
+ * {@code http://server/hudson/computers/new} page as an explanation of this job type.
*
*
- * {@link OfflineCause} must have cause.jelly that renders a cause
+ * {@link OfflineCause} must have {@code cause.jelly} that renders a cause
* into HTML. This is used to tell users why the node is put offline.
* This view should render a block element like DIV.
*
diff --git a/core/src/main/java/hudson/slaves/SlaveComputer.java b/core/src/main/java/hudson/slaves/SlaveComputer.java
index 029892a2f4ac30d805de979af3c8141869c491b2..950c6b68aa90ad2a68f5f885ac4d40b0e45432f4 100644
--- a/core/src/main/java/hudson/slaves/SlaveComputer.java
+++ b/core/src/main/java/hudson/slaves/SlaveComputer.java
@@ -408,7 +408,7 @@ public class SlaveComputer extends Computer {
* Stream connected to the remote peer. It's the caller's responsibility to do
* buffering on this stream, if that's necessary.
* @param launchLog
- * If non-null, receive the portion of data in is before
+ * If non-null, receive the portion of data in {@code is} before
* the data goes into the "binary mode". This is useful
* when the established communication channel might include some data that might
* be useful for debugging/trouble-shooting.
diff --git a/core/src/main/java/hudson/tasks/BuildStep.java b/core/src/main/java/hudson/tasks/BuildStep.java
index 16f0c0268cc7223ba33c748a416a6d6070473adb..ad81455335c1db7049e11347484230207b4988ac 100644
--- a/core/src/main/java/hudson/tasks/BuildStep.java
+++ b/core/src/main/java/hudson/tasks/BuildStep.java
@@ -65,7 +65,7 @@ import jenkins.model.Jenkins;
* So generally speaking, derived classes should use instance variables
* only for keeping configuration. You can still store objects you use
* for processing, like a parser of some sort, but they need to be marked
- * as transient, and the code needs to be aware that they might
+ * as {@code transient}, and the code needs to be aware that they might
* be null (which is the case when you access the field for the first time
* the object is restored.)
*
@@ -145,7 +145,7 @@ public interface BuildStep {
* it owns when the rendering is requested.
*
*
- * This action can have optional jobMain.jelly view, which will be
+ * This action can have optional {@code jobMain.jelly} view, which will be
* aggregated into the main panel of the job top page. The jelly file
* should have an {@code
diff --git a/core/src/main/java/hudson/util/ErrorObject.java b/core/src/main/java/hudson/util/ErrorObject.java
index def3df9adb9b8b2357ad25ebc69448ef28f9e622..5d4a8593570c0b549b5a364a5bac25e0b5011e48 100644
--- a/core/src/main/java/hudson/util/ErrorObject.java
+++ b/core/src/main/java/hudson/util/ErrorObject.java
@@ -35,7 +35,7 @@ import java.io.IOException;
* Basis for error model objects.
*
* This implementation serves error pages for any requests under its domain. Subclasses are responsible for providing
- * index view.
+ * {@code index} view.
*
* @author Kohsuke Kawaguchi
*/
diff --git a/core/src/main/java/hudson/util/FormFieldValidator.java b/core/src/main/java/hudson/util/FormFieldValidator.java
index 47ba955121b9daf1f2b29e0d0e42103e040fec74..0595afa4a68a80f12ec60235467f3923f7109430 100644
--- a/core/src/main/java/hudson/util/FormFieldValidator.java
+++ b/core/src/main/java/hudson/util/FormFieldValidator.java
@@ -170,8 +170,8 @@ public abstract class FormFieldValidator {
* Sends out a string error message that indicates an error.
*
* @param message
- * Human readable message to be sent. error(null)
- * can be used as ok().
+ * Human readable message to be sent. {@code error(null)}
+ * can be used as {@code ok()}.
*/
public void error(String message) throws IOException, ServletException {
errorWithMarkup(message==null?null:Util.escape(message));
@@ -209,8 +209,8 @@ public abstract class FormFieldValidator {
* attack.
*
* @param message
- * Human readable message to be sent. error(null)
- * can be used as ok().
+ * Human readable message to be sent. {@code error(null)}
+ * can be used as {@code ok()}.
*/
public void errorWithMarkup(String message) throws IOException, ServletException {
_errorWithMarkup(message,"error");
diff --git a/core/src/main/java/hudson/util/FormFillFailure.java b/core/src/main/java/hudson/util/FormFillFailure.java
index 8fcf650b7ff9cdd183169a8d7bf04052faade015..16b8e6435a2fc918fe48a731d327694c49d16f68 100644
--- a/core/src/main/java/hudson/util/FormFillFailure.java
+++ b/core/src/main/java/hudson/util/FormFillFailure.java
@@ -40,7 +40,7 @@ import org.kohsuke.stapler.StaplerResponse;
* Represents a failure in a form field doFillXYZ method.
*
*
- * Use one of the factory methods to create an instance, then throw it from your doFillXyz
+ * Use one of the factory methods to create an instance, then throw it from your {@code doFillXyz}
* method.
*
* @since 2.50
@@ -117,8 +117,8 @@ public abstract class FormFillFailure extends IOException implements HttpRespons
* This method must be used with care to avoid cross-site scripting
* attack.
*
- * @param message Human readable message to be sent. error(null)
- * can be used as ok().
+ * @param message Human readable message to be sent. {@code error(null)}
+ * can be used as {@code ok()}.
*/
public static FormFillFailure errorWithMarkup(String message) {
return _errorWithMarkup(message, FormValidation.Kind.ERROR);
diff --git a/core/src/main/java/hudson/util/FormValidation.java b/core/src/main/java/hudson/util/FormValidation.java
index 3009e16253a551156e0d1eaec150b5a9a167d309..90748cf224df2774fcf99d9a8a553f109072a529 100644
--- a/core/src/main/java/hudson/util/FormValidation.java
+++ b/core/src/main/java/hudson/util/FormValidation.java
@@ -66,7 +66,7 @@ import static hudson.Util.*;
* Represents the result of the form field validation.
*
*
- * Use one of the factory methods to create an instance, then return it from your doCheckXyz
+ * Use one of the factory methods to create an instance, then return it from your {@code doCheckXyz}
* method. (Via {@link HttpResponse}, the returned object will render the result into {@link StaplerResponse}.)
* This way of designing form field validation allows you to reuse {@code doCheckXyz()} methods
* programmatically as well (by using {@link #kind}.
@@ -77,7 +77,7 @@ import static hudson.Util.*;
* that you may be able to reuse.
*
*
- * Also see doCheckCvsRoot in CVSSCM as an example.
+ * Also see {@code doCheckCvsRoot} in {@code CVSSCM} as an example.
*
*
* This class extends {@link IOException} so that it can be thrown from a method. This allows one to reuse
@@ -136,8 +136,8 @@ public abstract class FormValidation extends IOException implements HttpResponse
* Sends out a string error message that indicates an error.
*
* @param message
- * Human readable message to be sent. error(null)
- * can be used as ok().
+ * Human readable message to be sent. {@code error(null)}
+ * can be used as {@code ok()}.
*/
public static FormValidation error(String message) {
return errorWithMarkup(message==null?null: Util.escape(message));
@@ -245,8 +245,8 @@ public abstract class FormValidation extends IOException implements HttpResponse
* attack.
*
* @param message
- * Human readable message to be sent. error(null)
- * can be used as ok().
+ * Human readable message to be sent. {@code error(null)}
+ * can be used as {@code ok()}.
*/
public static FormValidation errorWithMarkup(String message) {
return _errorWithMarkup(message,Kind.ERROR);
diff --git a/core/src/main/java/hudson/util/Function1.java b/core/src/main/java/hudson/util/Function1.java
index c200c28c3a2c7fcee3a829fe7d225eb028c32900..aa7535d5903f75a572c99f39139e526567b7fc17 100644
--- a/core/src/main/java/hudson/util/Function1.java
+++ b/core/src/main/java/hudson/util/Function1.java
@@ -24,7 +24,7 @@
package hudson.util;
/**
- * Unary function y=f(x).
+ * Unary function {@code y=f(x)}.
*
* @author Kohsuke Kawaguchi
*/
diff --git a/core/src/main/java/hudson/util/HudsonFailedToLoad.java b/core/src/main/java/hudson/util/HudsonFailedToLoad.java
index 72ad0a4f9c629508703a772b9e56885600958496..8347c7a1cf3f5a3e83d795236a634876c72755f9 100644
--- a/core/src/main/java/hudson/util/HudsonFailedToLoad.java
+++ b/core/src/main/java/hudson/util/HudsonFailedToLoad.java
@@ -30,7 +30,7 @@ import org.kohsuke.accmod.restrictions.NoExternalUse;
* Model object used to display the generic error when Jenkins start up fails fatally during initialization.
*
*
- * index.jelly would display a nice friendly error page.
+ * {@code index.jelly} would display a nice friendly error page.
*
* @author Kohsuke Kawaguchi
*/
diff --git a/core/src/main/java/hudson/util/IncompatibleAntVersionDetected.java b/core/src/main/java/hudson/util/IncompatibleAntVersionDetected.java
index 1a89b82e6f2f877759f9a8135667ffbf16ea7ddb..c3d34afd4edfbea54d0a2bfe71a5f20b4c297152 100644
--- a/core/src/main/java/hudson/util/IncompatibleAntVersionDetected.java
+++ b/core/src/main/java/hudson/util/IncompatibleAntVersionDetected.java
@@ -33,7 +33,7 @@ import java.net.URL;
* we find out that the container is picking up its own Ant and that's not 1.7.
*
*
- * index.jelly would display a nice friendly error page.
+ * {@code index.jelly} would display a nice friendly error page.
*
* @author Kohsuke Kawaguchi
*/
diff --git a/core/src/main/java/hudson/util/IncompatibleServletVersionDetected.java b/core/src/main/java/hudson/util/IncompatibleServletVersionDetected.java
index 92d17d185df650cfbdccf593b35b58bd4c67a6f8..f2e4931d6ab9265a0f3dae05a056953a03dfa3f4 100644
--- a/core/src/main/java/hudson/util/IncompatibleServletVersionDetected.java
+++ b/core/src/main/java/hudson/util/IncompatibleServletVersionDetected.java
@@ -33,7 +33,7 @@ import java.net.URL;
* we find out that the container doesn't support servlet 2.4.
*
*
- * index.jelly would display a nice friendly error page.
+ * {@code index.jelly} would display a nice friendly error page.
*
* @author Kohsuke Kawaguchi
*/
diff --git a/core/src/main/java/hudson/util/IncompatibleVMDetected.java b/core/src/main/java/hudson/util/IncompatibleVMDetected.java
index ae690c162bb77dc14ca31b2deeaad13e6bcd71b9..651e5b124950c33efb76cc85e8f057c646df5008 100644
--- a/core/src/main/java/hudson/util/IncompatibleVMDetected.java
+++ b/core/src/main/java/hudson/util/IncompatibleVMDetected.java
@@ -30,7 +30,7 @@ import java.util.Map;
* we find out that XStream is running in pure-java mode.
*
*
- * index.jelly would display a nice friendly error page.
+ * {@code index.jelly} would display a nice friendly error page.
*
* @author Kohsuke Kawaguchi
*/
diff --git a/core/src/main/java/hudson/util/InsufficientPermissionDetected.java b/core/src/main/java/hudson/util/InsufficientPermissionDetected.java
index 739e930bb9fed64598d22773c8e496f40e848406..57aea00f22e6479abe2cf45f23b1d0c91695eb15 100644
--- a/core/src/main/java/hudson/util/InsufficientPermissionDetected.java
+++ b/core/src/main/java/hudson/util/InsufficientPermissionDetected.java
@@ -31,7 +31,7 @@ import org.kohsuke.accmod.restrictions.NoExternalUse;
* we find that we don't have enough permissions to run.
*
*
- * index.jelly would display a nice friendly error page.
+ * {@code index.jelly} would display a nice friendly error page.
*
* @author Kohsuke Kawaguchi
*/
diff --git a/core/src/main/java/hudson/util/KeyedDataStorage.java b/core/src/main/java/hudson/util/KeyedDataStorage.java
index 49a220b1b245db200a356c90f7bb0c41ea7ed986..18344394551520136eeffd6bc165ac9b9aed3079 100644
--- a/core/src/main/java/hudson/util/KeyedDataStorage.java
+++ b/core/src/main/java/hudson/util/KeyedDataStorage.java
@@ -254,7 +254,7 @@ public abstract class KeyedDataStorage
- * Internet Explorer's XmlHttpRequest.responseText seems to
+ * Internet Explorer's {@code XmlHttpRequest.responseText} seems to
* normalize the line end, and if we only send LF without CR, it will
* not recognize that as a new line. To work around this problem,
* we use this filter to always convert LF to CR+LF.
diff --git a/core/src/main/java/hudson/util/ListBoxModel.java b/core/src/main/java/hudson/util/ListBoxModel.java
index 63d7ee7795be2c8e80c99c816b6a2c638d413ef2..fc717cc7ef606d98b6dae9cfacbf7ababd5e0af4 100644
--- a/core/src/main/java/hudson/util/ListBoxModel.java
+++ b/core/src/main/java/hudson/util/ListBoxModel.java
@@ -62,7 +62,7 @@ import java.util.Collection;
*
*
* Other parts of the HTML can initiate the SELECT element update by using the "updateListBox"
- * function, defined in hudson-behavior.js. The following example does it
+ * function, defined in {@code hudson-behavior.js}. The following example does it
* when the value of the textbox changes:
*
*
- * The first argument is the SELECT element or the ID of it (see Prototype.js $(...) function.)
+ * The first argument is the SELECT element or the ID of it (see Prototype.js {@code $(...)} function.)
* The second argument is the URL that returns the options list.
*
*
- * The URL usually maps to the doXXX method on the server, which uses {@link ListBoxModel}
+ * The URL usually maps to the {@code doXXX} method on the server, which uses {@link ListBoxModel}
* for producing option values. See the following example:
*
*
- * index.jelly would display a nice friendly error page.
+ * {@code index.jelly} would display a nice friendly error page.
*
* @author Kohsuke Kawaguchi
*/
diff --git a/core/src/main/java/hudson/util/NoTempDir.java b/core/src/main/java/hudson/util/NoTempDir.java
index 10cfceb5ac04e446d2bb0c45c1836a8b2130a341..2e6209463dc814ed173c25e477e2665aab46e5b8 100644
--- a/core/src/main/java/hudson/util/NoTempDir.java
+++ b/core/src/main/java/hudson/util/NoTempDir.java
@@ -33,7 +33,7 @@ import java.io.IOException;
* there appears to be no temporary directory.
*
*
- * index.jelly would display a nice friendly error page.
+ * {@code index.jelly} would display a nice friendly error page.
*
* @author Kohsuke Kawaguchi
*/
diff --git a/core/src/main/java/hudson/util/ProcessTree.java b/core/src/main/java/hudson/util/ProcessTree.java
index 843653f72da8c30a6b0fcfa95db6e38c3a6e2a2c..a7b400d5d13e1c8a613a68cab855b412e6dd979b 100644
--- a/core/src/main/java/hudson/util/ProcessTree.java
+++ b/core/src/main/java/hudson/util/ProcessTree.java
@@ -969,7 +969,7 @@ public abstract class ProcessTree implements Iterable A TimeUnit is mainly used to inform time-based methods
+ * A {@code TimeUnit} is mainly used to inform time-based methods
* how a given timing parameter should be interpreted. For example,
* the following code will timeout in 50 milliseconds if the {@link
* java.util.concurrent.locks.Lock lock} is not available:
@@ -63,7 +63,7 @@ import java.util.concurrent.TimeUnit;
*
* Note however, that there is no guarantee that a particular timeout
* implementation will be able to notice the passage of time at the
- * same granularity as the given TimeUnit.
+ * same granularity as the given {@code TimeUnit}.
*
* @author Doug Lea
* @deprecated use {@link TimeUnit}. (Java 5 did not have all the units required, so {@link TimeUnit2} was introduced
@@ -188,20 +188,20 @@ public enum TimeUnit2 {
* Convert the given time duration in the given unit to this
* unit. Conversions from finer to coarser granularities
* truncate, so lose precision. For example converting
- * 999 milliseconds to seconds results in
- * 0. Conversions from coarser to finer granularities
+ * {@code 999} milliseconds to seconds results in
+ * {@code 0}. Conversions from coarser to finer granularities
* with arguments that would numerically overflow saturate to
- * Long.MIN_VALUE if negative or Long.MAX_VALUE
+ * {@code Long.MIN_VALUE} if negative or {@code Long.MAX_VALUE}
* if positive.
*
* For example, to convert 10 minutes to milliseconds, use:
- * TimeUnit.MILLISECONDS.convert(10L, TimeUnit.MINUTES)
+ * {@code TimeUnit.MILLISECONDS.convert(10L, TimeUnit.MINUTES)}
*
- * @param sourceDuration the time duration in the given sourceUnit
- * @param sourceUnit the unit of the sourceDuration argument
+ * @param sourceDuration the time duration in the given {@code sourceUnit}
+ * @param sourceUnit the unit of the {@code sourceDuration} argument
* @return the converted duration in this unit,
- * or Long.MIN_VALUE if conversion would negatively
- * overflow, or Long.MAX_VALUE if it would positively overflow.
+ * or {@code Long.MIN_VALUE} if conversion would negatively
+ * overflow, or {@code Long.MAX_VALUE} if it would positively overflow.
*/
public long convert(long sourceDuration, TimeUnit2 sourceUnit) {
throw new AbstractMethodError();
@@ -211,31 +211,31 @@ public enum TimeUnit2 {
* Convert the given time duration in the given unit to this
* unit. Conversions from finer to coarser granularities
* truncate, so lose precision. For example converting
- * 999 milliseconds to seconds results in
- * 0. Conversions from coarser to finer granularities
+ * {@code 999} milliseconds to seconds results in
+ * {@code 0}. Conversions from coarser to finer granularities
* with arguments that would numerically overflow saturate to
- * Long.MIN_VALUE if negative or Long.MAX_VALUE
+ * {@code Long.MIN_VALUE} if negative or {@code Long.MAX_VALUE}
* if positive.
*
* For example, to convert 10 minutes to milliseconds, use:
- * TimeUnit.MILLISECONDS.convert(10L, TimeUnit.MINUTES)
+ * {@code TimeUnit.MILLISECONDS.convert(10L, TimeUnit.MINUTES)}
*
- * @param sourceDuration the time duration in the given sourceUnit
- * @param sourceUnit the unit of the sourceDuration argument
+ * @param sourceDuration the time duration in the given {@code sourceUnit}
+ * @param sourceUnit the unit of the {@code sourceDuration} argument
* @return the converted duration in this unit,
- * or Long.MIN_VALUE if conversion would negatively
- * overflow, or Long.MAX_VALUE if it would positively overflow.
+ * or {@code Long.MIN_VALUE} if conversion would negatively
+ * overflow, or {@code Long.MAX_VALUE} if it would positively overflow.
*/
public long convert(long sourceDuration, TimeUnit sourceUnit) {
throw new AbstractMethodError();
}
/**
- * Equivalent to NANOSECONDS.convert(duration, this).
+ * Equivalent to {@code NANOSECONDS.convert(duration, this)}.
* @param duration the duration
* @return the converted duration,
- * or Long.MIN_VALUE if conversion would negatively
- * overflow, or Long.MAX_VALUE if it would positively overflow.
+ * or {@code Long.MIN_VALUE} if conversion would negatively
+ * overflow, or {@code Long.MAX_VALUE} if it would positively overflow.
* @see #convert
*/
public long toNanos(long duration) {
@@ -243,11 +243,11 @@ public enum TimeUnit2 {
}
/**
- * Equivalent to MICROSECONDS.convert(duration, this).
+ * Equivalent to {@code MICROSECONDS.convert(duration, this)}.
* @param duration the duration
* @return the converted duration,
- * or Long.MIN_VALUE if conversion would negatively
- * overflow, or Long.MAX_VALUE if it would positively overflow.
+ * or {@code Long.MIN_VALUE} if conversion would negatively
+ * overflow, or {@code Long.MAX_VALUE} if it would positively overflow.
* @see #convert
*/
public long toMicros(long duration) {
@@ -255,11 +255,11 @@ public enum TimeUnit2 {
}
/**
- * Equivalent to MILLISECONDS.convert(duration, this).
+ * Equivalent to {@code MILLISECONDS.convert(duration, this)}.
* @param duration the duration
* @return the converted duration,
- * or Long.MIN_VALUE if conversion would negatively
- * overflow, or Long.MAX_VALUE if it would positively overflow.
+ * or {@code Long.MIN_VALUE} if conversion would negatively
+ * overflow, or {@code Long.MAX_VALUE} if it would positively overflow.
* @see #convert
*/
public long toMillis(long duration) {
@@ -267,11 +267,11 @@ public enum TimeUnit2 {
}
/**
- * Equivalent to SECONDS.convert(duration, this).
+ * Equivalent to {@code SECONDS.convert(duration, this)}.
* @param duration the duration
* @return the converted duration,
- * or Long.MIN_VALUE if conversion would negatively
- * overflow, or Long.MAX_VALUE if it would positively overflow.
+ * or {@code Long.MIN_VALUE} if conversion would negatively
+ * overflow, or {@code Long.MAX_VALUE} if it would positively overflow.
* @see #convert
*/
public long toSeconds(long duration) {
@@ -279,11 +279,11 @@ public enum TimeUnit2 {
}
/**
- * Equivalent to MINUTES.convert(duration, this).
+ * Equivalent to {@code MINUTES.convert(duration, this)}.
* @param duration the duration
* @return the converted duration,
- * or Long.MIN_VALUE if conversion would negatively
- * overflow, or Long.MAX_VALUE if it would positively overflow.
+ * or {@code Long.MIN_VALUE} if conversion would negatively
+ * overflow, or {@code Long.MAX_VALUE} if it would positively overflow.
* @see #convert
*/
public long toMinutes(long duration) {
@@ -291,11 +291,11 @@ public enum TimeUnit2 {
}
/**
- * Equivalent to HOURS.convert(duration, this).
+ * Equivalent to {@code HOURS.convert(duration, this)}.
* @param duration the duration
* @return the converted duration,
- * or Long.MIN_VALUE if conversion would negatively
- * overflow, or Long.MAX_VALUE if it would positively overflow.
+ * or {@code Long.MIN_VALUE} if conversion would negatively
+ * overflow, or {@code Long.MAX_VALUE} if it would positively overflow.
* @see #convert
*/
public long toHours(long duration) {
@@ -303,7 +303,7 @@ public enum TimeUnit2 {
}
/**
- * Equivalent to DAYS.convert(duration, this).
+ * Equivalent to {@code DAYS.convert(duration, this)}.
* @param duration the duration
* @return the converted duration
* @see #convert
@@ -322,11 +322,11 @@ public enum TimeUnit2 {
abstract int excessNanos(long d, long m);
/**
- * Performs a timed Object.wait using this time unit.
+ * Performs a timed {@code Object.wait} using this time unit.
* This is a convenience method that converts timeout arguments
- * into the form required by the Object.wait method.
+ * into the form required by the {@code Object.wait} method.
*
- * For example, you could implement a blocking poll
+ * For example, you could implement a blocking {@code poll}
* method (see {@link java.util.concurrent.BlockingQueue#poll BlockingQueue.poll})
* using:
*
@@ -353,9 +353,9 @@ public enum TimeUnit2 {
}
/**
- * Performs a timed Thread.join using this time unit.
+ * Performs a timed {@code Thread.join} using this time unit.
* This is a convenience method that converts time arguments into the
- * form required by the Thread.join method.
+ * form required by the {@code Thread.join} method.
* @param thread the thread to wait for
* @param timeout the maximum time to wait. If less than
* or equal to zero, do not wait at all.
@@ -372,9 +372,9 @@ public enum TimeUnit2 {
}
/**
- * Performs a Thread.sleep using this unit.
+ * Performs a {@code Thread.sleep} using this unit.
* This is a convenience method that converts time arguments into the
- * form required by the Thread.sleep method.
+ * form required by the {@code Thread.sleep} method.
* @param timeout the minimum time to sleep. If less than
* or equal to zero, do not sleep at all.
* @throws InterruptedException if interrupted while sleeping.
diff --git a/core/src/main/java/hudson/views/ListViewColumn.java b/core/src/main/java/hudson/views/ListViewColumn.java
index f5fdd6e4687d961c7b801a5bab9e0a1c079382d5..4b1581a2f967743a114c48e26a722218e7a8e170 100644
--- a/core/src/main/java/hudson/views/ListViewColumn.java
+++ b/core/src/main/java/hudson/views/ListViewColumn.java
@@ -48,13 +48,13 @@ import net.sf.json.JSONObject;
* Extension point for adding a column to a table rendering of {@link Item}s, such as {@link ListView}.
*
*
- * This object must have the column.jelly. This view
+ * This object must have the {@code column.jelly}. This view
* is called for each cell of this column. The {@link Item} object
* is passed in the "job" variable. The view should render
* the {@code
- * This object may have an additional columnHeader.jelly. The default ColumnHeader
+ * This object may have an additional {@code columnHeader.jelly}. The default ColumnHeader
* will render {@link #getColumnCaption()}.
*
*
diff --git a/core/src/main/java/hudson/views/MyViewsTabBar.java b/core/src/main/java/hudson/views/MyViewsTabBar.java
index 6727cb050e1f12a9ff598be0dfa68fcba75a9d2a..c3b49c268f7c7fba864476a2d89cb04eca3e1099 100644
--- a/core/src/main/java/hudson/views/MyViewsTabBar.java
+++ b/core/src/main/java/hudson/views/MyViewsTabBar.java
@@ -47,7 +47,7 @@ import org.kohsuke.stapler.StaplerRequest;
* Extension point for adding a MyViewsTabBar header to Projects {@link MyViewsProperty}.
*
*
- * This object must have the myViewTabs.jelly. This view
+ * This object must have the {@code myViewTabs.jelly}. This view
* is called once when the My Views main panel is built.
* The "views" attribute is set to the "Collection of views".
*
diff --git a/core/src/main/java/hudson/views/ViewsTabBar.java b/core/src/main/java/hudson/views/ViewsTabBar.java
index a6cb0b4f795afbd039e955b54f463a3ed51a13ed..14565969373b9605c1ac34736d9b7921e6e9a874 100644
--- a/core/src/main/java/hudson/views/ViewsTabBar.java
+++ b/core/src/main/java/hudson/views/ViewsTabBar.java
@@ -48,7 +48,7 @@ import org.kohsuke.stapler.StaplerRequest;
* Extension point for adding a ViewsTabBar header to Projects {@link ListView}.
*
*
- * This object must have the viewTabs.jelly. This view
+ * This object must have the {@code viewTabs.jelly}. This view
* is called once when the project views main panel is built.
* The "views" attribute is set to the "Collection of views".
*
diff --git a/core/src/main/java/jenkins/model/CauseOfInterruption.java b/core/src/main/java/jenkins/model/CauseOfInterruption.java
index 7a8c173f212198258c2327347490a1c2a8229636..b14a02ca2752b0b6b3d904ea3123e933c742045a 100644
--- a/core/src/main/java/jenkins/model/CauseOfInterruption.java
+++ b/core/src/main/java/jenkins/model/CauseOfInterruption.java
@@ -39,7 +39,7 @@ import javax.annotation.Nonnull;
* Records why an {@linkplain Executor#interrupt() executor is interrupted}.
*
*
diff --git a/core/src/main/java/jenkins/security/ExceptionTranslationFilter.java b/core/src/main/java/jenkins/security/ExceptionTranslationFilter.java
index aaa71541764d1dc4b683c8094b675fbaa48236e5..24755588b027aab58b682429a39d57018e1d2a53 100644
--- a/core/src/main/java/jenkins/security/ExceptionTranslationFilter.java
+++ b/core/src/main/java/jenkins/security/ExceptionTranslationFilter.java
@@ -53,13 +53,13 @@ import java.util.logging.Logger;
*
* If an {@link AuthenticationException} is detected, the filter will launch the
* If an {@link AccessDeniedException} is detected, the filter will determine whether or not the user is an anonymous
* user. If they are an anonymous user, the
* To use this filter, it is necessary to specify the following properties:
@@ -74,7 +74,7 @@ import java.util.logging.Logger;
*
*
* Do not use this class directly. Instead configure
- *
* This provides more secure version of it by using HMAC.
diff --git a/core/src/main/java/jenkins/slaves/JnlpSlaveAgentProtocol.java b/core/src/main/java/jenkins/slaves/JnlpSlaveAgentProtocol.java
index e502567e0df32d0c212bd571080e979bf9b6a2e2..aca5fdb54a3bc4f21593287cec346698986a4f92 100644
--- a/core/src/main/java/jenkins/slaves/JnlpSlaveAgentProtocol.java
+++ b/core/src/main/java/jenkins/slaves/JnlpSlaveAgentProtocol.java
@@ -31,11 +31,11 @@ import org.jenkinsci.remoting.engine.JnlpProtocol1Handler;
*
*
* We do this by computing HMAC of the agent name.
- * This code is sent to the agent inside the .jnlp file
+ * This code is sent to the agent inside the {@code .jnlp} file
* (this file itself is protected by HTTP form-based authentication that
* we use everywhere else in Jenkins), and the agent sends this
* token back when it connects to the master.
- * Unauthorized agents can't access the protected .jnlp file,
+ * Unauthorized agents can't access the protected {@code .jnlp} file,
* so it can't impersonate a valid agent.
*
*
diff --git a/core/src/main/java/jenkins/slaves/systemInfo/SlaveSystemInfo.java b/core/src/main/java/jenkins/slaves/systemInfo/SlaveSystemInfo.java
index 16a5352d09aad470496420168cc9d4e267a1b79e..8888ca426350c1a2e1b3e9e139dc9267244024df 100644
--- a/core/src/main/java/jenkins/slaves/systemInfo/SlaveSystemInfo.java
+++ b/core/src/main/java/jenkins/slaves/systemInfo/SlaveSystemInfo.java
@@ -8,7 +8,7 @@ import hudson.model.Computer;
* Extension point that contributes to the system information page of {@link Computer}.
*
*
* Usage from script of a subclass, say ViewHelper:
*
- * new ViewHelper(delegate).method();
+ * {@code new ViewHelper(delegate).method();}
*
- * see ModularizeViewScript in ui-samples for an example how to use
+ * see {@code ModularizeViewScript} in ui-samples for an example how to use
* this class.
*/
public abstract class AbstractGroovyViewModule extends GroovyObjectSupport {
diff --git a/core/src/main/java/jenkins/util/groovy/GroovyHookScript.java b/core/src/main/java/jenkins/util/groovy/GroovyHookScript.java
index 3c01ebf827da233145b29d1e80e2a03c706cd573..4f15ed49658e1d3549109dc61c4df529d5a842c0 100644
--- a/core/src/main/java/jenkins/util/groovy/GroovyHookScript.java
+++ b/core/src/main/java/jenkins/util/groovy/GroovyHookScript.java
@@ -31,8 +31,8 @@ import jenkins.model.Jenkins;
*
*
*
- * Scripts inside /WEB-INF is meant for OEM distributions of Jenkins. Files inside
- * $JENKINS_HOME are for installation local settings. Use of HOOK.groovy.d
+ * Scripts inside {@code /WEB-INF} is meant for OEM distributions of Jenkins. Files inside
+ * {@code $JENKINS_HOME} are for installation local settings. Use of {@code HOOK.groovy.d}
* allows configuration management tools to control scripts easily.
*
* @author Kohsuke Kawaguchi
{@code
How does a CLI command work
*
*
*
* Behaviour, JavaScript, and CSS
* Behaviour, JavaScript, and CSS
*
diff --git a/core/src/main/java/hudson/lifecycle/Lifecycle.java b/core/src/main/java/hudson/lifecycle/Lifecycle.java
index 34915da0de1beab1dbd7c085506d8bb51aab2644..4c52cdd87877e8e91f588831cdfbb244dba9c2d4 100644
--- a/core/src/main/java/hudson/lifecycle/Lifecycle.java
+++ b/core/src/main/java/hudson/lifecycle/Lifecycle.java
@@ -112,7 +112,7 @@ public abstract class Lifecycle implements ExtensionPoint {
}
/**
- * If the location of jenkins.war is known in this life cycle,
+ * If the location of {@code jenkins.war} is known in this life cycle,
* return it location. Otherwise return null to indicate that it is unknown.
*
*
Views
* Views
*
*
Persistence
* Associated Views
* config.jelly
- * {@link ParameterDefinition} class uses config.jelly to contribute a form
+ * {@link ParameterDefinition} class uses {@code config.jelly} to contribute a form
* fragment in the job configuration screen. Values entered there are fed back to
* {@link ParameterDescriptor#newInstance(StaplerRequest, JSONObject)} to create {@link ParameterDefinition}s.
*
* index.jelly
- * The index.jelly view contributes a form fragment in the page where the user
+ * The {@code index.jelly} view contributes a form fragment in the page where the user
* enters actual values of parameters for a build. The result of this form submission
* is then fed to {@link ParameterDefinition#createValue(StaplerRequest, JSONObject)} to
* create {@link ParameterValue}s.
diff --git a/core/src/main/java/hudson/model/ParameterValue.java b/core/src/main/java/hudson/model/ParameterValue.java
index 6cd1f46a190d322cb7cf8fbe0cbf6ccba4e3a66a..64fc925a8ec8a76cd27e1ba96056b97a5daa95eb 100644
--- a/core/src/main/java/hudson/model/ParameterValue.java
+++ b/core/src/main/java/hudson/model/ParameterValue.java
@@ -56,12 +56,12 @@ import org.kohsuke.stapler.export.ExportedBean;
*
* Persistence
* Associated Views
* value.jelly
- * The value.jelly view contributes a UI fragment to display the parameter
+ * The {@code value.jelly} view contributes a UI fragment to display the parameter
* values used for a build.
*
* Notes
diff --git a/core/src/main/java/hudson/model/ParametersDefinitionProperty.java b/core/src/main/java/hudson/model/ParametersDefinitionProperty.java
index 8ecb52bf2f8d32b9eef213dc1523c44b6e5cd64d..1fa26ed3720af73f034e3325cc80bd5db293e76d 100644
--- a/core/src/main/java/hudson/model/ParametersDefinitionProperty.java
+++ b/core/src/main/java/hudson/model/ParametersDefinitionProperty.java
@@ -59,7 +59,7 @@ import org.kohsuke.stapler.export.ExportedBean;
* Keeps a list of the parameters defined for a project.
*
* Views
* Note for implementers
*
*
@@ -1154,7 +1154,7 @@ public abstract class View extends AbstractModelObject implements AccessControll
}
/**
- * Accepts config.xml submission, as well as serve it.
+ * Accepts {@code config.xml} submission, as well as serve it.
*/
@WebMethod(name = "config.xml")
public HttpResponse doConfigDotXml(StaplerRequest req) throws IOException {
@@ -1367,7 +1367,7 @@ public abstract class View extends AbstractModelObject implements AccessControll
/**
* Instantiate View subtype from XML stream.
*
- * @param name Alternative name to use or null to keep the one in xml.
+ * @param name Alternative name to use or {@code null} to keep the one in xml.
*/
public static View createViewFromXML(String name, InputStream xml) throws IOException {
diff --git a/core/src/main/java/hudson/model/queue/CauseOfBlockage.java b/core/src/main/java/hudson/model/queue/CauseOfBlockage.java
index e5ba86359771f88092d1ed5982197bc48dad24d7..beb76b824a34b11729ea57fa3d71ab012d480b76 100644
--- a/core/src/main/java/hudson/model/queue/CauseOfBlockage.java
+++ b/core/src/main/java/hudson/model/queue/CauseOfBlockage.java
@@ -19,7 +19,7 @@ import org.jvnet.localizer.Localizable;
* has expanded beyond queues.
*
* View
- * summary.jelly should do one-line HTML rendering to be used showing the cause
+ * {@code summary.jelly} should do one-line HTML rendering to be used showing the cause
* to the user. By default it simply renders {@link #getShortDescription()} text.
*
*
- *
*
* Clients can distinguishing among these states based on the additional data attached to this object. {@link #getSkipped()}
- * returns computers that was not monitored as they ware either offline or monitor produced null {@link Callable}.
+ * returns computers that was not monitored as they ware either offline or monitor produced {@code null} {@link Callable}.
*/
protected static final class Result
*
- *
*
Notes
*
*
{@code
Views
*
- * Since version 2.64, Jenkins clouds are visualized in UI. Implementations can provide top or main view
- * to be presented at the top of the page or at the bottom respectively. In the middle, actions have their summary
- * views displayed. Actions further contribute to sidepanel with box views. All mentioned views are
+ * Since version 2.64, Jenkins clouds are visualized in UI. Implementations can provide {@code top} or {@code main} view
+ * to be presented at the top of the page or at the bottom respectively. In the middle, actions have their {@code summary}
+ * views displayed. Actions further contribute to {@code sidepanel} with {@code box} views. All mentioned views are
* optional to preserve backward compatibility.
*
* @author Kohsuke Kawaguchi
diff --git a/core/src/main/java/hudson/slaves/NodeDescriptor.java b/core/src/main/java/hudson/slaves/NodeDescriptor.java
index 6f06289c38d35390d9a9a099b66dabb63965eca2..5262ece687087f14269d7a3a6ccea5602dc6cf37 100644
--- a/core/src/main/java/hudson/slaves/NodeDescriptor.java
+++ b/core/src/main/java/hudson/slaves/NodeDescriptor.java
@@ -50,8 +50,8 @@ import javax.servlet.ServletException;
*
* Views
* Other Implementation Notes
*
diff --git a/core/src/main/java/hudson/slaves/OfflineCause.java b/core/src/main/java/hudson/slaves/OfflineCause.java
index 7c5c77861fa695cfe7fbd28a0148840403562e21..a158ce2b8c15da689b612fc22634561eae5bd181 100644
--- a/core/src/main/java/hudson/slaves/OfflineCause.java
+++ b/core/src/main/java/hudson/slaves/OfflineCause.java
@@ -44,7 +44,7 @@ import java.util.Date;
*
* Views
* } tag that shows the section title, followed by some
* block elements to render the details of the section.
diff --git a/core/src/main/java/hudson/tasks/Maven.java b/core/src/main/java/hudson/tasks/Maven.java
index ac36f7fcdee9777e911e2bfc1c2e7ba2319f0500..5bccbfe78548651ed390c081f0e986bf3c53249a 100644
--- a/core/src/main/java/hudson/tasks/Maven.java
+++ b/core/src/main/java/hudson/tasks/Maven.java
@@ -246,7 +246,7 @@ public class Maven extends Builder {
}
/**
- * Looks for pom.xlm or project.xml to determine the maven executable
+ * Looks for {@code pom.xlm} or {@code project.xml} to determine the maven executable
* name.
*/
private static final class DecideDefaultMavenCommand extends MasterToSlaveFileCallable
{@code
*
*
diff --git a/core/src/main/java/hudson/util/NoHomeDir.java b/core/src/main/java/hudson/util/NoHomeDir.java
index cae6089554a16dd95e2af0d1399862daf15422e3..c3d15ea367762b52a65592fa721f5bb176a5cf38 100644
--- a/core/src/main/java/hudson/util/NoHomeDir.java
+++ b/core/src/main/java/hudson/util/NoHomeDir.java
@@ -30,7 +30,7 @@ import java.io.File;
* we couldn't create the home directory.
*
*
} tag.
*
* View
- * summary.groovy/.jelly should do one-line HTML rendering to be used while rendering
+ * {@code summary.groovy/.jelly} should do one-line HTML rendering to be used while rendering
* "build history" widget, next to the blocking build. By default it simply renders
* {@link #getShortDescription()} text.
*
diff --git a/core/src/main/java/jenkins/model/Jenkins.java b/core/src/main/java/jenkins/model/Jenkins.java
index f1ba7be1ddf895c610d486b714d3e806bb7e5c69..2d0d717bbf1a6893b6ee77a5d5d95f4b92e2963a 100644
--- a/core/src/main/java/jenkins/model/Jenkins.java
+++ b/core/src/main/java/jenkins/model/Jenkins.java
@@ -797,7 +797,7 @@ public class Jenkins extends AbstractCIBase implements DirectlyModifiableTopLeve
/**
* Secret key generated once and used for a long time, beyond
- * container start/stop. Persisted outside config.xml to avoid
+ * container start/stop. Persisted outside {@code config.xml} to avoid
* accidental exposure.
*/
private transient final String secretKey;
@@ -1557,7 +1557,7 @@ public class Jenkins extends AbstractCIBase implements DirectlyModifiableTopLeve
/**
* Gets the plugin object from its short name.
- * This allows URL hudson/plugin/ID to be served by the views
+ * This allows URL {@code hudson/plugin/ID} to be served by the views
* of the plugin class.
* @param shortName Short name of the plugin
* @return The plugin singleton or {@code null} if for some reason the plugin is not loaded.
@@ -4618,7 +4618,7 @@ public class Jenkins extends AbstractCIBase implements DirectlyModifiableTopLeve
}
/**
- * Exposes the current user to /me URL.
+ * Exposes the current user to {@code /me} URL.
*/
public User getMe() {
User u = User.current();
diff --git a/core/src/main/java/jenkins/model/JenkinsLocationConfiguration.java b/core/src/main/java/jenkins/model/JenkinsLocationConfiguration.java
index 1e9213df75804356dcff455df56bc44658f5cd43..263b482b0f5a443bb811994100b59f96a50188b8 100644
--- a/core/src/main/java/jenkins/model/JenkinsLocationConfiguration.java
+++ b/core/src/main/java/jenkins/model/JenkinsLocationConfiguration.java
@@ -157,7 +157,7 @@ public class JenkinsLocationConfiguration extends GlobalConfiguration implements
}
/**
- * Checks the URL in global.jelly
+ * Checks the URL in {@code global.jelly}
*/
public FormValidation doCheckUrl(@QueryParameter String value) {
if(value.startsWith("http://localhost"))
diff --git a/core/src/main/java/jenkins/security/BasicHeaderProcessor.java b/core/src/main/java/jenkins/security/BasicHeaderProcessor.java
index df176b0a1b5a7dbbfc03bc9698cb84e9d2f7bd16..5e0986eca4b5afc1ee08e99d54d1b96a193124fe 100644
--- a/core/src/main/java/jenkins/security/BasicHeaderProcessor.java
+++ b/core/src/main/java/jenkins/security/BasicHeaderProcessor.java
@@ -29,7 +29,7 @@ import java.util.logging.Logger;
import static java.util.logging.Level.*;
/**
- * Takes "username:password" given in the Authorization HTTP header and authenticates
+ * Takes "username:password" given in the {@code Authorization} HTTP header and authenticates
* the request.
*
* authenticationEntryPoint
.
* This allows common handling of authentication failures originating from any subclass of
- * AbstractSecurityInterceptor.
+ * {@code AbstractSecurityInterceptor}.
* authenticationEntryPoint
will be launched. If they are not
- * an anonymous user, the filter will delegate to the AccessDeniedHandler.
- * By default the filter will use AccessDeniedHandlerImpl.
+ * an anonymous user, the filter will delegate to the {@code AccessDeniedHandler}.
+ * By default the filter will use {@code AccessDeniedHandlerImpl}.
* web.xml
to use the FilterToBeanProxy.
+ * web.xml
to use the {@code FilterToBeanProxy}.
* Views
- * Subtypes must have systemInfo.groovy/.jelly view.
+ * Subtypes must have {@code systemInfo.groovy/.jelly} view.
* This view will have the "it" variable that refers to {@link Computer} object, and "instance" variable
* that refers to {@link SlaveSystemInfo} object.
*
diff --git a/core/src/main/java/jenkins/util/groovy/AbstractGroovyViewModule.java b/core/src/main/java/jenkins/util/groovy/AbstractGroovyViewModule.java
index ccf47202931d7febe20dcbd0ea6694675dadd5ff..9bc12c6313d07753ab13789a356630ed255d05c3 100644
--- a/core/src/main/java/jenkins/util/groovy/AbstractGroovyViewModule.java
+++ b/core/src/main/java/jenkins/util/groovy/AbstractGroovyViewModule.java
@@ -12,9 +12,9 @@ import lib.JenkinsTagLib;
*