From 548c4e4e1117027c732d4cce86a236129036754f Mon Sep 17 00:00:00 2001 From: topjohnwu Date: Fri, 15 Feb 2019 13:00:00 -0500 Subject: [PATCH] Update Javadoc Make it more clear that no output will be produced by default in low level APIs --- core/src/main/java/com/topjohnwu/superuser/Shell.java | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/core/src/main/java/com/topjohnwu/superuser/Shell.java b/core/src/main/java/com/topjohnwu/superuser/Shell.java index 4a30e79..43c69a9 100644 --- a/core/src/main/java/com/topjohnwu/superuser/Shell.java +++ b/core/src/main/java/com/topjohnwu/superuser/Shell.java @@ -376,7 +376,11 @@ public abstract class Shell implements Closeable { public abstract void execTask(@NonNull Task task) throws IOException; /** - * Construct a new {@link Job} that will use the shell. + * Construct a new {@link Job} that will use the shell for execution. + *

+ * Be aware that unlike {@code Shell.su(...)/Shell.sh(...)}, NO output will + * be produced if the developer did not set the output destination with {@link Job#to(List)} + * or {@link Job#to(List, List)}. * @return a job that the developer can execute or submit later. */ public abstract Job newJob();