Fix some javadoc warnings.

6 files changed, 22 insertions, 15 deletions

diff --git a/src/net/java/sip/communicator/impl/neomedia/jmfext/media/protocol/directshow/DirectShowStream.java b/src/net/java/sip/communicator/impl/neomedia/jmfext/media/protocol/directshow/DirectShowStream.java
index 26aa4e0..1f5582d 100644
--- a/src/net/java/sip/communicator/impl/neomedia/jmfext/media/protocol/directshow/DirectShowStream.java
+++ b/src/net/java/sip/communicator/impl/neomedia/jmfext/media/protocol/directshow/DirectShowStream.java
@@ -28,8 +28,8 @@ public class DirectShowStream extends AbstractPushBufferStream
 

     /**

      * The pool of <tt>ByteBuffer</tt>s this instances is using to transfer the

-     * media data captured by {@link #captureOutput} out of this instance

-     * through the <tt>Buffer</tt>s specified in its {@link #process(Buffer)}.

+     * media data captured by {@link #grabber} out of this instance

+     * through the <tt>Buffer</tt>s specified in its {@link #read(Buffer)}.

      */

     private final ByteBufferPool bufferPool = new ByteBufferPool();

 

@@ -72,13 +72,13 @@ public class DirectShowStream extends AbstractPushBufferStream
      * The <tt>Thread</tt> which is to call

      * {@link BufferTransferHandler#transferData(PushBufferStream)} for this

      * <tt>DirectShowStream</tt> so that the call is not made in DirectShow

-     * and we can drop late frames when {@link #automaticallyDropsLateFrames} is

-     * <tt>false</tt>.

+     * and we can drop late frames when

+     * {@link #automaticallyDropsLateVideoFrames} is <tt>false</tt>.

      */

     private Thread transferDataThread;

 

     /**

-     * The indicator which determines whether {@link #captureOutput}

+     * The indicator which determines whether {@link #grabber}

      * automatically drops late frames. If <tt>false</tt>, we have to drop them

      * ourselves because DirectShow will buffer them all and the video will

      * be late.

@@ -332,7 +332,7 @@ public class DirectShowStream extends AbstractPushBufferStream
                 bufferPool.returnFreeBuffer(data);

                 data = null;

             }

-            

+

             if(nextData != null)

             {

                 bufferPool.returnFreeBuffer(nextData);

diff --git a/src/net/java/sip/communicator/impl/neomedia/jmfext/media/protocol/imgstreaming/DataSource.java b/src/net/java/sip/communicator/impl/neomedia/jmfext/media/protocol/imgstreaming/DataSource.java
index 7fc4117..6c93f28 100644
--- a/src/net/java/sip/communicator/impl/neomedia/jmfext/media/protocol/imgstreaming/DataSource.java
+++ b/src/net/java/sip/communicator/impl/neomedia/jmfext/media/protocol/imgstreaming/DataSource.java
@@ -6,13 +6,9 @@
  */
 package net.java.sip.communicator.impl.neomedia.jmfext.media.protocol.imgstreaming;
 
-import java.awt.*;
-
 import javax.media.*;
 import javax.media.control.*;
-import javax.media.format.*;
 
-import net.java.sip.communicator.impl.neomedia.codec.video.*;
 import net.java.sip.communicator.impl.neomedia.jmfext.media.protocol.*;
 
 /**
diff --git a/src/net/java/sip/communicator/impl/neomedia/jmfext/media/protocol/portaudio/DataSource.java b/src/net/java/sip/communicator/impl/neomedia/jmfext/media/protocol/portaudio/DataSource.java
index a22a7e8..4cc8ad5 100644
--- a/src/net/java/sip/communicator/impl/neomedia/jmfext/media/protocol/portaudio/DataSource.java
+++ b/src/net/java/sip/communicator/impl/neomedia/jmfext/media/protocol/portaudio/DataSource.java
@@ -67,9 +67,9 @@ public class DataSource
      * @param locator the <tt>MediaLocator</tt> to create the new instance from
      * @param supportedFormats the list of <tt>Format</tt>s in which the new
      * instance is to be capable of capturing audio data
-     * @param audioQuality <tt>true</tt> if audio quality improvement is to be
-     * enabled in accord with the preferences of the user or <tt>false</tt> to
-     * completely disable audio quality improvement
+     * @param audioQualityImprovement <tt>true</tt> if audio quality improvement
+     * is to be enabled in accord with the preferences of the user or
+     * <tt>false</tt> to completely disable audio quality improvement
      */
     public DataSource(
             MediaLocator locator,
diff --git a/src/net/java/sip/communicator/impl/neomedia/jmfext/media/protocol/portaudio/PortAudioStream.java b/src/net/java/sip/communicator/impl/neomedia/jmfext/media/protocol/portaudio/PortAudioStream.java
index ac3c1c6..06c4890 100644
--- a/src/net/java/sip/communicator/impl/neomedia/jmfext/media/protocol/portaudio/PortAudioStream.java
+++ b/src/net/java/sip/communicator/impl/neomedia/jmfext/media/protocol/portaudio/PortAudioStream.java
@@ -56,8 +56,14 @@ public class PortAudioStream
      */
     private int framesPerBuffer;
 
+    /**
+     * Native pointer to a PaStreamParameters object.
+     */
     private long inputParameters = 0;
 
+    /**
+     * Current sequence number.
+     */
     private int sequenceNumber = 0;
 
     /**
@@ -190,6 +196,7 @@ public class PortAudioStream
      *
      * @param deviceIndex the device index of the PortAudio device to be read
      * through this <tt>PullBufferStream</tt>
+     * @throws IOException if input/output error occurred
      */
     synchronized void setDeviceIndex(int deviceIndex)
         throws IOException
diff --git a/src/net/java/sip/communicator/impl/neomedia/jmfext/media/protocol/quicktime/QuickTimeStream.java b/src/net/java/sip/communicator/impl/neomedia/jmfext/media/protocol/quicktime/QuickTimeStream.java
index 9e8553e..0300804 100644
--- a/src/net/java/sip/communicator/impl/neomedia/jmfext/media/protocol/quicktime/QuickTimeStream.java
+++ b/src/net/java/sip/communicator/impl/neomedia/jmfext/media/protocol/quicktime/QuickTimeStream.java
@@ -105,8 +105,8 @@ public class QuickTimeStream
      * The <tt>Thread</tt> which is to call
      * {@link BufferTransferHandler#transferData(PushBufferStream)} for this
      * <tt>QuickTimeStream</tt> so that the call is not made in QuickTime/QTKit
-     * and we can drop late frames when {@link #automaticallyDropsLateFrames} is
-     * <tt>false</tt>.
+     * and we can drop late frames when
+     * {@link #automaticallyDropsLateVideoFrames} is <tt>false</tt>.
      */
     private Thread transferDataThread;
 
diff --git a/src/net/java/sip/communicator/impl/neomedia/jmfext/media/renderer/video/JAWTRenderer.java b/src/net/java/sip/communicator/impl/neomedia/jmfext/media/renderer/video/JAWTRenderer.java
index c31d3d8..971f16c 100644
--- a/src/net/java/sip/communicator/impl/neomedia/jmfext/media/renderer/video/JAWTRenderer.java
+++ b/src/net/java/sip/communicator/impl/neomedia/jmfext/media/renderer/video/JAWTRenderer.java
@@ -32,6 +32,9 @@ public class JAWTRenderer
      */
     private static final String PLUGIN_NAME = "JAWT Renderer";
 
+    /**
+     * Array of supported input formats.
+     */
     private static final Format[] SUPPORTED_INPUT_FORMATS
         = new Format[]
                 {
@@ -374,6 +377,7 @@ public class JAWTRenderer
      * <tt>offset</tt> which represent the data to be processed and rendered
      * @param width the width of the video frame in <tt>data</tt>
      * @param height the height of the video frame in <tt>data</tt>
+     * @return <tt>true</tt> if data has been successfully processed
      */
     private static native boolean process(
             long handle,