add some missing javadoc
This commit is contained in:
@ -20,7 +20,7 @@ package: net.i2p.i2pfirefox
|
|||||||
|
|
||||||
## Methods
|
## Methods
|
||||||
|
|
||||||
### main [[src]](src/java/net/i2p/i2pfirefox/I2PChromiumProfileChecker.java#L22)
|
### main [[src]](src/java/net/i2p/i2pfirefox/I2PChromiumProfileChecker.java#L27)
|
||||||
|
|
||||||
+ Description:
|
+ Description:
|
||||||
+ Access: public
|
+ Access: public
|
||||||
@ -32,7 +32,7 @@ package: net.i2p.i2pfirefox
|
|||||||
| args | String[] | |
|
| args | String[] | |
|
||||||
|
|
||||||
|
|
||||||
### validateProfileDirectory [[src]](src/java/net/i2p/i2pfirefox/I2PChromiumProfileChecker.java#L36)
|
### validateProfileDirectory [[src]](src/java/net/i2p/i2pfirefox/I2PChromiumProfileChecker.java#L48)
|
||||||
|
|
||||||
+ Description:
|
+ Description:
|
||||||
+ Access: public
|
+ Access: public
|
||||||
@ -44,7 +44,7 @@ package: net.i2p.i2pfirefox
|
|||||||
| profileDirectory | String | |
|
| profileDirectory | String | |
|
||||||
|
|
||||||
|
|
||||||
### validateFile [[src]](src/java/net/i2p/i2pfirefox/I2PChromiumProfileChecker.java#L60)
|
### validateFile [[src]](src/java/net/i2p/i2pfirefox/I2PChromiumProfileChecker.java#L79)
|
||||||
|
|
||||||
+ Description:
|
+ Description:
|
||||||
+ Access: public
|
+ Access: public
|
||||||
@ -56,7 +56,7 @@ package: net.i2p.i2pfirefox
|
|||||||
| file | String | |
|
| file | String | |
|
||||||
|
|
||||||
|
|
||||||
### validateExtensionDirectory [[src]](src/java/net/i2p/i2pfirefox/I2PChromiumProfileChecker.java#L80)
|
### validateExtensionDirectory [[src]](src/java/net/i2p/i2pfirefox/I2PChromiumProfileChecker.java#L106)
|
||||||
|
|
||||||
+ Description:
|
+ Description:
|
||||||
+ Access: public
|
+ Access: public
|
||||||
|
@ -32,7 +32,7 @@ package: net.i2p.i2pfirefox
|
|||||||
| args | String[] | |
|
| args | String[] | |
|
||||||
|
|
||||||
|
|
||||||
### validateProfileDirectory [[src]](src/java/net/i2p/i2pfirefox/I2PFirefoxProfileChecker.java#L36)
|
### validateProfileDirectory [[src]](src/java/net/i2p/i2pfirefox/I2PFirefoxProfileChecker.java#L43)
|
||||||
|
|
||||||
+ Description:
|
+ Description:
|
||||||
+ Access: public
|
+ Access: public
|
||||||
@ -44,7 +44,7 @@ package: net.i2p.i2pfirefox
|
|||||||
| profileDirectory | String | |
|
| profileDirectory | String | |
|
||||||
|
|
||||||
|
|
||||||
### validateFile [[src]](src/java/net/i2p/i2pfirefox/I2PFirefoxProfileChecker.java#L68)
|
### validateFile [[src]](src/java/net/i2p/i2pfirefox/I2PFirefoxProfileChecker.java#L82)
|
||||||
|
|
||||||
+ Description:
|
+ Description:
|
||||||
+ Access: public
|
+ Access: public
|
||||||
@ -56,7 +56,7 @@ package: net.i2p.i2pfirefox
|
|||||||
| file | String | |
|
| file | String | |
|
||||||
|
|
||||||
|
|
||||||
### validateExtensionDirectory [[src]](src/java/net/i2p/i2pfirefox/I2PFirefoxProfileChecker.java#L88)
|
### validateExtensionDirectory [[src]](src/java/net/i2p/i2pfirefox/I2PFirefoxProfileChecker.java#L109)
|
||||||
|
|
||||||
+ Description:
|
+ Description:
|
||||||
+ Access: public
|
+ Access: public
|
||||||
|
28
report.log
28
report.log
@ -3,25 +3,25 @@ Generating documentation from src/java/net/i2p/i2pfirefox/
|
|||||||
|
|
||||||
[1;32mJavadoc errors for class [0mI2PChromiumProfileChecker
|
[1;32mJavadoc errors for class [0mI2PChromiumProfileChecker
|
||||||
File: [34msrc/java/net/i2p/i2pfirefox/I2PChromiumProfileChecker.java[0m
|
File: [34msrc/java/net/i2p/i2pfirefox/I2PChromiumProfileChecker.java[0m
|
||||||
[33m Missing description for method [0mmain (Line: 22)
|
[33m Missing description for method [0mmain (Line: 27)
|
||||||
[33m Javadoc parameter not found [0margs in method: main (Line: 22)
|
[33m Javadoc parameter not found [0margs in method: main (Line: 27)
|
||||||
[33m Missing description for method [0mvalidateProfileDirectory (Line: 36)
|
[33m Missing description for method [0mvalidateProfileDirectory (Line: 48)
|
||||||
[33m Javadoc parameter not found [0mprofileDirectory in method: validateProfileDirectory (Line: 36)
|
[33m Javadoc parameter not found [0mprofileDirectory in method: validateProfileDirectory (Line: 48)
|
||||||
[33m Missing description for method [0mvalidateFile (Line: 60)
|
[33m Missing description for method [0mvalidateFile (Line: 79)
|
||||||
[33m Javadoc parameter not found [0mfile in method: validateFile (Line: 60)
|
[33m Javadoc parameter not found [0mfile in method: validateFile (Line: 79)
|
||||||
[33m Missing description for method [0mvalidateExtensionDirectory (Line: 80)
|
[33m Missing description for method [0mvalidateExtensionDirectory (Line: 106)
|
||||||
[33m Javadoc parameter not found [0mextensionDirectory in method: validateExtensionDirectory (Line: 80)
|
[33m Javadoc parameter not found [0mextensionDirectory in method: validateExtensionDirectory (Line: 106)
|
||||||
|
|
||||||
[1;32mJavadoc errors for class [0mI2PFirefoxProfileChecker
|
[1;32mJavadoc errors for class [0mI2PFirefoxProfileChecker
|
||||||
File: [34msrc/java/net/i2p/i2pfirefox/I2PFirefoxProfileChecker.java[0m
|
File: [34msrc/java/net/i2p/i2pfirefox/I2PFirefoxProfileChecker.java[0m
|
||||||
[33m Missing description for method [0mmain (Line: 22)
|
[33m Missing description for method [0mmain (Line: 22)
|
||||||
[33m Javadoc parameter not found [0margs in method: main (Line: 22)
|
[33m Javadoc parameter not found [0margs in method: main (Line: 22)
|
||||||
[33m Missing description for method [0mvalidateProfileDirectory (Line: 36)
|
[33m Missing description for method [0mvalidateProfileDirectory (Line: 43)
|
||||||
[33m Javadoc parameter not found [0mprofileDirectory in method: validateProfileDirectory (Line: 36)
|
[33m Javadoc parameter not found [0mprofileDirectory in method: validateProfileDirectory (Line: 43)
|
||||||
[33m Missing description for method [0mvalidateFile (Line: 68)
|
[33m Missing description for method [0mvalidateFile (Line: 82)
|
||||||
[33m Javadoc parameter not found [0mfile in method: validateFile (Line: 68)
|
[33m Javadoc parameter not found [0mfile in method: validateFile (Line: 82)
|
||||||
[33m Missing description for method [0mvalidateExtensionDirectory (Line: 88)
|
[33m Missing description for method [0mvalidateExtensionDirectory (Line: 109)
|
||||||
[33m Javadoc parameter not found [0mextensionDirectory in method: validateExtensionDirectory (Line: 88)
|
[33m Javadoc parameter not found [0mextensionDirectory in method: validateExtensionDirectory (Line: 109)
|
||||||
|
|
||||||
[1;32mJavadoc errors for class [0mI2PBrowser
|
[1;32mJavadoc errors for class [0mI2PBrowser
|
||||||
File: [34msrc/java/net/i2p/i2pfirefox/I2PBrowser.java[0m
|
File: [34msrc/java/net/i2p/i2pfirefox/I2PBrowser.java[0m
|
||||||
|
@ -11,7 +11,7 @@ package net.i2p.i2pfirefox;
|
|||||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|
* 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
|
* 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
|
* the best one to use, with Tor Browser at the top for Firefox and Brave at the top
|
||||||
* for Chrome.
|
* for Chrome.
|
||||||
|
@ -19,6 +19,11 @@ import java.io.File;
|
|||||||
* @since 0.0.1
|
* @since 0.0.1
|
||||||
*/
|
*/
|
||||||
public class I2PChromiumProfileChecker {
|
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) {
|
public static void main(String[] args) {
|
||||||
String profileDirectory = I2PChromiumProfileBuilder.profileDirectory();
|
String profileDirectory = I2PChromiumProfileBuilder.profileDirectory();
|
||||||
if (profileDirectory == null) {
|
if (profileDirectory == null) {
|
||||||
@ -33,6 +38,13 @@ public class I2PChromiumProfileChecker {
|
|||||||
System.out.println("Profile directory is invalid");
|
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) {
|
public static boolean validateProfileDirectory(String profileDirectory) {
|
||||||
File profileDir = new File(profileDirectory);
|
File profileDir = new File(profileDirectory);
|
||||||
if (!profileDir.exists()) {
|
if (!profileDir.exists()) {
|
||||||
@ -57,6 +69,13 @@ public class I2PChromiumProfileChecker {
|
|||||||
}
|
}
|
||||||
return true;
|
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) {
|
public static boolean validateFile(String file) {
|
||||||
File f = new File(file);
|
File f = new File(file);
|
||||||
if (!f.exists()) {
|
if (!f.exists()) {
|
||||||
@ -77,6 +96,13 @@ public class I2PChromiumProfileChecker {
|
|||||||
}
|
}
|
||||||
return true;
|
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) {
|
public static boolean validateExtensionDirectory(String extensionDirectory) {
|
||||||
File extensionDir = new File(extensionDirectory);
|
File extensionDir = new File(extensionDirectory);
|
||||||
if (!extensionDir.exists()) {
|
if (!extensionDir.exists()) {
|
||||||
|
@ -33,6 +33,13 @@ public class I2PFirefoxProfileChecker {
|
|||||||
System.out.println("Profile directory is invalid");
|
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) {
|
public static boolean validateProfileDirectory(String profileDirectory) {
|
||||||
File profileDir = new File(profileDirectory);
|
File profileDir = new File(profileDirectory);
|
||||||
if (!profileDir.exists()) {
|
if (!profileDir.exists()) {
|
||||||
@ -65,6 +72,13 @@ public class I2PFirefoxProfileChecker {
|
|||||||
}
|
}
|
||||||
return true;
|
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) {
|
public static boolean validateFile(String file) {
|
||||||
File f = new File(file);
|
File f = new File(file);
|
||||||
if (!f.exists()) {
|
if (!f.exists()) {
|
||||||
@ -85,6 +99,13 @@ public class I2PFirefoxProfileChecker {
|
|||||||
}
|
}
|
||||||
return true;
|
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) {
|
public static boolean validateExtensionDirectory(String extensionDirectory) {
|
||||||
File extensionDir = new File(extensionDirectory);
|
File extensionDir = new File(extensionDirectory);
|
||||||
if (!extensionDir.exists()) {
|
if (!extensionDir.exists()) {
|
||||||
|
Reference in New Issue
Block a user