improve installer javadocs; add minimalist package.html

This commit is contained in:
kytv
2012-12-30 00:36:14 +00:00
parent 77f0dd653a
commit a40566eefb
5 changed files with 28 additions and 11 deletions

View File

@@ -3,9 +3,11 @@ package net.i2p.installer;
import net.i2p.util.FileUtil;
/**
* Usage: Copy from to
* <p>This class is used by the installer to copy files.</p>
* Usage: <code>Copy [FROM] [TO]</code><br>
*
* only for use by installer
* See also: {@link net.i2p.util.FileUtil#copy FileUtil.copy()}.
* @since 0.4.1.4, moved to {@link net.i2p.installer} in 0.9.5
*/
public class Copy {
public static void main(String args[]) {

View File

@@ -3,10 +3,13 @@ package net.i2p.installer;
import net.i2p.util.FileUtil;
/**
* Usage: Delete name
* <p>This class is used by the installer to delete one or more specified files.</p>
* Usage: <code>Delete <u>FILE</u> ...</code><br>
*
* only for use by installer
* See also: {@link net.i2p.util.FileUtil#rmdir FileUtil.rmdir()}.
* @since 0.4.1.4, moved to {@link net.i2p.installer} in 0.9.5
*/
public class Delete {
public static void main(String args[]) {
for(int file=0; file < args.length; file++)

View File

@@ -3,9 +3,11 @@ package net.i2p.installer;
import java.io.File;
/**
* Usage: Exec dir command [args ...]
* <p>This class can be used by the installer to execute shell commands.</p>
* Usage: <code>Exec dir command [args ...]</code><br>
*
* only for use by installer
* See also {@link net.i2p.util.ShellCommand}.
* @since 0.4.1.4, moved to {@link net.i2p.installer} in 0.9.5
*/
public class Exec {
public static void main(String args[]) {
@@ -17,8 +19,8 @@ public class Exec {
// ugly hack, because it seems we'll block otherwise!
// http://cephas.net/blog/2004/03/23/external_applications_javas_runtimeexec.html
try { proc.exitValue(); } catch (Throwable t) { }
Runtime.getRuntime().halt(0);
Runtime.getRuntime().halt(0);
} catch (Exception e) {
e.printStackTrace();
}

View File

@@ -12,9 +12,14 @@ import java.io.PrintStream;
/**
* Usage: FixWinPaths WrapperConfigFile
*
* only for use by installer
* <p>This class is used by the installer in Windows to process the <code>wrapper.config</code> file. It
* <ul>
* <li>rewrites the applicable wrapper config options to point to <code>%APPDATA%\I2P</code></li>
* <li>corrects the paths, rewriting <code>/</code> to <code>\</code></li>
* </ul>
* </p>
* Usage: <code>FixWinPaths [WrapperConfigFile]</code>
* @since 0.9.5
*/
public class FixWinPaths{
public static void main(String args[]) {

View File

@@ -0,0 +1,5 @@
<html><body>
<p>
These classes make up the &quot;Helper Utilities&quot; that are used by the installer.
</p>
</body></html>