Remove unsupported doc annotation

zio · Oct 23, 2024 · bb031fa · bb031fa
1 parent 3c6426e
commit bb031fa
Show file tree

Hide file tree

Showing 13 changed files with 0 additions and 30 deletions.
diff --git a/brotli/src/main/scala/zio/compress/Brotli.scala b/brotli/src/main/scala/zio/compress/Brotli.scala
@@ -28,7 +28,6 @@ object BrotliDecompressor {
 //noinspection ScalaFileName
 final class BrotliDecompressor private (customDictionary: Option[Array[Byte]], chunkSize: Int) extends Decompressor {
 
-  /** @inheritdoc */
   override def decompress(implicit trace: Trace): ZPipeline[Any, Throwable, Byte, Byte] =
     // BrotliInputStream.read does its best to read as many bytes as requested; no buffering needed.
     viaInputStreamByte(chunkSize) { inputStream =>

diff --git a/brotli4j/src/main/scala/zio/compress/Brotli4J.scala b/brotli4j/src/main/scala/zio/compress/Brotli4J.scala
@@ -36,7 +36,6 @@ final class Brotli4JCompressor private (
   mode: Option[BrotliMode],
 ) extends Compressor {
 
-  /** @inheritdoc */
   override def compress(implicit trace: Trace): ZPipeline[Any, Throwable, Byte, Byte] =
     BrotliLoader.ensureAvailability() >>>
       viaOutputStreamByte { outputStream =>
@@ -71,7 +70,6 @@ object Brotli4JDecompressor {
 
 final class Brotli4JDecompressor private (chunkSize: Int) extends Decompressor {
 
-  /** @inheritdoc */
   override def decompress(implicit trace: Trace): ZPipeline[Any, Throwable, Byte, Byte] =
     BrotliLoader.ensureAvailability() >>>
       viaInputStreamByte(chunkSize) { inputStream =>

diff --git a/build.sbt b/build.sbt
@@ -49,15 +49,6 @@ inThisBuild(
 
 def commonSettings(projectName: String) = Seq(
   name := s"zio-streams-compress-$projectName",
-//    Compile / compile / scalacOptions ++=
-//      optionsOn("2.13")("-Wconf:cat=unused-nowarn:s").value,
-  // scalacOptions -= "-Xlint:infer-any",
-  // workaround for bad constant pool issue
-  //  (Compile / doc) := Def.taskDyn {
-  //    val default = (Compile / doc).taskValue
-  //    Def.task(default.value)
-  //  }.value,
-  //  Test / scalaJSLinkerConfig ~= (_.withModuleKind(ModuleKind.CommonJSModule)),
   libraryDependencies ++= Seq(
     "dev.zio" %%% "zio-test" % V.zio % Test,
     "dev.zio" %%% "zio-test-sbt" % V.zio % Test,

diff --git a/bzip2/src/main/scala/zio/compress/Bzip2.scala b/bzip2/src/main/scala/zio/compress/Bzip2.scala
@@ -25,7 +25,6 @@ object Bzip2Compressor {
 
 final class Bzip2Compressor private (blockSize: Option[Bzip2BlockSize]) extends Compressor {
 
-  /** @inheritdoc */
   override def compress(implicit trace: Trace): ZPipeline[Any, Throwable, Byte, Byte] =
     viaOutputStreamByte { outputStream =>
       blockSize match {
@@ -51,7 +50,6 @@ object Bzip2Decompressor {
 
 final class Bzip2Decompressor private (chunkSize: Int) extends Decompressor {
 
-  /** @inheritdoc */
   override def decompress(implicit trace: Trace): ZPipeline[Any, Throwable, Byte, Byte] =
     // BrotliInputStream.read does its best to read as many bytes as requested; no buffering needed.
     viaInputStreamByte(chunkSize)(new BZip2CompressorInputStream(_))

diff --git a/core/src/main/scala/zio/compress/ArchiveSingleFile.scala b/core/src/main/scala/zio/compress/ArchiveSingleFile.scala
@@ -8,7 +8,6 @@ final class ArchiveSingleFileCompressor[Size[A] <: Option[A]] private (
   entry: ArchiveEntry[Size, Any],
 ) extends Compressor {
 
-  /** @inheritdoc */
   override def compress(implicit trace: Trace): ZPipeline[Any, Throwable, Byte, Byte] =
     ZPipeline.fromFunction { stream =>
       ZStream((entry, stream)).via(archiver.archive)
@@ -33,7 +32,6 @@ final class ArchiveSingleFileDecompressor[Size[A] <: Option[A], Underlying] priv
   unarchiver: Unarchiver[Size, Underlying]
 ) extends Decompressor {
 
-  /** @inheritdoc */
   override def decompress(implicit trace: Trace): ZPipeline[Any, Throwable, Byte, Byte] =
     ZPipeline.fromFunction { stream =>
       stream

diff --git a/core/src/main/scala/zio/compress/Compressor.scala b/core/src/main/scala/zio/compress/Compressor.scala
@@ -14,7 +14,6 @@ object Compressor extends Serializable {
   /** A compressor that does nothing; it passes all bytes through unchanged. */
   def empty: Compressor = new Compressor {
 
-    /** @inheritdoc */
     override def compress(implicit trace: Trace): ZPipeline[Any, Nothing, Byte, Byte] =
       ZPipeline.identity
   }

diff --git a/core/src/main/scala/zio/compress/Decompressor.scala b/core/src/main/scala/zio/compress/Decompressor.scala
@@ -14,7 +14,6 @@ object Decompressor {
   /** A decompressor that does nothing; it passes all bytes through unchanged. */
   def empty: Decompressor = new Decompressor {
 
-    /** @inheritdoc */
     override def decompress(implicit trace: Trace): ZPipeline[Any, Nothing, Byte, Byte] =
       ZPipeline.identity
   }

diff --git a/gzip/src/main/scala/zio/compress/Gzip.scala b/gzip/src/main/scala/zio/compress/Gzip.scala
@@ -32,7 +32,6 @@ final class GzipCompressor private (
   bufferSize: Int,
 ) extends Compressor {
 
-  /** @inheritdoc */
   override def compress(implicit trace: Trace): ZPipeline[Any, Nothing, Byte, Byte] =
     ZPipeline.gzip(
       bufferSize,
@@ -57,7 +56,6 @@ object GzipDecompressor {
 
 final class GzipDecompressor private (bufferSize: Int) extends Decompressor {
 
-  /** @inheritdoc */
   override def decompress(implicit trace: Trace): ZPipeline[Any, Throwable, Byte, Byte] =
     ZPipeline.gunzip(bufferSize)
 }

diff --git a/lz4/src/main/scala/zio/compress/Lz4.scala b/lz4/src/main/scala/zio/compress/Lz4.scala
@@ -26,7 +26,6 @@ object Lz4Compressor {
 
 final class Lz4Compressor private (blockSize: Lz4CompressorBlockSize) extends Compressor {
 
-  /** @inheritdoc */
   override def compress(implicit trace: Trace): ZPipeline[Any, Throwable, Byte, Byte] = {
     val lz4BlockSize = blockSize match {
       case Lz4CompressorBlockSize.BlockSize64KiB  => BLOCKSIZE.SIZE_64KB
@@ -54,7 +53,6 @@ object Lz4Decompressor {
 
 final class Lz4Decompressor private (chunkSize: Int) extends Decompressor {
 
-  /** @inheritdoc */
   override def decompress(implicit trace: Trace): ZPipeline[Any, Throwable, Byte, Byte] =
     // LZ4FrameInputStream.read does not try to read the requested number of bytes, but it does have a good
     // `available()` implementation, so with buffering we can still get full chunks.

diff --git a/tar/src/main/scala/zio/compress/Tar.scala b/tar/src/main/scala/zio/compress/Tar.scala
@@ -28,7 +28,6 @@ object TarArchiver {
 
 final class TarArchiver private extends Archiver[Some] {
 
-  /** @inheritdoc */
   override def archive(implicit
     trace: Trace
   ): ZPipeline[Any, Throwable, (ArchiveEntry[Some, Any], ZStream[Any, Throwable, Byte]), Byte] =
@@ -65,7 +64,6 @@ object TarUnarchiver {
 
 final class TarUnarchiver private (chunkSize: Int) extends Unarchiver[Option, TarArchiveEntry] {
 
-  /** @inheritdoc */
   override def unarchive(implicit
     trace: Trace
   ): ZPipeline[Any, Throwable, Byte, (ArchiveEntry[Option, TarArchiveEntry], ZStream[Any, IOException, Byte])] =

diff --git a/zip/src/main/scala/zio/compress/Zip.scala b/zip/src/main/scala/zio/compress/Zip.scala
@@ -37,7 +37,6 @@ final class ZipArchiver private (
   zipMethod: Option[ZipMethod],
 ) extends Archiver[Option] {
 
-  /** @inheritdoc */
   override def archive(implicit
     trace: Trace
   ): ZPipeline[Any, Throwable, (ArchiveEntry[Option, Any], ZStream[Any, Throwable, Byte]), Byte] =
@@ -82,7 +81,6 @@ object ZipUnarchiver {
 
 final class ZipUnarchiver private (chunkSize: Int) extends Unarchiver[Option, ZipEntry] {
 
-  /** @inheritdoc */
   override def unarchive(implicit
     trace: Trace
   ): ZPipeline[Any, Throwable, Byte, (ArchiveEntry[Option, ZipEntry], ZStream[Any, IOException, Byte])] =

diff --git a/zip4j/src/main/scala/zio/compress/Zip4J.scala b/zip4j/src/main/scala/zio/compress/Zip4J.scala
@@ -32,7 +32,6 @@ object Zip4JArchiver {
 
 final class Zip4JArchiver private (password: => Option[String]) extends Archiver[Some] {
 
-  /** @inheritdoc */
   override def archive(implicit
     trace: Trace
   ): ZPipeline[Any, Throwable, (ArchiveEntry[Some, Any], ZStream[Any, Throwable, Byte]), Byte] =
@@ -77,7 +76,6 @@ object Zip4JUnarchiver {
 final class Zip4JUnarchiver private (password: Option[String], chunkSize: Int)
     extends Unarchiver[Option, LocalFileHeader] {
 
-  /** @inheritdoc */
   override def unarchive(implicit
     trace: Trace
   ): ZPipeline[Any, Throwable, Byte, (ArchiveEntry[Option, LocalFileHeader], ZStream[Any, IOException, Byte])] =

diff --git a/zstd/src/main/scala/zio/compress/Zstd.scala b/zstd/src/main/scala/zio/compress/Zstd.scala
@@ -37,7 +37,6 @@ final class ZstdCompressor private (
   customDictionary: Option[Array[Byte]],
 ) extends Compressor {
 
-  /** @inheritdoc */
   override def compress(implicit trace: Trace): ZPipeline[Any, Throwable, Byte, Byte] =
     viaOutputStreamByte { outputStream =>
       val zstdOutputStream = new ZstdOutputStream(outputStream)
@@ -64,7 +63,6 @@ object ZstdDecompressor {
 
 final class ZstdDecompressor private (chunkSize: Int) extends Decompressor {
 
-  /** @inheritdoc */
   override def decompress(implicit trace: Trace): ZPipeline[Any, Throwable, Byte, Byte] =
     // ZstdInputStream.read does not try to read the requested number of bytes, but it does have a good
     // `available()` implementation, so with buffering we can still get full chunks.