You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2023/03/18 12:56:11 UTC
[commons-compress] 23/35: Javadoc: Convert package.html to package-info.java
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-compress.git
commit cccf1166cf4ca2f5297e2e7b55b971e758142c99
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sat Mar 18 08:46:55 2023 -0400
Javadoc: Convert package.html to package-info.java
---
.../compress/compressors/snappy/package-info.java | 32 +++++++++++++++++
.../compress/compressors/snappy/package.html | 42 ----------------------
2 files changed, 32 insertions(+), 42 deletions(-)
diff --git a/src/main/java/org/apache/commons/compress/compressors/snappy/package-info.java b/src/main/java/org/apache/commons/compress/compressors/snappy/package-info.java
new file mode 100644
index 00000000..a376a0ec
--- /dev/null
+++ b/src/main/java/org/apache/commons/compress/compressors/snappy/package-info.java
@@ -0,0 +1,32 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+/**
+ * Provides stream classes for the <a href="https://github.com/google/snappy">Snappy</a> algorithm.
+ * <p>
+ * The raw Snappy format which only contains the compressed data is supported by the <code>SnappyCompressor*putStream</code> classes while the so called
+ * "framing format" is implemented by <code>FramedSnappyCompressor*putStream</code>. Note there have been different versions of the framing format
+ * specification, the implementation in Commons Compress is based on the specification "Last revised: 2013-10-25".
+ * </p>
+ * <p>
+ * Only the "framing format" can be auto-detected this means you have to speficy the format explicitly if you want to read a "raw" Snappy stream via
+ * <code>CompressorStreamFactory</code>.
+ * </p>
+ */
+package org.apache.commons.compress.compressors.snappy;
\ No newline at end of file
diff --git a/src/main/java/org/apache/commons/compress/compressors/snappy/package.html b/src/main/java/org/apache/commons/compress/compressors/snappy/package.html
deleted file mode 100644
index 74e51781..00000000
--- a/src/main/java/org/apache/commons/compress/compressors/snappy/package.html
+++ /dev/null
@@ -1,42 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<!--
-
- Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed with
- this work for additional information regarding copyright ownership.
- The ASF licenses this file to You under the Apache License, Version 2.0
- (the "License"); you may not use this file except in compliance with
- the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
-
--->
- <head>
- <title>snappy package</title>
- </head>
- <body>
- <p>Provides stream classes for the
- <a href="https://github.com/google/snappy">Snappy</a>
- algorithm.</p>
-
- <p>The raw Snappy format which only contains the compressed data
- is supported by the <code>SnappyCompressor*putStream</code>
- classes while the so called "framing format" is implemented
- by <code>FramedSnappyCompressor*putStream</code>. Note there
- have been different versions of the framing format specification,
- the implementation in Commons Compress is based on the
- specification "Last revised: 2013-10-25".</p>
-
- <p>Only the "framing format" can be auto-detected this means you
- have to speficy the format explicitly if you want to read a
- "raw" Snappy stream
- via <code>CompressorStreamFactory</code>.</p>
- </body>
-</html>