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 2022/12/12 01:10:34 UTC
[commons-crypto] branch master updated: Javadoc
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-crypto.git
The following commit(s) were added to refs/heads/master by this push:
new 7b4d5be Javadoc
7b4d5be is described below
commit 7b4d5bee79c8ef5c0463fc4b820ea407c6b223ca
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sun Dec 11 20:10:30 2022 -0500
Javadoc
---
.../org/apache/commons/crypto/stream/input/ChannelInput.java | 8 +++++---
.../java/org/apache/commons/crypto/stream/input/Input.java | 10 +++++++---
.../org/apache/commons/crypto/stream/input/StreamInput.java | 6 ++++--
.../org/apache/commons/crypto/stream/output/ChannelOutput.java | 6 ++++--
.../java/org/apache/commons/crypto/stream/output/Output.java | 10 +++++++---
.../org/apache/commons/crypto/stream/output/StreamOutput.java | 6 ++++--
6 files changed, 31 insertions(+), 15 deletions(-)
diff --git a/src/main/java/org/apache/commons/crypto/stream/input/ChannelInput.java b/src/main/java/org/apache/commons/crypto/stream/input/ChannelInput.java
index b2f26c0..e820e25 100644
--- a/src/main/java/org/apache/commons/crypto/stream/input/ChannelInput.java
+++ b/src/main/java/org/apache/commons/crypto/stream/input/ChannelInput.java
@@ -21,10 +21,12 @@ import java.io.IOException;
import java.nio.ByteBuffer;
import java.nio.channels.ReadableByteChannel;
+import org.apache.commons.crypto.stream.CryptoInputStream;
+
/**
- * The ChannelInput class takes a {@code ReadableByteChannel} object and
- * wraps it as {@code Input} object acceptable by
- * {@code CryptoInputStream}.
+ * The ChannelInput class takes a {@link ReadableByteChannel} object and
+ * wraps it as {@link Input} object acceptable by
+ * {@link CryptoInputStream}.
*/
public class ChannelInput implements Input {
private static final int SKIP_BUFFER_SIZE = 2048;
diff --git a/src/main/java/org/apache/commons/crypto/stream/input/Input.java b/src/main/java/org/apache/commons/crypto/stream/input/Input.java
index b7d6f92..8e1b605 100644
--- a/src/main/java/org/apache/commons/crypto/stream/input/Input.java
+++ b/src/main/java/org/apache/commons/crypto/stream/input/Input.java
@@ -19,14 +19,18 @@ package org.apache.commons.crypto.stream.input;
import java.io.Closeable;
import java.io.IOException;
+import java.io.InputStream;
import java.nio.ByteBuffer;
+import java.nio.channels.ReadableByteChannel;
+
+import org.apache.commons.crypto.stream.CryptoInputStream;
/**
* The Input interface abstract the input source of
- * {@code CryptoInputStream} so that different implementation of input can
+ * {@link CryptoInputStream} so that different implementation of input can
* be used. The implementation Input interface will usually wraps an input
- * mechanism such as {@code InputStream} or
- * {@code ReadableByteChannel}.
+ * mechanism such as {@link InputStream} or
+ * {@link ReadableByteChannel}.
*/
public interface Input extends Closeable {
/**
diff --git a/src/main/java/org/apache/commons/crypto/stream/input/StreamInput.java b/src/main/java/org/apache/commons/crypto/stream/input/StreamInput.java
index 38d542c..9dce567 100644
--- a/src/main/java/org/apache/commons/crypto/stream/input/StreamInput.java
+++ b/src/main/java/org/apache/commons/crypto/stream/input/StreamInput.java
@@ -23,9 +23,11 @@ import java.io.IOException;
import java.io.InputStream;
import java.nio.ByteBuffer;
+import org.apache.commons.crypto.stream.CryptoInputStream;
+
/**
- * The StreamInput class takes a {@code InputStream} object and wraps it as
- * {@code Input} object acceptable by {@code CryptoInputStream}.
+ * The StreamInput class takes a {@link InputStream} object and wraps it as
+ * {@link Input} object acceptable by {@link CryptoInputStream}.
*/
public class StreamInput implements Input {
diff --git a/src/main/java/org/apache/commons/crypto/stream/output/ChannelOutput.java b/src/main/java/org/apache/commons/crypto/stream/output/ChannelOutput.java
index 8f517c8..9fcf3a3 100644
--- a/src/main/java/org/apache/commons/crypto/stream/output/ChannelOutput.java
+++ b/src/main/java/org/apache/commons/crypto/stream/output/ChannelOutput.java
@@ -21,10 +21,12 @@ import java.io.IOException;
import java.nio.ByteBuffer;
import java.nio.channels.WritableByteChannel;
+import org.apache.commons.crypto.stream.CryptoOutputStream;
+
/**
- * The ChannelOutput class takes a {@code WritableByteChannel} object and
+ * The ChannelOutput class takes a {@link WritableByteChannel} object and
* wraps it as {@code Output} object acceptable by
- * {@code CryptoOutputStream} as the output target.
+ * {@link CryptoOutputStream} as the output target.
*/
public class ChannelOutput implements Output {
diff --git a/src/main/java/org/apache/commons/crypto/stream/output/Output.java b/src/main/java/org/apache/commons/crypto/stream/output/Output.java
index 7df87fa..d5ecc35 100644
--- a/src/main/java/org/apache/commons/crypto/stream/output/Output.java
+++ b/src/main/java/org/apache/commons/crypto/stream/output/Output.java
@@ -19,14 +19,18 @@ package org.apache.commons.crypto.stream.output;
import java.io.Closeable;
import java.io.IOException;
+import java.io.OutputStream;
import java.nio.ByteBuffer;
+import java.nio.channels.WritableByteChannel;
+
+import org.apache.commons.crypto.stream.CryptoOutputStream;
/**
* The Output interface abstract the output target of
- * {@code CryptoOutputStream} so that different implementation of output
+ * {@link CryptoOutputStream} so that different implementation of output
* can be used. The implementation Output interface will usually wraps an output
- * mechanism such as {@code OutputStream} or
- * {@code WritableByteChannel}.
+ * mechanism such as {@link OutputStream} or
+ * {@link WritableByteChannel}.
*/
public interface Output extends Closeable {
diff --git a/src/main/java/org/apache/commons/crypto/stream/output/StreamOutput.java b/src/main/java/org/apache/commons/crypto/stream/output/StreamOutput.java
index 6803f2b..d77321d 100644
--- a/src/main/java/org/apache/commons/crypto/stream/output/StreamOutput.java
+++ b/src/main/java/org/apache/commons/crypto/stream/output/StreamOutput.java
@@ -21,9 +21,11 @@ import java.io.IOException;
import java.io.OutputStream;
import java.nio.ByteBuffer;
+import org.apache.commons.crypto.stream.CryptoOutputStream;
+
/**
- * The StreamOutput class takes a {@code OutputStream} object and wraps it
- * as {@code Output} object acceptable by {@code CryptoOutputStream}
+ * The StreamOutput class takes a {@link OutputStream} object and wraps it
+ * as {@link Output} object acceptable by {@link CryptoOutputStream}
* as the output target.
*/
public class StreamOutput implements Output {