Skip to content

Commit 899e07e

Browse files
authored
Merge pull request #150 from jglick/StepExecutions-links
Link to `StepExecutions` in relevant Javadoc
2 parents 03be811 + 87f9eb5 commit 899e07e

File tree

5 files changed

+5
-1
lines changed

5 files changed

+5
-1
lines changed

src/main/java/org/jenkinsci/plugins/workflow/steps/BodyExecutionCallback.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,7 @@ public void onStart(StepContext context) {}
6565
* You lose some power this way ({@link #onStart} and per-body {@link StepContext})
6666
* but may be convenient if you already have a {@link FutureCallback} from some other source.
6767
* For example, you can wrap your own {@link StepContext} if your step is a tail call to its body.
68+
* @see StepExecutions#block
6869
*/
6970
public static BodyExecutionCallback wrap(FutureCallback<Object> v) {
7071
return v instanceof BodyExecutionCallback ? (BodyExecutionCallback)v : new Wrapper(v);

src/main/java/org/jenkinsci/plugins/workflow/steps/Step.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ public abstract class Step extends AbstractDescribableImpl<Step> implements Exte
6161
* @throws Exception
6262
* if any exception is thrown, {@link Step} is assumed to have completed abnormally synchronously
6363
* (as if {@link StepContext#onFailure} is called and the method returned true.)
64+
* @see StepExecutions
6465
*/
6566
public abstract StepExecution start(StepContext context) throws Exception;
6667

src/main/java/org/jenkinsci/plugins/workflow/steps/StepExecution.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@
2828
* @author Kohsuke Kawaguchi
2929
* @author Jesse Glick
3030
* @see Step#start(StepContext)
31+
* @see StepExecutions#block
3132
*/
3233
public abstract class StepExecution implements Serializable {
3334

src/main/java/org/jenkinsci/plugins/workflow/steps/SynchronousNonBlockingStepExecution.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@
1414

1515
/**
1616
* Similar to {@link SynchronousStepExecution} (it executes synchronously too) but it does not block the CPS VM thread.
17-
* @see StepExecution
1817
* @param <T> the type of the return value (may be {@link Void})
18+
* @see StepExecutions#synchronousNonBlocking
1919
*/
2020
public abstract class SynchronousNonBlockingStepExecution<T> extends StepExecution {
2121

src/main/java/org/jenkinsci/plugins/workflow/steps/SynchronousStepExecution.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
*
1616
* @param <T> the type of the return value (may be {@link Void})
1717
* @author Kohsuke Kawaguchi
18+
* @see StepExecutions#synchronous
1819
*/
1920
public abstract class SynchronousStepExecution<T> extends StepExecution {
2021
private transient volatile Thread executing;

0 commit comments

Comments
 (0)