add some missing javadoc

I2PChromiumProfileChecker.md

@@ -20,7 +20,7 @@ package: net.i2p.i2pfirefox
 
 ## Methods
 
-### main [[src]](src/java/net/i2p/i2pfirefox/I2PChromiumProfileChecker.java#L22)
+### main [[src]](src/java/net/i2p/i2pfirefox/I2PChromiumProfileChecker.java#L27)
 
 + Description:   
 + Access: public  
@@ -32,7 +32,7 @@ package: net.i2p.i2pfirefox
 | args | String[] |  |  
 
 
-### validateProfileDirectory [[src]](src/java/net/i2p/i2pfirefox/I2PChromiumProfileChecker.java#L36)
+### validateProfileDirectory [[src]](src/java/net/i2p/i2pfirefox/I2PChromiumProfileChecker.java#L48)
 
 + Description:   
 + Access: public  
@@ -44,7 +44,7 @@ package: net.i2p.i2pfirefox
 | profileDirectory | String |  |  
 
 
-### validateFile [[src]](src/java/net/i2p/i2pfirefox/I2PChromiumProfileChecker.java#L60)
+### validateFile [[src]](src/java/net/i2p/i2pfirefox/I2PChromiumProfileChecker.java#L79)
 
 + Description:   
 + Access: public  
@@ -56,7 +56,7 @@ package: net.i2p.i2pfirefox
 | file | String |  |  
 
 
-### validateExtensionDirectory [[src]](src/java/net/i2p/i2pfirefox/I2PChromiumProfileChecker.java#L80)
+### validateExtensionDirectory [[src]](src/java/net/i2p/i2pfirefox/I2PChromiumProfileChecker.java#L106)
 
 + Description:   
 + Access: public  

I2PFirefoxProfileChecker.md

@@ -32,7 +32,7 @@ package: net.i2p.i2pfirefox
 | args | String[] |  |  
 
 
-### validateProfileDirectory [[src]](src/java/net/i2p/i2pfirefox/I2PFirefoxProfileChecker.java#L36)
+### validateProfileDirectory [[src]](src/java/net/i2p/i2pfirefox/I2PFirefoxProfileChecker.java#L43)
 
 + Description:   
 + Access: public  
@@ -44,7 +44,7 @@ package: net.i2p.i2pfirefox
 | profileDirectory | String |  |  
 
 
-### validateFile [[src]](src/java/net/i2p/i2pfirefox/I2PFirefoxProfileChecker.java#L68)
+### validateFile [[src]](src/java/net/i2p/i2pfirefox/I2PFirefoxProfileChecker.java#L82)
 
 + Description:   
 + Access: public  
@@ -56,7 +56,7 @@ package: net.i2p.i2pfirefox
 | file | String |  |  
 
 
-### validateExtensionDirectory [[src]](src/java/net/i2p/i2pfirefox/I2PFirefoxProfileChecker.java#L88)
+### validateExtensionDirectory [[src]](src/java/net/i2p/i2pfirefox/I2PFirefoxProfileChecker.java#L109)
 
 + Description:   
 + Access: public  

report.log

@@ -3,25 +3,25 @@ Generating documentation from src/java/net/i2p/i2pfirefox/
 
 Javadoc errors for class I2PChromiumProfileChecker
 File: src/java/net/i2p/i2pfirefox/I2PChromiumProfileChecker.java
-	Missing description for method main (Line: 22)
-	Javadoc parameter not found args in method: main (Line: 22)
-	Missing description for method validateProfileDirectory (Line: 36)
-	Javadoc parameter not found profileDirectory in method: validateProfileDirectory (Line: 36)
-	Missing description for method validateFile (Line: 60)
-	Javadoc parameter not found file in method: validateFile (Line: 60)
-	Missing description for method validateExtensionDirectory (Line: 80)
-	Javadoc parameter not found extensionDirectory in method: validateExtensionDirectory (Line: 80)
+	Missing description for method main (Line: 27)
+	Javadoc parameter not found args in method: main (Line: 27)
+	Missing description for method validateProfileDirectory (Line: 48)
+	Javadoc parameter not found profileDirectory in method: validateProfileDirectory (Line: 48)
+	Missing description for method validateFile (Line: 79)
+	Javadoc parameter not found file in method: validateFile (Line: 79)
+	Missing description for method validateExtensionDirectory (Line: 106)
+	Javadoc parameter not found extensionDirectory in method: validateExtensionDirectory (Line: 106)
 
 Javadoc errors for class I2PFirefoxProfileChecker
 File: src/java/net/i2p/i2pfirefox/I2PFirefoxProfileChecker.java
 	Missing description for method main (Line: 22)
 	Javadoc parameter not found args in method: main (Line: 22)
