Skip to content

Commit 4df7a03

Browse files
committed
updated javadoc
1 parent 0c7c791 commit 4df7a03

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

apache-rat-core/src/main/java/org/apache/rat/ReportConfiguration.java

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -887,12 +887,22 @@ static IODescriptor<OutputStream> output(final String name, final DocumentName w
887887
return new IODescriptor<>(name, () -> new FileOutputStream(docName.asFile()));
888888
}
889889

890+
/**
891+
* Creates an output IODescriptor for the file. Does not modify for working directory..
892+
* @param file the file to open.
893+
* @return the Output IODescriptor.
894+
*/
890895
static IODescriptor<OutputStream> output(final File file) {
891896
return new IODescriptor<>(file.toString(), () -> new FileOutputStream(file, true));
892897
}
893898

894899
// INPUT CONSTRUCTORS
895900

901+
/**
902+
* Creates an input IODescriptor for the file. Does not modify for working directory.
903+
* @param file the file to open.
904+
* @return the Input IODescriptor.
905+
*/
896906
static IODescriptor<InputStream> input(final File file) {
897907
return new IODescriptor<>(file.toString(), () -> new FileInputStream(file));
898908
}

0 commit comments

Comments
 (0)