From 5a3cb10bad7e7491ae03ffb690698f9c964a45f5 Mon Sep 17 00:00:00 2001
From: neil_a_wilson <neil_a_wilson@localhost>
Date: Thu, 31 Aug 2006 21:21:01 +0000
Subject: [PATCH] Update the MakeLDIF input stream to replace the references to "{@inheritDoc}" with actual documentation for InputStream methods. Because the source for the methods being overridden is not part of the project, the "{@inheritDoc}" notation won't work and will result in no Javadoc for the associated method.
---
opends/src/server/org/opends/server/tools/makeldif/MakeLDIFInputStream.java | 24 +++++++++++++++++++++---
1 files changed, 21 insertions(+), 3 deletions(-)
diff --git a/opends/src/server/org/opends/server/tools/makeldif/MakeLDIFInputStream.java b/opends/src/server/org/opends/server/tools/makeldif/MakeLDIFInputStream.java
index e69307a..d53db9c 100644
--- a/opends/src/server/org/opends/server/tools/makeldif/MakeLDIFInputStream.java
+++ b/opends/src/server/org/opends/server/tools/makeldif/MakeLDIFInputStream.java
@@ -119,7 +119,7 @@
/**
- * {@inheritDoc}
+ * Closes this input stream so that no more data may be read from it.
*/
public void close()
{
@@ -130,7 +130,13 @@
/**
- * {@inheritDoc}
+ * Reads a single byte of data from this input stream.
+ *
+ * @return The byte read from the input stream, or -1 if the end of the
+ * stream has been reached.
+ *
+ * @throws IOException If a problem has occurred while generating data for
+ * use by this input stream.
*/
public int read()
throws IOException
@@ -159,7 +165,19 @@
/**
- * {@inheritDoc}
+ * Reads data from this input stream.
+ *
+ * @param b The array into which the data should be read.
+ * @param off The position in the array at which point the data read may be
+ * placed.
+ * @param len The maximum number of bytes that may be read into the
+ * provided array.
+ *
+ * @return The number of bytes read from the input stream into the provided
+ * array, or -1 if the end of the stream has been reached.
+ *
+ * @throws IOException If a problem has occurred while generating data for
+ * use by this input stream.
*/
public int read(byte[] b, int off, int len)
throws IOException
--
Gitblit v1.10.0