Javadoc fixes in recently committed code.

src/net/java/sip/communicator/plugin/otr/OtrContactMenu.java

@@ -56,7 +56,7 @@ class OtrContactMenu
 
     /**
      * We keep this variable so we can determine if the policy has changed 
-     * or not in in {@link OtrContactMenu#setOtrPolicy(OtrPolicy)}.
+     * or not in {@link OtrContactMenu#setOtrPolicy(OtrPolicy)}.
      */
     private OtrPolicy otrPolicy;
 
@@ -65,9 +65,9 @@ class OtrContactMenu
     /**
      * The OtrContactMenu contructor.
      * 
-     * @param contact the Contact this menu referes to.
-     * @param inMacOSXScreenMenuBar a {@link boolean} that indicates whether the
-     *            menu is displayed in a Mac OS X sreen menubar or not.
+     * @param contact the Contact this menu refers to.
+     * @param inMacOSXScreenMenuBar <tt>true</tt> if the new menu is to be
+     * displayed in the Mac OS X screen menu bar; <tt>false</tt>, otherwise
      */
     public OtrContactMenu(Contact contact, boolean inMacOSXScreenMenuBar)
     {
@@ -367,8 +367,9 @@ private void updateIcon()
         switch (sessionStatus)
         {
         case ENCRYPTED:
-            imageID =
-                OtrActivator.scOtrKeyManager.isVerified(contact) ? "plugin.otr.ENCRYPTED_ICON_16x16"
+            imageID
+                = OtrActivator.scOtrKeyManager.isVerified(contact)
+                    ? "plugin.otr.ENCRYPTED_ICON_16x16"
                     : "plugin.otr.ENCRYPTED_UNVERIFIED_ICON_16x16";
             break;
 

src/net/java/sip/communicator/plugin/otr/OtrMetaContactButton.java

@@ -32,34 +32,38 @@ public class OtrMetaContactButton
 
     private Contact contact;
 
-    private ScOtrEngineListener scOtrEngineListener = new ScOtrEngineListener()
-    {
-        public void sessionStatusChanged(Contact contact)
+    private final ScOtrEngineListener scOtrEngineListener =
+        new ScOtrEngineListener()
         {
-            // OtrMetaContactButton.this.contact can be null.
-            if (contact.equals(OtrMetaContactButton.this.contact))
+            public void sessionStatusChanged(Contact contact)
             {
-                setStatus(OtrActivator.scOtrEngine.getSessionStatus(contact));
+                // OtrMetaContactButton.this.contact can be null.
+                if (contact.equals(OtrMetaContactButton.this.contact))
+                {
+                    setStatus(
+                        OtrActivator.scOtrEngine.getSessionStatus(contact));
+                }
             }
-        }
 
-        public void contactPolicyChanged(Contact contact)
-        {
-            // OtrMetaContactButton.this.contact can be null.
-            if (contact.equals(OtrMetaContactButton.this.contact))
+            public void contactPolicyChanged(Contact contact)
             {
-                setPolicy(OtrActivator.scOtrEngine.getContactPolicy(contact));
+                // OtrMetaContactButton.this.contact can be null.
+                if (contact.equals(OtrMetaContactButton.this.contact))
+                {
+                    setPolicy(
+                        OtrActivator.scOtrEngine.getContactPolicy(contact));
+                }
             }
-        }
 
-        public void globalPolicyChanged()
-        {
-            if (OtrMetaContactButton.this.contact != null)
-                setPolicy(OtrActivator.scOtrEngine.getContactPolicy(contact));
-        }
-    };
+            public void globalPolicyChanged()
+            {
+                if (OtrMetaContactButton.this.contact != null)
+                    setPolicy(
+                        OtrActivator.scOtrEngine.getContactPolicy(contact));
+            }
+        };
 
-    private ScOtrKeyManagerListener scOtrKeyManagerListener =
+    private final ScOtrKeyManagerListener scOtrKeyManagerListener =
         new ScOtrKeyManagerListener()
         {
             public void contactVerificationStatusChanged(Contact contact)
@@ -67,8 +71,8 @@ public void contactVerificationStatusChanged(Contact contact)
                 // OtrMetaContactButton.this.contact can be null.
                 if (contact.equals(OtrMetaContactButton.this.contact))
                 {
-                    setStatus(OtrActivator.scOtrEngine
-                        .getSessionStatus(contact));
+                    setStatus(
+                        OtrActivator.scOtrEngine.getSessionStatus(contact));
                 }
             }
         };
