Fixed errors in javadocs

Author: tomsik68

src/main/java/sk/tomsik68/mclauncher/api/login/IProfile.java

@@ -1,7 +1,7 @@
 package sk.tomsik68.mclauncher.api.login;
 
 /**
- * Represents a profile - saved username & password
+ * Represents a profile - saved username and password
  *
  * @author Tomsik68
  */

src/main/java/sk/tomsik68/mclauncher/api/login/IProfileIO.java

@@ -1,7 +1,7 @@
 package sk.tomsik68.mclauncher.api.login;
 
 /**
- * ProfileIO can read & write profiles. One IO can contain more profiles.
+ * ProfileIO can read and write profiles. One IO can contain more profiles.
  *
  * @author Tomsik68
  */

src/main/java/sk/tomsik68/mclauncher/api/mods/IModdingProfile.java

@@ -44,7 +44,7 @@ public interface IModdingProfile {
     /**
      * Minecraft arguments are arguments that will be available in minecraft's main method.
      * These contain mostly user information, but also assets path, saves path etc, which might be useful...
-     * @param minecraftArguments
+     * @param minecraftArguments Array of minecraft arguments created by launcher
      * @return Array of string which is formatted in the same way as the input array. If you don't want to make any changes, return null or <code>minecraftArguments</code>
      */
     public String[] changeMinecraftArguments(String[] minecraftArguments);

src/main/java/sk/tomsik68/mclauncher/api/servers/FoundServerInfoBuilder.java

@@ -34,7 +34,7 @@ public final FoundServerInfoBuilder port(int p){
     /**
      *
      * @param ico - Icon image encoded as base64 string
-     * @return
+     * @return <code>this</code> for chaining
      */
     public final FoundServerInfoBuilder icon(String ico){
         icon = ico;

src/main/java/sk/tomsik68/mclauncher/api/services/IOnlineService.java

@@ -7,7 +7,7 @@
  */
 public interface IOnlineService {
     /**
-     * @param availability
+     * @param availability - Availability object retrieved from central server
      * @return True if this service is available. The result is to be determined using availability specified
      */
     public boolean isAvailable(IServicesAvailability availability);

src/main/java/sk/tomsik68/mclauncher/api/ui/IProgressMonitor.java

@@ -9,9 +9,11 @@
  */
 public interface IProgressMonitor {
     /**
-     * Sets current progress
+     * Sets current progress. <B>Please note this value is between 0 and max_progress.
+     * You need to scale it yourself in order to get progress information between 0 and 100.</B>
      *
      * @param progress New progress value
+     * @see IProgressMonitor#setMax(int)
      */
     public void setProgress(int progress);
 
@@ -25,7 +27,7 @@ public interface IProgressMonitor {
     /**
      * Increments current progress value by <code>amount</code>
      *
-     * @param amount
+     * @param amount How much
      */
     public void incrementProgress(int amount);
 

src/main/java/sk/tomsik68/mclauncher/api/versions/IVersionList.java

@@ -18,16 +18,16 @@ public interface IVersionList extends IObservable<String> {
 
     /**
      * Retrieves IVersion object with this ID
-     * @param id
+     * @param id ID of version to retrieve (e.g. "1.8")
      * @return IVersion object for the passed ID
-     * @throws Exception
+     * @throws Exception - Network errors, JSON parsing errors, version inheritance problems
      */
     public IVersion retrieveVersionInfo(String id) throws Exception;
 
     /**
      *
      * @return LatestVersionInformation object
-     * @throws Exception
+     * @throws Exception - Network errors, JSON parsing errors
      */
     public LatestVersionInformation getLatestVersionInformation() throws Exception;
 }

src/main/java/sk/tomsik68/mclauncher/backend/MinecraftLauncherBackend.java

@@ -48,7 +48,7 @@ public List<String> getVersionList() throws Exception {
      * This should be run everytime before you launch.
      * @param versionID - ID of version to check for update.
      * @param progress - {@link IProgressMonitor} in case you want to track the update progress. It may be null
-     * @throws Exception
+     * @throws Exception - Network errors, JSON parsing
      */
     public void updateMinecraft(String versionID, IProgressMonitor progress) throws Exception {
         if (versionID == null || versionID.length() == 0) throw new NullPointerException("versionID can't be null!");
@@ -61,7 +61,7 @@ public void updateMinecraft(String versionID, IProgressMonitor progress) throws
      * @param session - Authentication session
      * @param versionID - Version ID to run
      * @return ProcessBuilder which has minecraft command inside of it. No other things are setup.
-     * @throws Exception
+     * @throws Exception - Network errors, JSON parsing, process failures
      */
     public ProcessBuilder launchMinecraft(ISession session, String versionID) throws Exception {
         return launchMinecraft(session, null, versionID, DEFAULT_LAUNCH_SETTINGS, null);
@@ -75,7 +75,7 @@ public ProcessBuilder launchMinecraft(ISession session, String versionID) throws
      * @param launchSettings - Launch settings(amount of RAM etc)
      * @param moddingProfile - Modding profile information(overriding game jar etc.). May be null.
      * @return ProcessBuilder which has minecraft command inside of it. No other things are setup.
-     * @throws Exception
+     * @throws Exception - Network errors, JSON parsing, process failures
      */
     public ProcessBuilder launchMinecraft(ISession session, ServerInfo serverInfo, String versionID, ILaunchSettings launchSettings, IModdingProfile moddingProfile) throws Exception {
         if(versionID == null || versionID.length() == 0) throw new NullPointerException("versionID can't be null!");

src/main/java/sk/tomsik68/mclauncher/impl/common/Platform.java

@@ -25,7 +25,9 @@ public final class Platform {
     /** our current operating system */
     private static IOperatingSystem currentOS = null;
 
-    /** tries to determine the current operating system */
+    /** tries to determine the current operating system
+     *  @return Current operating system
+     * */
     public static IOperatingSystem getCurrentPlatform() {
         if (currentOS != null)
             return currentOS;
@@ -39,7 +41,10 @@ public static IOperatingSystem getCurrentPlatform() {
         return currentOS;
     }
 
-    /** forces current operating system */
+    /** Forces current operating system. This can be used to override the default setting
+     * in case OS detection goes wrong(it doesn't go wrong very often) or for testing.
+     * @param p - The operating system we want to use
+     * */
     public static void forcePlatform(IOperatingSystem p) {
         MCLauncherAPI.log.fine("Current platform: ".concat(p.getDisplayName()));
         currentOS = p;

src/main/java/sk/tomsik68/mclauncher/util/HttpUtils.java

@@ -39,7 +39,7 @@ public static String httpGet(String url) throws Exception {
      * Execute a secured POST request
      * @param url URL to request
      * @param keyInput the secret key to be used
-     * @param parameters Parameters in form <code>name=Tom&password=pass123</code>. They needn't to be URL-encoded(it will be done automatically)
+     * @param parameters Parameters in form <code>name=Tom&amp;password=pass123</code>. They needn't to be URL-encoded(it will be done automatically)
      * @return The result of request
      * @throws Exception I/O Exception, HTTP errors or invalid key
      */