提交 71a46145 编写于 作者: A Andrew Bayer

Javadoc cleanup

上级 aa5ff541
...@@ -523,9 +523,9 @@ public abstract class SCM implements Describable<SCM>, ExtensionPoint { ...@@ -523,9 +523,9 @@ public abstract class SCM implements Describable<SCM>, ExtensionPoint {
* *
* <p> * <p>
* This method is invoked whenever someone does {@link AbstractBuild#getEnvironment(TaskListener)}, via * This method is invoked whenever someone does {@link AbstractBuild#getEnvironment(TaskListener)}, via
* {@link #buildEnvVars(AbstractBuild, Map)}, whichvcan be before/after your checkout method is invoked. So if you * {@link #buildEnvVars(AbstractBuild, Map)}, which can be before/after your checkout method is invoked. So if you
* are going to provide information aboutvcheck out (like SVN revision number that was checked out), be prepared * are going to provide information about check out (like SVN revision number that was checked out), be prepared
* for the possibility that thevcheck out hasn't happened yet. * for the possibility that the check out hasn't happened yet.
* *
* @since FIXME * @since FIXME
*/ */
......
...@@ -64,7 +64,8 @@ public interface RunWithSCM<JobT extends Job<JobT, RunT> & Queue.Task, ...@@ -64,7 +64,8 @@ public interface RunWithSCM<JobT extends Job<JobT, RunT> & Queue.Task,
/** /**
* Gets the ids for all {@link User}s included in {@link #getChangeSets()} for this item. * Gets the ids for all {@link User}s included in {@link #getChangeSets()} for this item.
* *
* @return A possibly null set of user IDs. * @return A set of user IDs, or null if this was the first time the method was called or the build is still running
* for a {@link RunWithSCM} instance with no culprits.
*/ */
@CheckForNull @CheckForNull
Set<String> getCulpritIds(); Set<String> getCulpritIds();
...@@ -110,7 +111,7 @@ public interface RunWithSCM<JobT extends Job<JobT, RunT> & Queue.Task, ...@@ -110,7 +111,7 @@ public interface RunWithSCM<JobT extends Job<JobT, RunT> & Queue.Task,
} }
/** /**
* Internal method used for actually calculating the culprits from scratch. Called by {@link #getCulprits()} and * Method used for actually calculating the culprits from scratch. Called by {@link #getCulprits()} and
* overrides of {@link #getCulprits()}. Does not persist culprits information. * overrides of {@link #getCulprits()}. Does not persist culprits information.
* *
* @return a non-null {@link Set} of {@link User}s associated with this item. * @return a non-null {@link Set} of {@link User}s associated with this item.
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册