@@ -200,8 +204,9 @@ private void setStatus(SessionStatus status)
         switch (status)
         {
         case ENCRYPTED:
-            urlKey =
-                OtrActivator.scOtrKeyManager.isVerified(contact) ? "plugin.otr.ENCRYPTED_ICON_22x22"
+            urlKey
+                = OtrActivator.scOtrKeyManager.isVerified(contact)
+                    ? "plugin.otr.ENCRYPTED_ICON_22x22"
                     : "plugin.otr.ENCRYPTED_UNVERIFIED_ICON_22x22";
             break;
         case FINISHED:

src/net/java/sip/communicator/plugin/otr/OtrMetaContactMenu.java

@@ -82,7 +82,8 @@ private void createOtrContactMenus(MetaContact metaContact)
         JMenu menu = getMenu();
 
         // Remove any existing OtrContactMenu items.
-        for (int itemIndex = 0, itemCount = menu.getItemCount(); itemIndex < itemCount;)
+        for (int itemIndex = 0, itemCount = menu.getItemCount();
+                itemIndex < itemCount;)
         {
             JMenuItem menuItem = menu.getItem(itemIndex);
 

src/net/java/sip/communicator/plugin/otr/OtrTransformLayer.java

@@ -12,16 +12,12 @@
  * The Off-the-Record {@link TransformLayer} implementation.
  * 
  * @author George Politis
- * 
  */
 public class OtrTransformLayer
     implements TransformLayer
 {
     /*
-     * 
-     * @see
-     * net.java.sip.communicator.service.protocol.TransformLayer#messageDelivered
-     * (net.java.sip.communicator.service.protocol.event.MessageDeliveredEvent)
+     * Implements TransformLayer#messageDelivered(MessageDeliveredEvent).
      */
     public MessageDeliveredEvent messageDelivered(MessageDeliveredEvent evt)
     {
@@ -35,12 +31,8 @@ public MessageDeliveredEvent messageDelivered(MessageDeliveredEvent evt)
     }
 
     /*
-     * (non-Javadoc)
-     * 
-     * @seenet.java.sip.communicator.service.protocol.TransformLayer#
-     * messageDeliveryFailed
-     * (net.java.sip.communicator.service.protocol.event.MessageDeliveryFailedEvent
-     * )
+     * Implements
+     * TransformLayer#messageDeliveryFailed(MessageDeliveryFailedEvent).
      */
     public MessageDeliveryFailedEvent messageDeliveryFailed(
         MessageDeliveryFailedEvent evt)
@@ -49,11 +41,7 @@ public MessageDeliveryFailedEvent messageDeliveryFailed(
     }
 
     /*
-     * (non-Javadoc)
-     * 
-     * @seenet.java.sip.communicator.service.protocol.TransformLayer#
-     * messageDeliveryPending
-     * (net.java.sip.communicator.service.protocol.event.MessageDeliveredEvent)
+     * Implements TransformLayer#messageDeliveryPending(MessageDeliveredEvent).
      */
     public MessageDeliveredEvent messageDeliveryPending(
         MessageDeliveredEvent evt)
@@ -92,11 +80,7 @@ public MessageDeliveredEvent messageDeliveryPending(
     }
 
     /*
-     * (non-Javadoc)
-     * 
-     * @see
-     * net.java.sip.communicator.service.protocol.TransformLayer#messageReceived
-     * (net.java.sip.communicator.service.protocol.event.MessageReceivedEvent)
+     * Implements TransformLayer#messageReceived(MessageReceivedEvent).
      */
     public MessageReceivedEvent messageReceived(MessageReceivedEvent evt)
     {
@@ -128,5 +112,4 @@ public MessageReceivedEvent messageReceived(MessageReceivedEvent evt)
 
         return processedEvent;
     }
-
 }

src/net/java/sip/communicator/plugin/otr/ScOtrEngine.java

@@ -14,7 +14,6 @@
  * functionality.
  * 
  * @author George Politis
- * 
  */
 public interface ScOtrEngine
 {
@@ -79,6 +78,11 @@ public interface ScOtrEngine
     /**
      * Gets weather the passed in messageUID is injected by the engine or not.
      * If it is injected, it shouldn't be re-transformed.
+     *
+     * @param messageUID the messageUID which is to be determined whether it is
+     * injected by the engine or not
+     * @return <tt>true</tt> if the passed in messageUID is injected by the
+     * engine; <tt>false</tt>, otherwise
      */
     public abstract boolean isMessageUIDInjected(String messageUID);
 
@@ -99,6 +103,8 @@ public interface ScOtrEngine
     // New Methods (Policy management)
     /**
      * Gets the global {@link OtrPolicy}.
+     *
+     * @return the global {@link OtrPolicy}
      */
     public abstract OtrPolicy getGlobalPolicy();
 
@@ -114,7 +120,7 @@ public interface ScOtrEngine
     /**
      * Sets the global policy.
      * 
-     * @param policy
+     * @param policy the global policy
      */
     public abstract void setGlobalPolicy(OtrPolicy policy);
 
@@ -130,5 +136,4 @@ public interface ScOtrEngine
      * Launches the help page.
      */
     public abstract void launchHelp();
-
 }