From 716f5ada3589a322d02497a67aad8ca939694a08 Mon Sep 17 00:00:00 2001
From: Jesse Glick <jglick@cloudbees.com>
Date: Thu, 22 Jan 2015 09:06:16 -0500
Subject: [PATCH] Javadoc improvements.

---
 .../main/java/jenkins/tasks/SimpleBuildWrapper.java  | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

diff --git a/core/src/main/java/jenkins/tasks/SimpleBuildWrapper.java b/core/src/main/java/jenkins/tasks/SimpleBuildWrapper.java
index 216074622a..7c41e7faf9 100644
--- a/core/src/main/java/jenkins/tasks/SimpleBuildWrapper.java
+++ b/core/src/main/java/jenkins/tasks/SimpleBuildWrapper.java
@@ -32,6 +32,7 @@ import hudson.model.AbstractBuild;
 import hudson.model.AbstractProject;
 import hudson.model.Action;
 import hudson.model.BuildListener;
+import hudson.model.Computer;
 import hudson.model.Run;
 import hudson.model.TaskListener;
 import hudson.tasks.BuildWrapper;
@@ -49,6 +50,14 @@ import javax.annotation.Nonnull;
 /**
  * A generalization of {@link BuildWrapper} that, like {@link SimpleBuildStep}, may be called at various points within a build.
  * <p>Such a build wrapper would typically be written according to make few assumptions about how it is being used.
+ * Some hints about this refactoring:
+ * <ul>
+ * <li>Replace {@link AbstractBuild#getWorkspace} with the provided path.
+ * <li>Replace {@link AbstractBuild#getProject} with {@link Run#getParent}.
+ * <li>Use {@link FilePath#toComputer} rather than {@link Computer#currentComputer}.
+ * <li>Do not bother with {@link AbstractBuild#getBuildVariables} if you are not passed an {@link AbstractBuild} (treat it like an empty map).
+ * <li>The {@link Disposer} must be safely serializable. This means it should be a {@code static} class if nested, and define a {@code serialVersionUID}.
+ * </ul>
  * @since TODO
  */
 @SuppressWarnings("rawtypes") // inherited
@@ -77,8 +86,9 @@ public abstract class SimpleBuildWrapper extends BuildWrapper {
             return env;
         }
         /**
-         * Specify an environment variable override (as in {@link EnvVars#override}) to apply to processes launched within the block.
+         * Specify an environment variable override to apply to processes launched within the block.
          * If unspecified, environment variables will be inherited unmodified.
+         * @param key handles the special {@code PATH+SOMETHING} syntax as in {@link EnvVars#override}
          */
         public void env(String key, String value) {
             if (env.containsKey(key)) {
-- 
GitLab