topjohnwu/libsu
1
0
Fork 0
mirror of https://github.com/topjohnwu/libsu.git synced 2024-10-07 09:13:23 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update Javadoc

Browse Source 
Make it more clear that no output will be produced by default in low level APIs
This commit is contained in:
topjohnwu 2019-02-15 13:00:00 -05:00
parent dba1f2ef76
commit 548c4e4e11
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
core/src/main/java/com/topjohnwu/superuser/Shell.java
View File

@ -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.
* <p>
* Be aware that unlike {@code Shell.su(...)/Shell.sh(...)}, <strong>NO</strong> 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();