-	Missing description for method validateProfileDirectory (Line: 36)
-	Javadoc parameter not found profileDirectory in method: validateProfileDirectory (Line: 36)
-	Missing description for method validateFile (Line: 68)
-	Javadoc parameter not found file in method: validateFile (Line: 68)
-	Missing description for method validateExtensionDirectory (Line: 88)
-	Javadoc parameter not found extensionDirectory in method: validateExtensionDirectory (Line: 88)
+	Missing description for method validateProfileDirectory (Line: 43)
+	Javadoc parameter not found profileDirectory in method: validateProfileDirectory (Line: 43)
+	Missing description for method validateFile (Line: 82)
+	Javadoc parameter not found file in method: validateFile (Line: 82)
+	Missing description for method validateExtensionDirectory (Line: 109)
+	Javadoc parameter not found extensionDirectory in method: validateExtensionDirectory (Line: 109)
 
 Javadoc errors for class I2PBrowser
 File: src/java/net/i2p/i2pfirefox/I2PBrowser.java

src/java/net/i2p/i2pfirefox/I2PBrowser.java

@@ -11,7 +11,7 @@ package net.i2p.i2pfirefox;
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  *
- * I2PBrowser is a class that is used to open a browser window to the I2P network.
+ * @description I2PBrowser is a class that is used to open a browser window to the I2P network.
  * It automatically detects the operating system and available browsers, and selects
  * the best one to use, with Tor Browser at the top for Firefox and Brave at the top
  * for Chrome.

src/java/net/i2p/i2pfirefox/I2PChromiumProfileChecker.java

@@ -19,6 +19,11 @@ import java.io.File;
  * @since 0.0.1
  */
 public class I2PChromiumProfileChecker {
+    /*
+     * Output feedback if the profile directory is valid or invalid
+     * @description Output feedback if the profile directory is valid or invalid
+     * @since 0.0.1
+     */
     public static void main(String[] args) {
         String profileDirectory = I2PChromiumProfileBuilder.profileDirectory();
         if (profileDirectory == null) {
@@ -33,6 +38,13 @@ public class I2PChromiumProfileChecker {
             System.out.println("Profile directory is invalid");
         }
     }    
+    /*
+     * Return true if the profile directory is valid.
+     * 
+     * @param profileDirectory the profile directory to check
+     * @return true if the profile directory is valid, false otherwise
+     * @since 0.0.1
+     */
     public static boolean validateProfileDirectory(String profileDirectory) {
         File profileDir = new File(profileDirectory);
         if (!profileDir.exists()) {
@@ -57,6 +69,13 @@ public class I2PChromiumProfileChecker {
         }
         return true;
     }
+    /*
+     * Return true if the extension directory is valid.
+     * 
+     * @param extensionDirectory the extension directory to check
+     * @return true if the extension directory is valid, false otherwise
+     * @since 0.0.1
+     */
     public static boolean validateFile(String file) {
         File f = new File(file);
         if (!f.exists()) {
@@ -77,6 +96,13 @@ public class I2PChromiumProfileChecker {
         }
         return true;
     }
+    /*
+     * Return true if the extension directory is valid.
+     * 
+     * @param extensionDirectory the extension directory to check
+     * @return true if the extension directory is valid, false otherwise
+     * @since 0.0.1
+     */
     public static boolean validateExtensionDirectory(String extensionDirectory) {
         File extensionDir = new File(extensionDirectory);
         if (!extensionDir.exists()) {

src/java/net/i2p/i2pfirefox/I2PFirefoxProfileChecker.java

@@ -33,6 +33,13 @@ public class I2PFirefoxProfileChecker {
             System.out.println("Profile directory is invalid");
         }
     }
+    /*
+     * Return true if the profile directory is valid.
+     * 
+     * @param profileDirectory the profile directory to check
+     * @return true if the profile directory is valid, false otherwise
+     * @since 0.0.1
+     */
     public static boolean validateProfileDirectory(String profileDirectory) {
         File profileDir = new File(profileDirectory);
         if (!profileDir.exists()) {
@@ -65,6 +72,13 @@ public class I2PFirefoxProfileChecker {
         }
         return true;
     }
+    /*
+     * Return true if the file is valid.
+     * 
+     * @param file the file to check
+     * @return true if the file is valid, false otherwise
+     * @since 0.0.1
+     */
     public static boolean validateFile(String file) {
         File f = new File(file);
         if (!f.exists()) {
@@ -85,6 +99,13 @@ public class I2PFirefoxProfileChecker {
         }
         return true;
     }
+    /*
+     * Return true if the extension directory is valid.
+     * 
+     * @param extensionDirectory the extension directory to check
+     * @return true if the extension directory is valid, false otherwise
+     * @since 0.0.1
+     */
     public static boolean validateExtensionDirectory(String extensionDirectory) {
         File extensionDir = new File(extensionDirectory);
         if (!extensionDir.exists()) {