Fix javadoc warnings.

build.xml

@@ -356,6 +356,7 @@
                 <include name="**"/>
             </packageset>
             <tag name="todo" description="To do:"/>
+            <tag name="note" description="Note:"/>
             <link href="${j2se_api}" />
             <header>
                 <![CDATA[

src/net/java/sip/communicator/impl/browserlauncher/BrowserLauncherImpl.java

@@ -16,7 +16,7 @@
  * an OS-specific associated browser.
  * 
  * @author Yana Stamcheva
- * @authro Lubomir Marinov
+ * @author Lubomir Marinov
  */
 public class BrowserLauncherImpl
     implements BrowserLauncherService

src/net/java/sip/communicator/impl/gui/main/call/conference/CallPeerMenu.java

@@ -183,10 +183,10 @@ public void peerImageChanged(CallPeerChangeEvent evt) {}
     public void peerTransportAddressChanged(CallPeerChangeEvent evt) {}
 
     /**
-     * Implements <tt>{@link PropertyChangeListener#
-     * propertyChange(PropertyChangeEvent)}</tt> in order to update the
-     * "Mute/Unmute" menu item to fit the current state of the mute property for
-     * this call peer.
+     * Implements <tt>
+     * {@link PropertyChangeListener#propertyChange(PropertyChangeEvent)}</tt>
+     * in order to update the "Mute/Unmute" menu item to fit the current state
+     * of the mute property for this call peer.
      *
      * @param evt the <tt>PropertyChangeEvent</tt> that notified us of the
      * property change

src/net/java/sip/communicator/impl/gui/main/chat/ChatConversationPanel.java

@@ -113,7 +113,7 @@ public class ChatConversationPanel
     private boolean scrollToBottomIsPending = false;
 
     /**
-     * The implementation of the routine which scrolls {@chatTextPane} to its
+     * The implementation of the routine which scrolls {@link #chatTextPane} to its
      * bottom.
      */
     private final Runnable scrollToBottomRunnable = new Runnable()

src/net/java/sip/communicator/impl/media/ArrayIOUtils.java

@@ -54,7 +54,7 @@ public static short readShort(byte[] input, int inputOffset)
     /**
      * Converts a short integer to a series of bytes and writes the result into
      * a specific output array of bytes starting the writing at a specific
-     * offset in it. The difference with {@link #writeShort(short, byte[], int)
+     * offset in it. The difference with {@link #writeShort(short, byte[], int)}
      * is that the input is an <tt>int</tt> and just two bytes of it are
      * written.
      * 

src/net/java/sip/communicator/impl/media/codec/audio/speex/JavaDecoder.java

@@ -59,8 +59,8 @@ public JavaDecoder()
 
     /**
      * Returns the output format that matches the supplied input format.
-     * @param in
-     * @return
+     * @param in input format
+     * @return array of formats that match input ones
      */
     protected Format[] getMatchingOutputFormats(Format in)
     {

src/net/java/sip/communicator/impl/media/codec/audio/speex/JavaEncoder.java

@@ -71,8 +71,8 @@ public JavaEncoder()
 
     /**
      * Returns the output format that matches the supplied input format.
-     * @param in
-     * @return
+     * @param in input format
+     * @return array of formats that match input ones
      */
     protected Format[] getMatchingOutputFormats(Format in)
     {

src/net/java/sip/communicator/impl/neomedia/ArrayIOUtils.java

@@ -54,7 +54,7 @@ public static short readShort(byte[] input, int inputOffset)
     /**
      * Converts a short integer to a series of bytes and writes the result into
      * a specific output array of bytes starting the writing at a specific
-     * offset in it. The difference with {@link #writeShort(short, byte[], int)
+     * offset in it. The difference with {@link #writeShort(short, byte[], int)}
      * is that the input is an <tt>int</tt> and just two bytes of it are
      * written.
      * 

src/net/java/sip/communicator/impl/neomedia/AudioMediaStreamImpl.java

@@ -214,11 +214,12 @@ public void stopSendingDTMF()
     }
 
     /**
-     * In addition to calling {@link MediaStreamImpl#
-     * addRTPExtension(byte, RTPExtension)} this method enables sending of
-     * CSRC audio levels. The reason we are doing this here rather than in the
-     * super class is that CSRC levels only make sense for audio streams so
-     * we don't want them enabled in any other kind.
+     * In addition to calling 
+     * {@link MediaStreamImpl#addRTPExtension(byte, RTPExtension)} 
+     * this method enables sending of CSRC audio levels. The reason we are 
+     * doing this here rather than in the super class is that CSRC levels only 
+     * make sense for audio streams so we don't want them enabled in any other 
+     * kind.
      *
      * @param extensionID the ID assigned to <tt>rtpExtension</tt> for the
      * lifetime of this stream.

src/net/java/sip/communicator/impl/neomedia/ZrtpControlImpl.java

@@ -116,7 +116,7 @@ public void setSASVerification(boolean verified)
 
     /**
      * Returns the zrtp engine currently used by this stream.
-     * @return
+     * @return the zrtp engine
      */
     public ZRTPTransformEngine getZrtpEngine()
     {

src/net/java/sip/communicator/impl/neomedia/codec/audio/speex/JavaDecoder.java

@@ -59,8 +59,8 @@ public JavaDecoder()
 
     /**
      * Returns the output format that matches the supplied input format.
-     * @param in
-     * @return
+     * @param in input format
+     * @return array of format that match input ones
      */
     protected Format[] getMatchingOutputFormats(Format in)
     {

src/net/java/sip/communicator/impl/neomedia/codec/audio/speex/JavaEncoder.java

@@ -71,8 +71,8 @@ public JavaEncoder()
 
     /**
      * Returns the output format that matches the supplied input format.
-     * @param in
-     * @return
+     * @param in input format
+     * @return array of formats that match input ones
      */
     protected Format[] getMatchingOutputFormats(Format in)
     {

src/net/java/sip/communicator/impl/neomedia/conference/InputDataSourceDesc.java

@@ -64,7 +64,7 @@ class InputDataSourceDesc
 
     /**
      * The <tt>AudioMixingPushBufferDataSource</tt> in which the mix
-     * contributions of {@link inputDataSource} are to not be included.
+     * contributions of {@link #inputDataSource} are to not be included.
      */
     public final AudioMixingPushBufferDataSource outputDataSource;
 

src/net/java/sip/communicator/impl/neomedia/control/AbstractFormatControl.java

@@ -27,7 +27,7 @@ public abstract class AbstractFormatControl
     private boolean enabled;
 
     /**
-     * Implements {@link Controls#getControlComponent()}. Returns <tt>null</tt>.
+     * Implements {@link Control#getControlComponent()}. Returns <tt>null</tt>.
      *
      * @return a <tt>Component</tt> which represents UI associated with this
      * instance if any; otherwise, <tt>null</tt>

src/net/java/sip/communicator/impl/neomedia/control/ControlsAdapter.java

@@ -23,9 +23,9 @@ public class ControlsAdapter
     public static final Object[] EMPTY_CONTROLS = new Object[0];
 
     /**
-     * Implements {@link Controls#getControls()}. Gets the controls available
-     * for the owner of this instance. The current implementation returns an
-     * empty array because it has no available controls.
+     * Implements {@link javax.media.Controls#getControls()}. Gets the controls
+     * available for the owner of this instance. The current implementation
+     * returns an empty array because it has no available controls.
      *
      * @return an array of <tt>Object</tt>s which represent the controls
      * available for the owner of this instance

src/net/java/sip/communicator/impl/neomedia/control/ReadOnlyBufferControlDelegate.java

@@ -49,7 +49,7 @@ public long getBufferLength()
     }
 
     /**
-     * Implements {@link Control#getControlComponent()}. Gets the UI
+     * Implements {@link javax.media.Control#getControlComponent()}. Gets the UI
      * <tt>Component</tt> representing this instance and exported by the owner
      * of the wrapped <tt>BufferControl</tt>.
      *

src/net/java/sip/communicator/impl/neomedia/control/ReadOnlyFormatControlDelegate.java

@@ -40,7 +40,7 @@ public ReadOnlyFormatControlDelegate(FormatControl formatControl)
     }
 
     /**
-     * Implements {@link Controls#getControlComponent()}.
+     * Implements {@link Control#getControlComponent()}.
      *
      * @return a <tt>Component</tt> which represents UI associated with this
      * instance if any; otherwise, <tt>null</tt>

src/net/java/sip/communicator/impl/neomedia/device/AudioMediaDeviceSession.java

@@ -56,7 +56,8 @@ protected AudioMediaDeviceSession(AbstractMediaDevice device)
     }
 
     /**
-     * Called by {@link MediaDeviceSession#addReceiveStream(ReceiveStream)} when the player associated with this session's
+     * Called by {@link MediaDeviceSession#createPlayer(DataSource dataSource)} 
+     * when the player associated with this session's
      * <tt>ReceiveStream</tt> moves enters the <tt>Configured</tt> state, so
      * we use the occasion to add our audio level effect.
      *

src/net/java/sip/communicator/impl/neomedia/device/ReceiveStreamPushBufferDataSource.java

@@ -17,7 +17,7 @@
  * is introduced because it seems that after the <tt>DataSource</tt> of a
  * <tt>ReceiveStream</tt> is disconnected, it cannot be connected to or started
  * and if a <tt>Processor</tt> is created on it, it freezes in the
- * {@link Processor#Configuring} state.
+ * {@link javax.media.Processor#Configuring} state.
  *
  * @author Lubomir Marinov
  */

src/net/java/sip/communicator/impl/neomedia/format/VideoMediaFormatImpl.java

@@ -188,7 +188,7 @@ public Dimension getSize()
      * Overrides <tt>MediaFormatImpl#hashCode()</tt> because
      * <tt>Object#equals(Object)</tt> is overridden.
      *
-     * @returns a hash code value for this <tt>VideoMediaFormatImpl</tt>
+     * @return a hash code value for this <tt>VideoMediaFormatImpl</tt>
      * @see MediaFormatImpl#hashCode()
      */
     @Override

src/net/java/sip/communicator/impl/neomedia/transform/zrtp/ZRTPTransformEngine.java

@@ -948,7 +948,7 @@ public void signSAS(String sas)
     /**
      * 
      * @param sas
-     * @return 
+     * @return false if signature check fails, true otherwise
      * @see gnu.java.zrtp.ZrtpCallback#checkSASSignature(java.lang.String)
      */
     public boolean checkSASSignature(String sas)

src/net/java/sip/communicator/impl/protocol/facebook/FacebookAdapter.java

@@ -206,10 +206,12 @@ public synchronized void shutdown()
     }
 
     /**
-     * 
-     * @param message
-     * @param to
-     * @return
+     * Post message to someone.
+     *
+     * @param message message to post
+     * @param to contact
+     * @return null if postMessage succeed, <tt>MessageDeliveryFailedEvent</tt>
+     * otherwise
      */
     public synchronized MessageDeliveryFailedEvent postMessage(
             Message message,

src/net/java/sip/communicator/impl/protocol/icq/AdHocChatRoomIcqImpl.java

@@ -273,10 +273,6 @@ public ProtocolProviderService getParentProvider()
      * <tt>ChatRoomPropertyChangelistener</tt> to this room.
      * <p>
      * 
-     * 
-     * To change the room's subject use {@link #setSubject(String)}. Note: Not
-     * possible inside the msn protocol!
-     * 
      * @return the room subject or <tt>null</tt> if the user hasn't joined the
      *         room or the room does not have a subject yet.
      */
@@ -309,7 +305,7 @@ public String getUserNickname()
      * @param userAddress the address of the user (email address) to invite to
      *            the room.(one may also invite users not on their contact
      *            list).
-     * @param reason You cannot specify a Reason inside the msn protocol
+     * @param reason invitation message
      */
     public void invite(String userAddress, String reason)
     {

src/net/java/sip/communicator/plugin/zrtpconfigure/ZrtpConfigureTableModel.java

@@ -132,7 +132,7 @@ public void setValueAt(Object value, int row, int column)
      *        Because the functions converts a move up into a move down
      *        this flag shows what the caller intented. Needed to adjust
      *        an index return value.
-     * @return
+     * @return new row index of entry
      */
     public int move(int row, boolean up, boolean upSave) {
         if (up) {