Skip to content

Commit b7498d1

Browse files
committed
Fixed javadoc
1 parent a76a33f commit b7498d1

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

src/main/java/jenkins/scm/api/SCMFileSystem.java

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -563,11 +563,13 @@ public abstract static class Builder2 extends Builder {
563563
* Given a {@link SCM} this should try to build a corresponding {@link SCMFileSystem} instance that
564564
* reflects the content at the specified {@link SCMRevision}. If the {@link SCM} is supported but not
565565
* for a fixed revision, best effort is acceptable as the most capable {@link SCMFileSystem} will be returned
566-
* to the caller.
566+
* to the caller. If the {@link Run} is provided, it can be used to alter the behaviour of buil based on the current Run
567+
* for example, expand branch name based on current build properties, etc.
567568
*
568569
* @param owner the owner of the {@link SCM}
569570
* @param scm the {@link SCM}.
570571
* @param rev the specified {@link SCMRevision}.
572+
* @param build the specified {@link Run}.
571573
* @return the corresponding {@link SCMFileSystem} or {@code null} if this builder cannot create a {@link
572574
* SCMFileSystem} for the specified {@link SCM}.
573575
* @throws IOException if the attempt to create a {@link SCMFileSystem} failed due to an IO error
@@ -576,7 +578,7 @@ public abstract static class Builder2 extends Builder {
576578
*/
577579
@CheckForNull
578580
public abstract SCMFileSystem build(@NonNull Item owner, @NonNull SCM scm, @CheckForNull SCMRevision rev,
579-
Run<?,?> build)
581+
@CheckForNull Run<?,?> build)
580582
throws IOException, InterruptedException;
581583
}
582584
}

0 commit comments

Comments
 (0)