Adds javadocs, fixes warnings.

23 files changed, 109 insertions, 31 deletions

diff --git a/src/net/java/sip/communicator/impl/osdependent/OsDependentActivator.java b/src/net/java/sip/communicator/impl/osdependent/OsDependentActivator.java
index 668d6d8..9760659 100644
--- a/src/net/java/sip/communicator/impl/osdependent/OsDependentActivator.java
+++ b/src/net/java/sip/communicator/impl/osdependent/OsDependentActivator.java
@@ -37,8 +37,12 @@ public class OsDependentActivator
 
     private static ResourceManagementService resourcesService;
 
-    private static final Logger logger =
-        Logger.getLogger(OsDependentActivator.class);
+    /**
+     * The <tt>Logger</tt> used by the <tt>OsDependentActivator</tt> class and
+     * its instances for logging output.
+     */
+    private static final Logger logger
+        = Logger.getLogger(OsDependentActivator.class);
 
     /**
      * Called when this bundle is started.
diff --git a/src/net/java/sip/communicator/impl/osdependent/SystemTray.java b/src/net/java/sip/communicator/impl/osdependent/SystemTray.java
index 7e98385..6b5194b 100644
--- a/src/net/java/sip/communicator/impl/osdependent/SystemTray.java
+++ b/src/net/java/sip/communicator/impl/osdependent/SystemTray.java
@@ -19,6 +19,10 @@ import net.java.sip.communicator.util.*;
  */

 public class SystemTray

 {

+    /**

+     * The <tt>Logger</tt> used by the <tt>SystemTray</tt> class and its

+     * instances for logging output.

+     */

     private static final Logger logger = Logger.getLogger(SystemTray.class);

 

     private static SystemTray defaultSystemTray;

diff --git a/src/net/java/sip/communicator/impl/osdependent/jdic/StatusSubMenu.java b/src/net/java/sip/communicator/impl/osdependent/jdic/StatusSubMenu.java
index 0f0feb9..d1cf2e9 100644
--- a/src/net/java/sip/communicator/impl/osdependent/jdic/StatusSubMenu.java
+++ b/src/net/java/sip/communicator/impl/osdependent/jdic/StatusSubMenu.java
@@ -41,7 +41,11 @@ public class StatusSubMenu
     private final Map<AccountID, Object> accountSelectors =
         new Hashtable<AccountID, Object>();
 
-    private final Logger logger = Logger.getLogger(StatusSubMenu.class);
+    /**
+     * The <tt>Logger</tt> used by the <tt>StatusSubMenu</tt> class and its
+     * instances for logging output.
+     */
+    private static final Logger logger = Logger.getLogger(StatusSubMenu.class);
 
     private final Object menu;
 
diff --git a/src/net/java/sip/communicator/impl/protocol/irc/ProtocolIconIrcImpl.java b/src/net/java/sip/communicator/impl/protocol/irc/ProtocolIconIrcImpl.java
index c5fee49..cc778f0 100644
--- a/src/net/java/sip/communicator/impl/protocol/irc/ProtocolIconIrcImpl.java
+++ b/src/net/java/sip/communicator/impl/protocol/irc/ProtocolIconIrcImpl.java
@@ -22,8 +22,13 @@ import net.java.sip.communicator.util.*;
  */
 public class ProtocolIconIrcImpl
     implements ProtocolIcon
-{    
-    private static Logger logger = Logger.getLogger(ProtocolIconIrcImpl.class);
+{
+    /**
+     * The <tt>Logger</tt> used by the <tt>ProtocolIconIrcImpl</tt> class and
+     * its instances for logging output.
+     */
+    private static final Logger logger
+        = Logger.getLogger(ProtocolIconIrcImpl.class);
     
     /**
      * A hash table containing the protocol icon in different sizes.
diff --git a/src/net/java/sip/communicator/impl/protocol/jabber/ProtocolIconJabberImpl.java b/src/net/java/sip/communicator/impl/protocol/jabber/ProtocolIconJabberImpl.java
index 2063388..c9345e9 100644
--- a/src/net/java/sip/communicator/impl/protocol/jabber/ProtocolIconJabberImpl.java
+++ b/src/net/java/sip/communicator/impl/protocol/jabber/ProtocolIconJabberImpl.java
@@ -25,8 +25,12 @@ import org.osgi.framework.*;
  */
 public class ProtocolIconJabberImpl
     implements ProtocolIcon
-{    
-    private static Logger logger
+{
+    /**
+     * The <tt>Logger</tt> used by the <tt>ProtocolIconJabberImpl</tt> class and
+     * its instances for logging output. 
+     */
+    private static final Logger logger
         = Logger.getLogger(ProtocolIconJabberImpl.class); 
 
     /**
diff --git a/src/net/java/sip/communicator/impl/protocol/mock/MockCall.java b/src/net/java/sip/communicator/impl/protocol/mock/MockCall.java
index 787f7f9..556368b 100644
--- a/src/net/java/sip/communicator/impl/protocol/mock/MockCall.java
+++ b/src/net/java/sip/communicator/impl/protocol/mock/MockCall.java
@@ -20,6 +20,10 @@ public class MockCall
     extends AbstractCall<MockCallPeer, MockProvider>
     implements CallPeerListener
 {
+    /**
+     * The <tt>Logger</tt> used by the <tt>MockCall</tt> class and its instances
+     * for logging output.
+     */
     private static final Logger logger = Logger.getLogger(MockCall.class);
 
     public MockCall(MockProvider sourceProvider)
diff --git a/src/net/java/sip/communicator/impl/protocol/rss/ProtocolProviderFactoryRssImpl.java b/src/net/java/sip/communicator/impl/protocol/rss/ProtocolProviderFactoryRssImpl.java
index cb87c72..fa41057 100644
--- a/src/net/java/sip/communicator/impl/protocol/rss/ProtocolProviderFactoryRssImpl.java
+++ b/src/net/java/sip/communicator/impl/protocol/rss/ProtocolProviderFactoryRssImpl.java
@@ -27,6 +27,10 @@ import net.java.sip.communicator.util.*;
 public class ProtocolProviderFactoryRssImpl
     extends ProtocolProviderFactory
 {
+    /**
+     * The <tt>Logger</tt> used by the <tt>ProtocolProviderFactoryRssImpl</tt>
+     * class and its instances for logging output.
+     */
     private static final Logger logger
         = Logger.getLogger(ProtocolProviderFactoryRssImpl.class);
 
diff --git a/src/net/java/sip/communicator/impl/protocol/sip/UriHandlerSipImpl.java b/src/net/java/sip/communicator/impl/protocol/sip/UriHandlerSipImpl.java
index 7feff89..49b0811 100644
--- a/src/net/java/sip/communicator/impl/protocol/sip/UriHandlerSipImpl.java
+++ b/src/net/java/sip/communicator/impl/protocol/sip/UriHandlerSipImpl.java
@@ -26,8 +26,12 @@ import net.java.sip.communicator.util.*;
 public class UriHandlerSipImpl
     implements UriHandler, ServiceListener, AccountManagerListener
 {
-    private static final Logger logger =
-        Logger.getLogger(UriHandlerSipImpl.class);
+    /**
+     * The <tt>Logger</tt> used by the <tt>UriHandlerSipImpl</tt> class and its
+     * instances for logging output.
+     */
+    private static final Logger logger
+        = Logger.getLogger(UriHandlerSipImpl.class);
 
     /**
      * The protocol provider factory that created us.
diff --git a/src/net/java/sip/communicator/impl/resources/ResourceManagementServiceImpl.java b/src/net/java/sip/communicator/impl/resources/ResourceManagementServiceImpl.java
index 7908e54..951dc00 100644
--- a/src/net/java/sip/communicator/impl/resources/ResourceManagementServiceImpl.java
+++ b/src/net/java/sip/communicator/impl/resources/ResourceManagementServiceImpl.java
@@ -31,8 +31,12 @@ public class ResourceManagementServiceImpl
     implements ResourceManagementService,
                ServiceListener
 {
-    private static Logger logger =
-        Logger.getLogger(ResourceManagementServiceImpl.class);
+    /**
+     * The <tt>Logger</tt> used by the <tt>ResourceManagementServiceImpl</tt>
+     * class and its instances for logging output.
+     */
+    private static final Logger logger
+        = Logger.getLogger(ResourceManagementServiceImpl.class);
 
     /**
      * Resources for currently loaded <tt>ColorPack</tt>.
diff --git a/src/net/java/sip/communicator/plugin/googletalkaccregwizz/FirstWizardPage.java b/src/net/java/sip/communicator/plugin/googletalkaccregwizz/FirstWizardPage.java
index b9ffdfa..891302b 100644
--- a/src/net/java/sip/communicator/plugin/googletalkaccregwizz/FirstWizardPage.java
+++ b/src/net/java/sip/communicator/plugin/googletalkaccregwizz/FirstWizardPage.java
@@ -28,6 +28,10 @@ public class FirstWizardPage
     extends TransparentPanel

     implements WizardPage

 {

+    /**

+     * The <tt>Logger</tt> used by the <tt>FirstWizardPage</tt> class and its

+     * instances for logging output.

+     */

     private static final Logger logger

         = Logger.getLogger(FirstWizardPage.class);

 

diff --git a/src/net/java/sip/communicator/plugin/googletalkaccregwizz/GoogleTalkAccRegWizzActivator.java b/src/net/java/sip/communicator/plugin/googletalkaccregwizz/GoogleTalkAccRegWizzActivator.java
index 135a2f0..bd41736 100644
--- a/src/net/java/sip/communicator/plugin/googletalkaccregwizz/GoogleTalkAccRegWizzActivator.java
+++ b/src/net/java/sip/communicator/plugin/googletalkaccregwizz/GoogleTalkAccRegWizzActivator.java
@@ -25,8 +25,12 @@ public class GoogleTalkAccRegWizzActivator
 {

     public static BundleContext bundleContext;

 

-    private static final Logger logger = Logger.getLogger(

-        GoogleTalkAccRegWizzActivator.class.getName());

+    /**

+     * The <tt>Logger</tt> used by the <tt>GoogleTalkAccRegWizzActivator</tt>

+     * and its instances for logging output.

+     */

+    private static final Logger logger

+        = Logger.getLogger(GoogleTalkAccRegWizzActivator.class);

 

     private static BrowserLauncherService browserLauncherService;

 

diff --git a/src/net/java/sip/communicator/plugin/googletalkaccregwizz/GoogleTalkAccountRegistrationWizard.java b/src/net/java/sip/communicator/plugin/googletalkaccregwizz/GoogleTalkAccountRegistrationWizard.java
index 28c218c..24a42ef 100644
--- a/src/net/java/sip/communicator/plugin/googletalkaccregwizz/GoogleTalkAccountRegistrationWizard.java
+++ b/src/net/java/sip/communicator/plugin/googletalkaccregwizz/GoogleTalkAccountRegistrationWizard.java
@@ -25,6 +25,10 @@ import org.osgi.framework.*;
 public class GoogleTalkAccountRegistrationWizard

     implements AccountRegistrationWizard

 {

+    /**

+     * The <tt>Logger</tt> used by this

+     * <tt>GoogleTalkAccountRegistrationWizard</tt> for logging output.

+     */

     private final Logger logger

         = Logger.getLogger(GoogleTalkAccountRegistrationWizard.class);

 

diff --git a/src/net/java/sip/communicator/plugin/iptelaccregwizz/IptelAccRegWizzActivator.java b/src/net/java/sip/communicator/plugin/iptelaccregwizz/IptelAccRegWizzActivator.java
index 03fb480..538af7b 100644
--- a/src/net/java/sip/communicator/plugin/iptelaccregwizz/IptelAccRegWizzActivator.java
+++ b/src/net/java/sip/communicator/plugin/iptelaccregwizz/IptelAccRegWizzActivator.java
@@ -26,8 +26,12 @@ public class IptelAccRegWizzActivator
 {

     public static BundleContext bundleContext;

 

-    private static final Logger logger = Logger.getLogger(

-        IptelAccRegWizzActivator.class.getName());

+    /**

+     * The <tt>Logger</tt> used by the <tt>IptelAccRegWizzActivator</tt> class

+     * and its instances for logging output.

+     */

+    private static final Logger logger

+        = Logger.getLogger(IptelAccRegWizzActivator.class);

 

     private static BrowserLauncherService browserLauncherService;

 

diff --git a/src/net/java/sip/communicator/plugin/simpleaccreg/InitialAccountRegistrationFrame.java b/src/net/java/sip/communicator/plugin/simpleaccreg/InitialAccountRegistrationFrame.java
index aa5dbaa..f02fd64 100644
--- a/src/net/java/sip/communicator/plugin/simpleaccreg/InitialAccountRegistrationFrame.java
+++ b/src/net/java/sip/communicator/plugin/simpleaccreg/InitialAccountRegistrationFrame.java
@@ -38,6 +38,10 @@ public class InitialAccountRegistrationFrame
 {

     private ConfigurationService configurationService;

 

+    /**

+     * The <tt>Logger</tt> used by this <tt>InitialAccountRegistrationFrame</tt>

+     * for logging output.

+     */

     private final Logger logger

         = Logger.getLogger(InitialAccountRegistrationFrame.class);

 

diff --git a/src/net/java/sip/communicator/plugin/sip2sipaccregwizz/Sip2SipAccRegWizzActivator.java b/src/net/java/sip/communicator/plugin/sip2sipaccregwizz/Sip2SipAccRegWizzActivator.java
index 657a4da..847ea70 100644
--- a/src/net/java/sip/communicator/plugin/sip2sipaccregwizz/Sip2SipAccRegWizzActivator.java
+++ b/src/net/java/sip/communicator/plugin/sip2sipaccregwizz/Sip2SipAccRegWizzActivator.java
@@ -14,7 +14,6 @@ import net.java.sip.communicator.service.browserlauncher.*;
 import net.java.sip.communicator.service.gui.*;

 import net.java.sip.communicator.service.protocol.*;

 import net.java.sip.communicator.service.resources.*;

-import net.java.sip.communicator.util.*;

 

 /**

  * Registers the <tt>GoogleTalkAccountRegistrationWizard</tt> in the UI Service.

@@ -31,12 +30,6 @@ public class Sip2SipAccRegWizzActivator
     public static BundleContext bundleContext;

 

     /**

-     * The logger.

-     */

-    private static final Logger logger = Logger.getLogger(

-        Sip2SipAccRegWizzActivator.class.getName());

-

-    /**

      * The browser launcher service.

      */

     private static BrowserLauncherService browserLauncherService;

diff --git a/src/net/java/sip/communicator/plugin/updatechecker/UpdateCheckActivator.java b/src/net/java/sip/communicator/plugin/updatechecker/UpdateCheckActivator.java
index 2d69b1f..4ddc06d 100644
--- a/src/net/java/sip/communicator/plugin/updatechecker/UpdateCheckActivator.java
+++ b/src/net/java/sip/communicator/plugin/updatechecker/UpdateCheckActivator.java
@@ -38,6 +38,10 @@ import org.osgi.framework.*;
 public class UpdateCheckActivator
     implements BundleActivator
 {
+    /**
+     * The <tt>Logger</tt> used by the <tt>UpdateCheckActivator</tt> class and
+     * its instances for logging output.
+     */
     private static final Logger logger
         = Logger.getLogger(UpdateCheckActivator.class);
 
diff --git a/src/net/java/sip/communicator/service/protocol/AbstractMessage.java b/src/net/java/sip/communicator/service/protocol/AbstractMessage.java
index ee28d3d..c1fb9ca 100644
--- a/src/net/java/sip/communicator/service/protocol/AbstractMessage.java
+++ b/src/net/java/sip/communicator/service/protocol/AbstractMessage.java
@@ -20,8 +20,12 @@ import net.java.sip.communicator.util.*;
 public abstract class AbstractMessage
     implements Message
 {
-    private static final Logger logger =
-        Logger.getLogger(AbstractMessage.class);
+    /**
+     * The <tt>Logger</tt> used by the <tt>AbstractMessage</tt> class and its
+     * instances for logging output.
+     */
+    private static final Logger logger
+        = Logger.getLogger(AbstractMessage.class);
 
     private static boolean equals(String a, String b)
     {
diff --git a/src/net/java/sip/communicator/service/protocol/AbstractOperationSetBasicInstantMessaging.java b/src/net/java/sip/communicator/service/protocol/AbstractOperationSetBasicInstantMessaging.java
index 29a36ed..14e691c 100644
--- a/src/net/java/sip/communicator/service/protocol/AbstractOperationSetBasicInstantMessaging.java
+++ b/src/net/java/sip/communicator/service/protocol/AbstractOperationSetBasicInstantMessaging.java
@@ -23,8 +23,13 @@ import net.java.sip.communicator.util.*;
 public abstract class AbstractOperationSetBasicInstantMessaging
     implements OperationSetBasicInstantMessaging
 {
-    private static final Logger logger =
-        Logger.getLogger(AbstractOperationSetBasicInstantMessaging.class);
+    /**
+     * The <tt>Logger</tt> used by the
+     * <tt>AbstractOperationSetBasicInstantMessaging</tt> class and its
+     * instances for logging output.
+     */
+    private static final Logger logger
+        = Logger.getLogger(AbstractOperationSetBasicInstantMessaging.class);
 
     /**
      * A list of listeners registered for message events.
diff --git a/src/net/java/sip/communicator/service/protocol/AccountID.java b/src/net/java/sip/communicator/service/protocol/AccountID.java
index 0b1c08f..7fe4267 100644
--- a/src/net/java/sip/communicator/service/protocol/AccountID.java
+++ b/src/net/java/sip/communicator/service/protocol/AccountID.java
@@ -33,6 +33,10 @@ import net.java.sip.communicator.util.*;
  */
 public abstract class AccountID
 {
+    /**
+     * The <tt>Logger</tt> used by the <tt>AccountID</tt> class and its
+     * instances for logging output.
+     */
     private static final Logger logger = Logger.getLogger(AccountID.class);
 
     /**
diff --git a/src/net/java/sip/communicator/service/protocol/event/AccountManagerEvent.java b/src/net/java/sip/communicator/service/protocol/event/AccountManagerEvent.java
index 550b340..30c2f9e 100644
--- a/src/net/java/sip/communicator/service/protocol/event/AccountManagerEvent.java
+++ b/src/net/java/sip/communicator/service/protocol/event/AccountManagerEvent.java
@@ -45,7 +45,8 @@ public class AccountManagerEvent
      * 

      * @param accountManager the <code>AccountManager</code> issuing the

      *            notification i.e. the source of the event

-     * @param type

+     * @param type the type of the event which is one of

+     * {@link #STORED_ACCOUNTS_LOADED}

      * @param factory the <code>ProtocolProviderFactory</code> being worked on

      *            at the time this event has been fired

      */

diff --git a/src/net/java/sip/communicator/service/protocol/jabberconstants/JabberStatusEnum.java b/src/net/java/sip/communicator/service/protocol/jabberconstants/JabberStatusEnum.java
index 58a6031..87c3030 100644
--- a/src/net/java/sip/communicator/service/protocol/jabberconstants/JabberStatusEnum.java
+++ b/src/net/java/sip/communicator/service/protocol/jabberconstants/JabberStatusEnum.java
@@ -23,8 +23,12 @@ import net.java.sip.communicator.util.*;
  */
 public class JabberStatusEnum
 {
-    private static final Logger logger =
-        Logger.getLogger(JabberStatusEnum.class);
+    /**
+     * The <tt>Logger</tt> used by the <tt>JabberStatusEnum</tt> class and its
+     * instances for logging output.
+     */
+    private static final Logger logger
+        = Logger.getLogger(JabberStatusEnum.class);
 
     /**
      * The Online status. Indicate that the user is able and willing to
diff --git a/src/net/java/sip/communicator/util/Html2Text.java b/src/net/java/sip/communicator/util/Html2Text.java
index 11e2eb1..689dd5b 100644
--- a/src/net/java/sip/communicator/util/Html2Text.java
+++ b/src/net/java/sip/communicator/util/Html2Text.java
@@ -121,8 +121,10 @@ public class Html2Text
         /**
          * Appends the given text to the string buffer.
          *
-         * @param text
-         * @param pos
+         * @param text the text of a text node which has been parsed from the
+         * specified HTML
+         * @param pos the zero-based position of the specified <tt>text</tt> in
+         * the specified HTML
          */
         @Override
         public void handleText(char[] text, int pos)
diff --git a/src/net/java/sip/communicator/util/ImageUtils.java b/src/net/java/sip/communicator/util/ImageUtils.java
index 4d17686..5562408 100644
--- a/src/net/java/sip/communicator/util/ImageUtils.java
+++ b/src/net/java/sip/communicator/util/ImageUtils.java
@@ -25,6 +25,10 @@ import net.java.sip.communicator.util.swing.*;
  */
 public class ImageUtils
 {
+    /**
+     * The <tt>Logger</tt> used by the <tt>ImageUtils</tt> class for logging
+     * output.
+     */
     private static final Logger logger = Logger.getLogger(ImageUtils.class);
 
     /**