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-io.git
commit d51704fa1cda6794482140a829670ec1a85600ae Author: Gary Gregory <garydgreg...@gmail.com> AuthorDate: Sun Mar 19 09:27:03 2023 -0400 Javadoc: Convert package.html to package-info.java --- .../java/org/apache/commons/io/package-info.java | 37 +++++++++++++++++ src/main/java/org/apache/commons/io/package.html | 47 ---------------------- 2 files changed, 37 insertions(+), 47 deletions(-) diff --git a/src/main/java/org/apache/commons/io/package-info.java b/src/main/java/org/apache/commons/io/package-info.java new file mode 100644 index 00000000..d7c21650 --- /dev/null +++ b/src/main/java/org/apache/commons/io/package-info.java @@ -0,0 +1,37 @@ +/* + * 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. + */ + +/** + * This package defines utility classes for working with streams, readers, writers and files. The most commonly used classes are described here: + * <p> + * <b>IOUtils</b> is the most frequently used class. It provides operations to read, write, copy and close streams. + * </p> + * <p> + * <b>FileUtils</b> provides operations based around the JDK File class. These include reading, writing, copying, comparing and deleting. + * </p> + * <p> + * <b>FilenameUtils</b> provides utilities based on filenames. This utility class manipulates filenames without using File objects. It aims to simplify the + * transition between Windows and Unix. Before using this class however, you should consider whether you should be using File objects. + * </p> + * <p> + * <b>FileSystemUtils</b> allows access to the filing system in ways the JDK does not support. At present this allows you to get the free space on a drive. + * </p> + * <p> + * <b>EndianUtils</b> swaps data between Big-Endian and Little-Endian formats. + * </p> + */ +package org.apache.commons.io; diff --git a/src/main/java/org/apache/commons/io/package.html b/src/main/java/org/apache/commons/io/package.html deleted file mode 100644 index 914a0a60..00000000 --- a/src/main/java/org/apache/commons/io/package.html +++ /dev/null @@ -1,47 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//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. ---> -<html> -<body bgcolor="white"> -<p> -This package defines utility classes for working with streams, readers, -writers and files. The most commonly used classes are described here: -</p> -<p> -<b>IOUtils</b> is the most frequently used class. -It provides operations to read, write, copy and close streams. -</p> -<p> -<b>FileUtils</b> provides operations based around the JDK File class. -These include reading, writing, copying, comparing and deleting. -</p> -<p> -<b>FilenameUtils</b> provides utilities based on filenames. -This utility class manipulates filenames without using File objects. -It aims to simplify the transition between Windows and Unix. -Before using this class however, you should consider whether you should -be using File objects. -</p> -<p> -<b>FileSystemUtils</b> allows access to the filing system in ways the JDK -does not support. At present this allows you to get the free space on a drive. -</p> -<p> -<b>EndianUtils</b> swaps data between Big-Endian and Little-Endian formats. -</p> -</body> -</html>