Skip to content

Commit 559135e

Browse files
committed
clear up runner docs
1 parent d2a9ce7 commit 559135e

File tree

1 file changed

+7
-4
lines changed
  • framework/codemodder-base/src/main/java/io/codemodder

1 file changed

+7
-4
lines changed

framework/codemodder-base/src/main/java/io/codemodder/Runner.java

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@
44
import java.util.List;
55
import picocli.CommandLine;
66

7-
/** An entrypoint for the codemodder framework. */
7+
/** Provides an entrypoint for CLIs built with the codemodder framework. */
88
public final class Runner {
99

1010
/**
11-
* Runs the default, Pixee-developed codemods.
11+
* Runs the codemods with a set of customized streams.
1212
*
13-
* @param codemods The codemods to run
14-
* @param args The arguments to pass to the codemod runner
13+
* @param codemods the codemods to run
14+
* @param args the arguments to pass to the codemod runner
1515
* @param stdout alternate stdout to use, or {@code null} to use the default
1616
* @param stderr alternate stderr to use, or {@code null} to use the default
1717
* @return the exit code of the codemodder CLI
@@ -33,6 +33,9 @@ public static int run(
3333
}
3434

3535
/**
36+
*
37+
* Runs the given codemods with CLI arguments you get from a main() method. This is the most like entry point you want to use.
38+
*
3639
* @see #run(List, String[], PrintWriter, PrintWriter)
3740
*/
3841
public static void run(final List<Class<? extends CodeChanger>> codemods, final String[] args) {

0 commit comments

Comments
 (0)