diff options
author | Jim Lawson <ucbjrl@berkeley.edu> | 2018-10-09 13:48:17 -0700 |
---|---|---|
committer | Tobias Roeser <le.petit.fou@web.de> | 2018-10-28 22:20:34 +0100 |
commit | 30983430f587216068e39a06c3e61b8a235f0bdd (patch) | |
tree | d30408bf7a22d37f8f9189d7d0b4c5ed067d27fb /main/src | |
parent | dc9b21e67bc8f926a6a3f81cb45d70743cabe809 (diff) | |
download | mill-30983430f587216068e39a06c3e61b8a235f0bdd.tar.gz mill-30983430f587216068e39a06c3e61b8a235f0bdd.tar.bz2 mill-30983430f587216068e39a06c3e61b8a235f0bdd.zip |
Add createJar() ScalaDoc
Diffstat (limited to 'main/src')
-rw-r--r-- | main/src/mill/modules/Jvm.scala | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/main/src/mill/modules/Jvm.scala b/main/src/mill/modules/Jvm.scala index b4f7fa94..4c26b297 100644 --- a/main/src/mill/modules/Jvm.scala +++ b/main/src/mill/modules/Jvm.scala @@ -209,6 +209,19 @@ object Jvm { m } + /** + * Create a jar file containing all files from the specified input Paths, + * called out.jar in the implicit ctx.dest folder. An optional main class may + * be provided for the jar. An optional filter function may also be provided to + * selectively include/exclude specific files. + * @param inputPaths - `Agg` of `Path`s containing files to be included in the jar + * @param mainClass - optional main class for the jar + * @param fileFilter - optional file filter to select files to be included. + * Given a `Path` (from inputPaths) and a `RelPath` for the individual file, + * return true if the file is to be included in the jar. + * @param ctx - implicit `Ctx.Dest` used to determine the output directory for the jar. + * @return - a `PathRef` for the created jar. + */ def createJar(inputPaths: Agg[Path], mainClass: Option[String] = None, fileFilter: (Path, RelPath) => Boolean = (p: Path, r: RelPath) => true) |