Skip to content

Commit

Permalink
Remove self closing paragraph tags in javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
thrau committed Jun 27, 2018
1 parent 6511373 commit 0688826
Show file tree
Hide file tree
Showing 9 changed files with 18 additions and 18 deletions.
4 changes: 2 additions & 2 deletions src/main/java/org/rauschig/jarchivelib/ArchiveEntry.java
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

/**
* The entry of an archive.
* <p/>
*
* The life of an {@link ArchiveEntry} is dependent on the status of the {@link ArchiveStream} it came from. Once
* retrieved via {@link ArchiveStream#getNextEntry()}, the entry can be used as long as the {@code ArchiveStream}
* remains on this entry, i.e. {@code getNextEntry()} was not called, and the stream was not since closed.
Expand Down Expand Up @@ -63,7 +63,7 @@ public interface ArchiveEntry {

/**
* Extracts the entry to the given destination directory.
* <p/>
*
* The destination is expected to be a writable directory.
*
* @param destination the directory to extract the value to
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/rauschig/jarchivelib/ArchiveStream.java
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

/**
* An input stream of an archive. Can be used to retrieve each individual {@link ArchiveEntry}.
* <p/>
* <br>
* The {@link #getNextEntry()} method is used to reset the input stream ready for reading the data from the next entry.
*/
public abstract class ArchiveStream extends InputStream implements Closeable {
Expand Down
14 changes: 7 additions & 7 deletions src/main/java/org/rauschig/jarchivelib/Archiver.java
Original file line number Diff line number Diff line change
Expand Up @@ -22,17 +22,17 @@
/**
* An Archiver facades a specific archiving library, allowing for simple archiving of files and directories, and
* extraction of archives.
* <p/>
* <br>
* Some archivers might use an additional {@link Compressor} to compress and decompress their respective archive files.
*/
public interface Archiver {

/**
* Creates an archive from the given source file or directory, and saves it into the given destination.
* <p/>
* <br>
* If the source is a directory, the archive will contain all the files in that directory, but not the directory
* itself.
* <p/>
* <br>
* If the archive parameter has no file extension (e.g. "archive" instead of "archive.zip"), the concrete archiver
* implementation should append it according to its file format (.zip, .tar, .tar.gz, ...).
*
Expand All @@ -46,10 +46,10 @@ public interface Archiver {

/**
* Creates an archive from the given source files or directories, and saves it into the given destination.
* <p/>
* <br>
* If the source is a directory, the archive will contain all the files in that directory, but not the directory
* itself.
* <p/>
* <br>
* If the archive parameter has no file extension (e.g. "archive" instead of "archive.zip"), the concrete archiver
* implementation should append it according to its file format (.zip, .tar, .tar.gz, ...).
*
Expand All @@ -63,7 +63,7 @@ public interface Archiver {

/**
* Extracts the given archive file into the given destination directory.
* <p/>
* <br>
* The destination is expected to be a writable directory.
*
* @param archive the archive file to extract
Expand All @@ -74,7 +74,7 @@ public interface Archiver {

/**
* Extracts the given archive supplied as an input stream into the given destination directory.
* <p/>
* <br>
* The destination directory is expected to be a writable directory.
*
* @param archive the archive contents as a stream.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ public String getFilenameExtension() {
/**
* Returns a file name from the given archive name. The file extension suffix will be appended according to what is
* already present.
* <p/>
* <br>
* E.g. if the compressor uses the file extension "gz", the archiver "tar", and passed argument is "archive.tar",
* the returned value will be "archive.tar.gz".
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ protected File createNewArchiveFile(String archive, String extension, File desti

/**
* Recursion entry point for {@link #writeToArchive(File, File[], ArchiveOutputStream)}.
* <p/>
* <br>
* Recursively writes all given source {@link File}s into the given {@link ArchiveOutputStream}.
*
* @param sources the files to write in to the archive
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/org/rauschig/jarchivelib/Compressor.java
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ public interface Compressor {

/**
* Compresses the given input file to the given destination directory or file.
* <p/>
* <br>
* Requires the source the be an existing and readable File, and the destination to be either a file or a directory.
* If you pass a directory, the name of the source file is used, with the appended filename extension suffix of the
* compression type.
Expand All @@ -40,7 +40,7 @@ public interface Compressor {

/**
* Decompresses the given source file to the given destination directory or file.
* <p/>
* <br>
* Requires the source the be an existing and readable File, and the destination to be either a file or a directory.
* If you pass a directory, the name of the source file is used, with the removed filename extension suffix of the
* compression type.
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/org/rauschig/jarchivelib/IOUtils.java
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ public static long copy(final InputStream input, final OutputStream output, int

/**
* Computes the path name of a file node relative to a given root node.
* <p/>
* <br>
* If the root is {@code /home/cdlflex/custom-ahy} and the given node is
* {@code /home/cdlflex/custom-ahy/assembly/pom.xml}, the returned path name will be {@code assembly/pom.xml}.
*
Expand All @@ -107,7 +107,7 @@ public static String relativePath(File root, File node) throws IOException {
/**
* Makes sure that the given {@link File} is either a writable directory, or that it does not exist and a directory
* can be created at its path.
* <p/>
* <br>
* Will throw an exception if the given {@link File} is actually an existing file, or the directory is not writable
*
* @param destination the directory which to ensure its existence for
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/rauschig/jarchivelib/SevenZArchiver.java
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
/**
* Archiver to handle 7z archives. commons-compress does not handle 7z over ArchiveStreams, so we need this custom
* implementation.
* <p/>
* <br>
* Basically this could disperse by adapting the CommonsStreamFactory, but this seemed more convenient as we also have
* both Input and Output stream wrappers capsuled here.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ public abstract class AbstractResourceTest {
* <li>src/test/resources/archives/archive/folder/subfolder/subfolder_file.txt</li>
* <li>src/test/resources/archives/archive/file.txt</li>
* </ul>
* <p/>
* <br>
* Used both as reference to compare whether extraction was successful, and used as source for compression tests.
*/
public static final File ARCHIVE_DIR = new File(RESOURCES_DIR, "archive");
Expand Down

0 comments on commit 0688826

Please sign in to comment.