Tidy up javadoc

Change-Id: Ib0fd7c597475c9005405eeedbc6f5168ad32d9dc
Reviewed-on: http://gerrit.dmdirc.com/2883
Reviewed-by: Chris Smith <chris@dmdirc.com>
Automatic-Compile: DMDirc Build Manager

src/com/dmdirc/ClientModule.java

@@ -354,6 +354,8 @@ public class ClientModule {
     /**
      * Gets the performs actions wrapper.
      *
+     * @param wrapper Wrapper to return
+     *
      * @return An performs wrapper to use in the client.
      */
     @Provides(type = Provides.Type.SET)

src/com/dmdirc/FrameContainer.java

@@ -389,7 +389,7 @@ public abstract class FrameContainer {
      *      unregistering the window with any specific managers, or from the
      *      parent windows if they track children)</li>
      *  <li>Remove the window from the window manager (by calling
-     *      {@link WindowManager#removeWindow(com.dmdirc.ui.interfaces.Window)}</li>
+     *      {@link WindowManager#removeWindow(com.dmdirc.FrameContainer)}</li>
      * </ol>
      * <p>
      * <strong>NB:</strong> As of DMDirc 0.6.5, points 1 and 6 (making windows

src/com/dmdirc/actions/ActionModel.java

@@ -118,6 +118,7 @@ public class ActionModel {
     /**
      * Triggers this action.
      *
+     * @param serverManager The server manager used to iterate servers
      * @param format The format of the message that's going to be displayed.
      * @param arguments The arguments from the action that caused this trigger.
      * @return True if the execution of the event should be stopped, or false

src/com/dmdirc/actions/internal/WhoisNumericFormatter.java

@@ -48,8 +48,7 @@ public class WhoisNumericFormatter implements ActionListener {
     /**
      * Creates a new whois numeric formatter that will add automatic formats
      * to the specified identity. This will normally be a temporary global
-     * identity, such as the one returned by
-     * {@link IdentityManager#getAddonIdentity()}.
+     * identity.
      *
      * @param identity The identity to write formatters to
      */

src/com/dmdirc/commandline/CommandLineParser.java

@@ -83,6 +83,8 @@ public class CommandLineParser {
 
     /**
      * Creates a new instance of CommandLineParser.
+     *
+     * @param serverManagerProvider ServerManager
      */
     @Inject
     public CommandLineParser(final Provider<ServerManager> serverManagerProvider) {

src/com/dmdirc/commandparser/commands/chat/Me.java

@@ -49,7 +49,8 @@ public class Me extends Command implements ValidatingCommand {
             CommandType.TYPE_CHAT);
 
     /**
-     * Creates a new instance of {@link Ban} using the given command controller.
+     * Creates a new instance of {@link com.dmdirc.commandparser.commands.channel.Ban} using the
+     * given command controller.
      *
      * @param controller The controller to use for command information.
      */

src/com/dmdirc/commandparser/parsers/CommandParser.java

@@ -72,7 +72,12 @@ public abstract class CommandParser implements Serializable {
     @Getter
     protected final CommandController commandManager;
 
-    /** Creates a new instance of CommandParser. */
+    /**
+     * Creates a new instance of CommandParser.
+     *
+     * @param configManager Config manager to read settings
+     * @param commandManager Command manager to load plugins from
+     */
     protected CommandParser(final AggregateConfigProvider configManager,
             final CommandController commandManager) {
         commands = new HashMap<>();

src/com/dmdirc/config/BaseConfigProvider.java

@@ -73,7 +73,7 @@ public abstract class BaseConfigProvider implements ReadOnlyConfigProvider {
     private final Provider<ColourManager> colourManager;
 
     /**
-     * Creates a new instance of {@link ConfigSource}.
+     * Creates a new instance of {@link com.dmdirc.interfaces.config.ConfigProvider}.
      *
      * @param colourManager The colour manager to use to convert colours.
      */
@@ -82,8 +82,8 @@ public abstract class BaseConfigProvider implements ReadOnlyConfigProvider {
     }
 
     /**
-     * Creates a new instance of {@link ConfigSource} using the singleton
-     * colour manager.
+     * Creates a new instance of {@link com.dmdirc.interfaces.config.ConfigProvider} using the
+     * singleton colour manager.
      *
      * @deprecated Should pass in a {@link ColourManager}.
      */

src/com/dmdirc/config/ConfigManager.java

@@ -394,7 +394,7 @@ public class ConfigManager extends BaseConfigProvider implements ConfigChangeLis
     }
 
     /**
-     * Records the lookup request for the specified domain & option.
+     * Records the lookup request for the specified domain and option.
      *
      * @param domain The domain that is being looked up
      * @param option The option that is being looked up

src/com/dmdirc/config/package-info.java

@@ -42,6 +42,6 @@
  * Identities are all stored on disk under the 'identities' directory in the
  * user's DMDirc profile. Default identities in this package are extracted
  * automatically by the {@link IdentityManager} if they do not exist.
- * Identities use the DMDirc {@link com.dmdirc.util.ConfigFile} file format.
+ * Identities use the DMDirc {@link com.dmdirc.util.io.ConfigFile} file format.
  */
 package com.dmdirc.config;

src/com/dmdirc/config/prefs/PreferencesCategory.java

@@ -72,11 +72,11 @@ public class PreferencesCategory {
 
     /** A list of settings in this category. */
     @Getter
-    private final List<PreferencesSetting> settings = new ArrayList<PreferencesSetting>();
+    private final List<PreferencesSetting> settings = new ArrayList<>();
 
     /** A list of subcategories of this category. */
     @Getter
-    private final List<PreferencesCategory> subcats = new ArrayList<PreferencesCategory>();
+    private final List<PreferencesCategory> subcats = new ArrayList<>();
 
     /** The replacement object to use for this category. */
     @Getter
@@ -191,7 +191,6 @@ public class PreferencesCategory {
      * Determines if this category has a replacement object.
      *
      * @return True if the category has a replacement object, false otherwise
-     * @see #getObject()
      */
     public boolean hasObject() {
         return object != null;

src/com/dmdirc/interfaces/Connection.java

@@ -407,7 +407,7 @@ public interface Connection {
      * Parses the specified hostmask in a manner prescribed by the protocol
      * currently used by this server.
      *
-     * @see ProtocolDescription#parseHostmask(java.lang.String)
+     * @see com.dmdirc.parser.interfaces.ProtocolDescription#parseHostmask(java.lang.String)
      * @param hostmask The hostmask to be parsed
      * @return An array containing the nickname, username and hostname
      * @since 0.6.4

src/com/dmdirc/interfaces/actions/ActionComponent.java

@@ -45,7 +45,11 @@ public interface ActionComponent {
     @Target(ElementType.METHOD)
     @interface ComponentOptions {
 
-        /** Whether or not the component requires a connected server. */
+        /**
+         * Whether or not the component requires a connected server.
+         *
+         * @return true if component requires a connected server
+         */
         boolean requireConnected() default false;
 
     }

src/com/dmdirc/messages/MessageSink.java

@@ -37,6 +37,8 @@ public interface MessageSink {
      * this sink matches a given configuration entry. If the pattern contains
      * groups, the values of the matched groups are passed into the
      * handleMessage method.
+     *
+     * @return Pattern to matches a config entry
      */
     Pattern getPattern();
 

src/com/dmdirc/plugins/GlobalClassLoader.java

@@ -101,10 +101,12 @@ public final class GlobalClassLoader extends ClassLoader {
     }
 
     /**
-     * Look in all known sources of persisant classes for file asked for.
+     * Look in all known sources of persistent classes for file asked for.
      *
      * @param classname Class name to define.
      * @param data Data to define class with.
+     *
+     * @return The resulting {@link Class} object
      */
     public Class<?> defineClass(final String classname, final byte[] data) {
         return defineClass(classname, data, 0, data.length);

src/com/dmdirc/plugins/PluginManager.java

@@ -563,9 +563,9 @@ public class PluginManager implements ActionListener, ServiceManager {
     }
 
     /**
-     * Get Collection<PluginInfo> of known plugins.
+     * Get Collection&lt;PluginInf&gt; of known plugins.
      *
-     * @return Collection<PluginInfo> of known plugins.
+     * @return Collection&lt;PluginInfo&gt; of known plugins.
      */
     public Collection<PluginInfo> getPluginInfos() {
         return new ArrayList<>(knownPlugins.values());

src/com/dmdirc/plugins/PluginMetaData.java

@@ -133,6 +133,7 @@ public class PluginMetaData {
     /**
      * Creates a new meta data reader for a config file at the specified URL.
      *
+     * @param manager Plugin manager
      * @param url The URL to load the config file from
      * @param pluginUrl The URL to the plugin that this data corresponds to
      */

src/com/dmdirc/ui/core/util/URLHandler.java

@@ -58,6 +58,9 @@ public class URLHandler {
      * Instantiates a new URL Handler.
      *
      * @param controller The UI controller to show dialogs etc on
+     * @param globalConfig Config to retrieve settings from
+     * @param serverManager Server manager to connect to servers
+     * @param statusBarManager Status bar manager used to show messages
      */
     public URLHandler(
             final UIController controller,
@@ -160,24 +163,28 @@ public class URLHandler {
         }
 
         final String command = config.getOption("protocol", uri.getScheme().toLowerCase());
-
-        if ("DMDIRC".equals(command)) {
-            statusBarManager.setMessage(
-                    new StatusMessage("Connecting to: " + uri.toString(),
-                    config));
-            serverManager.connectToAddress(uri);
-        } else if ("BROWSER".equals(command)) {
-            statusBarManager.setMessage(
-                    new StatusMessage("Opening: " + uri.toString(),
-                    config));
-            execBrowser(uri);
-        } else if ("MAIL".equals(command)) {
-            execMail(uri);
-        } else {
-            statusBarManager.setMessage(
-                    new StatusMessage("Opening: " + uri.toString(),
-                    config));
-            execApp(substituteParams(uri, command));
+        switch (command) {
+            case "DMDIRC":
+                statusBarManager.setMessage(
+                        new StatusMessage("Connecting to: " + uri.toString(),
+                                config));
+                serverManager.connectToAddress(uri);
+                break;
+            case "BROWSER":
+                statusBarManager.setMessage(
+                        new StatusMessage("Opening: " + uri.toString(),
+                                config));
+                execBrowser(uri);
+                break;
+            case "MAIL":
+                execMail(uri);
+                break;
+            default:
+                statusBarManager.setMessage(
+                        new StatusMessage("Opening: " + uri.toString(),
+                                config));
+                execApp(substituteParams(uri, command));
+                break;
         }
     }
 

src/com/dmdirc/ui/messages/Styliser.java

@@ -159,7 +159,7 @@ public class Styliser implements ConfigChangeListener {
      * Creates a new instance of Styliser.
      *
      * @param server The {@link Server} that owns this styliser or null if n/a.
-     * @param configManager the {@link ConfigManager} to get settings from.
+     * @param configManager the {@link AggregateConfigProvider} to get settings from.
      * @since 0.6.3
      */
     public Styliser(final Server server, final AggregateConfigProvider configManager) {

src/com/dmdirc/updater/UpdateChecker.java

@@ -103,7 +103,7 @@ public final class UpdateChecker implements Runnable {
      * Initialises the update checker. Sets a timer to check based on the
      * frequency specified in the config.
      *
-     * @param main Parent Main class
+     * @param manager Manager to monitor updates
      */
     public static void init(final CachingUpdateManager manager) {
         UpdateChecker.manager = manager;

src/com/dmdirc/updater/manager/UpdateManager.java

@@ -39,7 +39,8 @@ public interface UpdateManager {
      * Adds a new check strategy to this manager. {@link UpdateCheckStrategy}s
      * are responsible for checking to see if an updated version of a set of
      * components is available. If multiple strategies are configured, their
-     * results are merged using this manager's {@link CheckResultConsolidator}.
+     * results are merged using this manager's
+     * {@link com.dmdirc.updater.checking.CheckResultConsolidator}.
      *
      * @param strategy The strategy to be added.
      */

src/com/dmdirc/updater/manager/UpdateStatus.java

@@ -26,7 +26,7 @@ import lombok.Getter;
 import lombok.RequiredArgsConstructor;
 
 /**
- * Describes the possible statuses of an {@link UpdateComponent}.
+ * Describes the possible statuses of an {@link com.dmdirc.updater.UpdateComponent}.
  */
 @RequiredArgsConstructor
 @SuppressWarnings("PMD.UnusedPrivateField")

src/com/dmdirc/updater/package-info.java

@@ -26,24 +26,5 @@
  * (using the domain updates.dmdirc.com). The website then replies with a
  * message saying whether each component is out of date, up to date, or not
  * known.
- *
- * For each update that is available, the {@link UpdateChecker} creates
- * a new {@link Update} instance, which is responsible for parsing the full
- * response from the DMDirc website.
- *
- * The status of the {@link UpdateChecker} can be monitored by registering a
- * {@link UpdateCheckerListener} with it. This enables, for example, UI
- * components to notify the user when updates are available. Such components
- * can then remove certain updates (by calling
- * {@link UpdateChecker#removeUpdate(Update)}), and have the
- * {@link UpdateChecker} apply the updates by calling
- * {@link UpdateChecker#applyUpdates()}.
- *
- * Internally, when applying updates, the {@link UpdateChecker} calls the
- * {@link Update#doUpdate()} method on each relevant {@link Update}, which
- * downloads the required files to a temporary location, and then has the
- * relevant {@link UpdateComponent} perform the installation. During this time,
- * the {@link Update} can be monitored by registering an {@link UpdateListener}
- * with it.
  */
 package com.dmdirc.updater;

src/com/dmdirc/updater/retrieving/TypeSensitiveRetrievalStrategy.java

@@ -59,7 +59,8 @@ public abstract class TypeSensitiveRetrievalStrategy<T extends UpdateCheckResult
      * requiring retrieval.
      * @return An {@link UpdateRetrievalResult} which describes the result of
      * the retrieval, providing information for an
-     * {@link UpdateInstallationStrategy} to use to install the update.
+     * {@link com.dmdirc.updater.installing.UpdateInstallationStrategy}
+     * to use to install the update.
      * @see #retrieve(com.dmdirc.updater.checking.UpdateCheckResult)
      */
     protected abstract UpdateRetrievalResult retrieveImpl(T checkResult);