Skip to content

Commit

Permalink
Fix scaladoc
Browse files Browse the repository at this point in the history
  • Loading branch information
erikvanoosten committed Oct 20, 2024
1 parent 349d7c1 commit c78ec00
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 9 deletions.
10 changes: 5 additions & 5 deletions build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ lazy val gzip = projectMatrix
.dependsOn(core % "compile->compile;test->test")
.settings(commonSettings("gzip"))
.jvmPlatform(scalaVersions)
//.jsPlatform(scalaVersions)
//.jsPlatform(scalaVersions)

lazy val zip = projectMatrix
.in(file("zip"))
Expand Down Expand Up @@ -208,11 +208,11 @@ lazy val docs = project
scalacOptions -= "-Yno-imports",
scalacOptions -= "-Xfatal-warnings",
crossScalaVersions := List(_scala213),
projectName := "ZIO Streams Compress docs",
mainModuleName := "zio-streams-compress-docs",
projectStage := ProjectStage.Concept, // ProjectStage.ProductionReady,
projectName := "ZIO Streams Compress docs",
mainModuleName := "zio-streams-compress-docs",
projectStage := ProjectStage.Concept, // ProjectStage.ProductionReady,
ScalaUnidoc / unidoc / unidocProjectFilter := inProjects(core.jvm(_scala213)),
readmeCredits :=
"This library is heavily inspired by [fs2-compress](https://github.com/lhns/fs2-compress).",
readmeLicense += s"\n\nCopyright 2024-${java.time.Year.now()} Erik van Oosten and the zio-streams-compress contributors."
readmeLicense += s"\n\nCopyright 2024-${java.time.Year.now()} Erik van Oosten and the zio-streams-compress contributors.",
)
3 changes: 1 addition & 2 deletions bzip2/src/main/scala/zio/compress/Bzip2.scala
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@ object Bzip2Compressor {
/**
* Make a pipeline that accepts a stream of bytes and produces a stream with Bzip2 compressed bytes.
*
* Note: Bzip2 uses a lot of memory. See
* [[https://commons.apache.org/proper/commons-compress/apidocs/org/apache/commons/compress/compressors/bzip2/BZip2CompressorOutputStream.html javadoc of `BZip2CompressorOutputStream`]]
* Note: Bzip2 uses a lot of memory. See [[org.apache.commons.compress.compressors.bzip2.BZip2CompressorOutputStream]]
* for an overview of the required heap size for each block size.
*
* @param blockSize
Expand Down
4 changes: 2 additions & 2 deletions gzip/src/main/scala/zio/compress/Gzip.scala
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ object GzipCompressor {
private val CompressionStrategies = Seq(DefaultStrategy, Filtered, HuffmanOnly)

/**
* Converts a deflate compression level from `Int` to [[CompressionLevel]].
* Converts a deflate compression level from `Int` to [[zio.stream.compression.CompressionLevel]].
*
* @param level
* a deflate compression level, valid values: -1 (default), 0 (no compression), 1 (fastest) to 9 (best compression)
Expand All @@ -31,7 +31,7 @@ object GzipCompressor {
CompressionLevels.find(_.jValue == level)

/**
* Converts a deflate compression strategy from `Int` to [[CompressionStrategy]].
* Converts a deflate compression strategy from `Int` to [[zio.stream.compression.CompressionStrategy]].
*
* @param strategy
* a deflate compression strategy, valid values: 0 (default), 1 (filtered) or 2 (huffman only)
Expand Down

0 comments on commit c78ec00

Please sign in to comment.