[izpack-changes] r2043 - in izpack-src/trunk/src/lib/com/izforge/izpack: compiler installer io panels util
noreply at berlios.de
noreply at berlios.de
Tue Feb 12 10:09:55 CET 2008
Author: jponge
Date: 2008-02-12 10:09:51 +0100 (Tue, 12 Feb 2008)
New Revision: 2043
Modified:
izpack-src/trunk/src/lib/com/izforge/izpack/compiler/CompilerConfig.java
izpack-src/trunk/src/lib/com/izforge/izpack/compiler/IPackager.java
izpack-src/trunk/src/lib/com/izforge/izpack/compiler/MultiVolumePackager.java
izpack-src/trunk/src/lib/com/izforge/izpack/compiler/Packager.java
izpack-src/trunk/src/lib/com/izforge/izpack/compiler/PackagerFactory.java
izpack-src/trunk/src/lib/com/izforge/izpack/installer/CompileWorker.java
izpack-src/trunk/src/lib/com/izforge/izpack/installer/InstallerBase.java
izpack-src/trunk/src/lib/com/izforge/izpack/installer/Unpacker.java
izpack-src/trunk/src/lib/com/izforge/izpack/installer/UnpackerFactory.java
izpack-src/trunk/src/lib/com/izforge/izpack/installer/WebRepositoryAccessor.java
izpack-src/trunk/src/lib/com/izforge/izpack/io/FileSpanningInputStream.java
izpack-src/trunk/src/lib/com/izforge/izpack/panels/DataCheckPanel.java
izpack-src/trunk/src/lib/com/izforge/izpack/panels/PasswordGroup.java
izpack-src/trunk/src/lib/com/izforge/izpack/panels/TextInputField.java
izpack-src/trunk/src/lib/com/izforge/izpack/util/FileUtil.java
izpack-src/trunk/src/lib/com/izforge/izpack/util/OsConstraint.java
Log:
A few javadoc fixes
Modified: izpack-src/trunk/src/lib/com/izforge/izpack/compiler/CompilerConfig.java
===================================================================
--- izpack-src/trunk/src/lib/com/izforge/izpack/compiler/CompilerConfig.java 2008-02-11 20:06:52 UTC (rev 2042)
+++ izpack-src/trunk/src/lib/com/izforge/izpack/compiler/CompilerConfig.java 2008-02-12 09:09:51 UTC (rev 2043)
@@ -1162,7 +1162,7 @@
/**
* Add files in an archive to a pack
* @param archive the archive file to unpack
- * @parm targetdir the target directory where the content of the archive will be installed
+ * @param targetdir the target directory where the content of the archive will be installed
* @param osList The target OS constraints.
* @param override Overriding behaviour.
* @param pack Pack to be packed into
Modified: izpack-src/trunk/src/lib/com/izforge/izpack/compiler/IPackager.java
===================================================================
--- izpack-src/trunk/src/lib/com/izforge/izpack/compiler/IPackager.java 2008-02-11 20:06:52 UTC (rev 2042)
+++ izpack-src/trunk/src/lib/com/izforge/izpack/compiler/IPackager.java 2008-02-12 09:09:51 UTC (rev 2043)
@@ -196,7 +196,7 @@
/**
* Returns a map of dynamically refreshed variables
- * @return
+ * @return the map
*/
public abstract Map getDynamicVariables();
@@ -205,4 +205,4 @@
* @param dynamicvariables
*/
public abstract void setDynamicVariables(Map dynamicvariables);
-}
\ No newline at end of file
+}
Modified: izpack-src/trunk/src/lib/com/izforge/izpack/compiler/MultiVolumePackager.java
===================================================================
--- izpack-src/trunk/src/lib/com/izforge/izpack/compiler/MultiVolumePackager.java 2008-02-11 20:06:52 UTC (rev 2042)
+++ izpack-src/trunk/src/lib/com/izforge/izpack/compiler/MultiVolumePackager.java 2008-02-12 09:09:51 UTC (rev 2043)
@@ -405,7 +405,7 @@
if (bytesWritten != pf.length()) { throw new IOException(
"File size mismatch when reading " + file); }
inStream.close();
- // keine backreferences möglich
+ // keine backreferences mglich
// storedFiles.put(file, new long[] { packNumber, pos});
}
Modified: izpack-src/trunk/src/lib/com/izforge/izpack/compiler/Packager.java
===================================================================
--- izpack-src/trunk/src/lib/com/izforge/izpack/compiler/Packager.java 2008-02-11 20:06:52 UTC (rev 2042)
+++ izpack-src/trunk/src/lib/com/izforge/izpack/compiler/Packager.java 2008-02-12 09:09:51 UTC (rev 2043)
@@ -391,7 +391,6 @@
* TODO: it would be useful to be able to keep signature information from signed jar files, can
* we combine manifests and still have their content signed?
*
- * @see #copyStream(InputStream, OutputStream)
*/
private void copyZip(ZipInputStream zin, org.apache.tools.zip.ZipOutputStream out) throws IOException
{
@@ -405,7 +404,6 @@
* TODO: it would be useful to be able to keep signature information from signed jar files, can
* we combine manifests and still have their content signed?
*
- * @see #copyStream(InputStream, OutputStream)
*/
private void copyZip(ZipInputStream zin, org.apache.tools.zip.ZipOutputStream out,
List files)
Modified: izpack-src/trunk/src/lib/com/izforge/izpack/compiler/PackagerFactory.java
===================================================================
--- izpack-src/trunk/src/lib/com/izforge/izpack/compiler/PackagerFactory.java 2008-02-11 20:06:52 UTC (rev 2042)
+++ izpack-src/trunk/src/lib/com/izforge/izpack/compiler/PackagerFactory.java 2008-02-12 09:09:51 UTC (rev 2043)
@@ -30,8 +30,8 @@
{
/**
* Returns a new instantiation of the specified packager
- * @param classname
- * @return
+ * @param classname the class name
+ * @return a new packager instance
* @throws InstantiationException
* @throws IllegalAccessException
* @throws ClassNotFoundException
Modified: izpack-src/trunk/src/lib/com/izforge/izpack/installer/CompileWorker.java
===================================================================
--- izpack-src/trunk/src/lib/com/izforge/izpack/installer/CompileWorker.java 2008-02-11 20:06:52 UTC (rev 2042)
+++ izpack-src/trunk/src/lib/com/izforge/izpack/installer/CompileWorker.java 2008-02-12 09:09:51 UTC (rev 2043)
@@ -846,8 +846,6 @@
*
* @param executor The executor, only used when using external compiler.
* @param output The output from the compiler ([0] = stdout, [1] = stderr)
- * @param full_cmdline The command line, first argument is the compiler.
- *
* @return The result of the compilation.
*/
private int runCompiler(FileExecutor executor, String[] output, List cmdline)
Modified: izpack-src/trunk/src/lib/com/izforge/izpack/installer/InstallerBase.java
===================================================================
--- izpack-src/trunk/src/lib/com/izforge/izpack/installer/InstallerBase.java 2008-02-11 20:06:52 UTC (rev 2042)
+++ izpack-src/trunk/src/lib/com/izforge/izpack/installer/InstallerBase.java 2008-02-12 09:09:51 UTC (rev 2043)
@@ -264,7 +264,7 @@
/**
* just plain wrong in case the programfiles are not stored where the developer expects them.
* E.g. in custom installations of large companies or if used internationalized version of windows with a language pack.
- * @return
+ * @return the program files path
*/
private String buildWindowsDefaultPathFromProps()
{
Modified: izpack-src/trunk/src/lib/com/izforge/izpack/installer/Unpacker.java
===================================================================
--- izpack-src/trunk/src/lib/com/izforge/izpack/installer/Unpacker.java 2008-02-11 20:06:52 UTC (rev 2042)
+++ izpack-src/trunk/src/lib/com/izforge/izpack/installer/Unpacker.java 2008-02-12 09:09:51 UTC (rev 2043)
@@ -483,7 +483,6 @@
/**
* Returns a stream to a pack, location depending on if it's web based.
*
- * @param n The pack number.
* @param uninstall true if pack must be uninstalled
* @return The stream or null if it could not be found.
* @exception Exception Description of the Exception
Modified: izpack-src/trunk/src/lib/com/izforge/izpack/installer/UnpackerFactory.java
===================================================================
--- izpack-src/trunk/src/lib/com/izforge/izpack/installer/UnpackerFactory.java 2008-02-11 20:06:52 UTC (rev 2042)
+++ izpack-src/trunk/src/lib/com/izforge/izpack/installer/UnpackerFactory.java 2008-02-12 09:09:51 UTC (rev 2043)
@@ -38,7 +38,7 @@
* @param unpackerclassname
* @param installdata
* @param listener
- * @return
+ * @return the unpacker
*/
public static IUnpacker getUnpacker(String unpackerclassname, AutomatedInstallData installdata, AbstractUIProgressHandler listener){
IUnpacker unpackerobj = null;
Modified: izpack-src/trunk/src/lib/com/izforge/izpack/installer/WebRepositoryAccessor.java
===================================================================
--- izpack-src/trunk/src/lib/com/izforge/izpack/installer/WebRepositoryAccessor.java 2008-02-11 20:06:52 UTC (rev 2042)
+++ izpack-src/trunk/src/lib/com/izforge/izpack/installer/WebRepositoryAccessor.java 2008-02-12 09:09:51 UTC (rev 2043)
@@ -89,7 +89,7 @@
/**
* Get the list of the packs from the remore install.xml
*
- * @return
+ * @return the packs list
*/
public ArrayList getOnlinePacks()
{
@@ -104,7 +104,7 @@
* Returns the contents of a file at url as a string (must be a text file)
*
* @param url
- * @return
+ * @return the content
*/
private String stringFromURL(String url)
{
@@ -164,7 +164,7 @@
/**
* Parse install.xml and return the list of packs
*
- * @return
+ * @return the list of packs
*/
private ArrayList parsePacks()
{
@@ -218,7 +218,7 @@
* to see the download progress there).
*
* @param url
- * @return
+ * @return the url
*/
public static String getCachedUrl(String url, String tempFolder) throws Exception
{
@@ -613,4 +613,4 @@
return defaultValue;
}
-}
\ No newline at end of file
+}
Modified: izpack-src/trunk/src/lib/com/izforge/izpack/io/FileSpanningInputStream.java
===================================================================
--- izpack-src/trunk/src/lib/com/izforge/izpack/io/FileSpanningInputStream.java 2008-02-11 20:06:52 UTC (rev 2042)
+++ izpack-src/trunk/src/lib/com/izforge/izpack/io/FileSpanningInputStream.java 2008-02-12 09:09:51 UTC (rev 2043)
@@ -78,7 +78,7 @@
/**
* checks if the MagicNumber of this stream is valid. The stream has to be opened right before.
*
- * @return
+ * @return wether the magic number is valid or not
* @throws IOException
*/
private boolean isMagicNumberValid() throws IOException
@@ -361,4 +361,4 @@
return filepointer;
}
-}
\ No newline at end of file
+}
Modified: izpack-src/trunk/src/lib/com/izforge/izpack/panels/DataCheckPanel.java
===================================================================
--- izpack-src/trunk/src/lib/com/izforge/izpack/panels/DataCheckPanel.java 2008-02-11 20:06:52 UTC (rev 2042)
+++ izpack-src/trunk/src/lib/com/izforge/izpack/panels/DataCheckPanel.java 2008-02-12 09:09:51 UTC (rev 2043)
@@ -96,8 +96,6 @@
* When the panel is made active, call the printDebugInfo method.
*
* @see com.izforge.izpack.installer.IzPanel#panelActivate()
- * @param none
- * @return void
*/
public void panelActivate()
{
@@ -132,8 +130,6 @@
* Print list of variables names and value, as well as the list
* of packages and their status (selected or not).
*
- * @param none
- * @return void
*/
private void printDebugInfo()
{
Modified: izpack-src/trunk/src/lib/com/izforge/izpack/panels/PasswordGroup.java
===================================================================
--- izpack-src/trunk/src/lib/com/izforge/izpack/panels/PasswordGroup.java 2008-02-11 20:06:52 UTC (rev 2042)
+++ izpack-src/trunk/src/lib/com/izforge/izpack/panels/PasswordGroup.java 2008-02-12 09:09:51 UTC (rev 2043)
@@ -61,13 +61,9 @@
/**
* Creates a password group to manage one or more password fields.
*
- * @param validator A string that specifies a class that provides a password validation service.
- * The class must implement the <code>Validator</code> interface. If an attempt to instantiate
- * this class fails, no validation will be performed.
- * @param processor A string that specifies a class that provides a password processing service,
- * such as password encryption. The class must implement the <code>Processor</code> interface.
- * If an attempt to instantiate this class fails, no processing will be performed. Insted the
- * contents of the first field will be returned.
+ * @param idata the installation data
+ * @param validatorContainers the validator containers
+ * @param processor the processor
*/
/*--------------------------------------------------------------------------*/
public PasswordGroup(InstallData idata, List validatorContainers, String processor)
Modified: izpack-src/trunk/src/lib/com/izforge/izpack/panels/TextInputField.java
===================================================================
--- izpack-src/trunk/src/lib/com/izforge/izpack/panels/TextInputField.java 2008-02-11 20:06:52 UTC (rev 2042)
+++ izpack-src/trunk/src/lib/com/izforge/izpack/panels/TextInputField.java 2008-02-12 09:09:51 UTC (rev 2043)
@@ -89,7 +89,7 @@
* Constructs a text input field.
*
* @param set A default value for field.
- * @param suze The size of the field.
+ * @param size The size of the field.
* @param validator A string that specifies a class to perform validation services. The string
* must completely identify the class, so that it can be instantiated. The class must implement
* the <code>RuleValidator</code> interface. If an attempt to instantiate this class fails, no
Modified: izpack-src/trunk/src/lib/com/izforge/izpack/util/FileUtil.java
===================================================================
--- izpack-src/trunk/src/lib/com/izforge/izpack/util/FileUtil.java 2008-02-11 20:06:52 UTC (rev 2042)
+++ izpack-src/trunk/src/lib/com/izforge/izpack/util/FileUtil.java 2008-02-12 09:09:51 UTC (rev 2043)
@@ -169,7 +169,6 @@
* @param url The URL of the file for which date and time will be returned.
* @return Returns long value which is the date and time of the file. If any error
* occures returns -1 (=no file date and time available).
- * @author Ari Voutilainen, ari(dot)voutilainen(at) iki(dot)fi
*/
public static long getFileDateTime(URL url)
{
Modified: izpack-src/trunk/src/lib/com/izforge/izpack/util/OsConstraint.java
===================================================================
--- izpack-src/trunk/src/lib/com/izforge/izpack/util/OsConstraint.java 2008-02-11 20:06:52 UTC (rev 2042)
+++ izpack-src/trunk/src/lib/com/izforge/izpack/util/OsConstraint.java 2008-02-12 09:09:51 UTC (rev 2043)
@@ -40,14 +40,14 @@
public class OsConstraint
implements java.io.Serializable
{
- //~ Static variables/initializers ·····················································································
+ //~ Static variables/initializers
/**
*
*/
private static final long serialVersionUID = 3762248660406450488L;
- //~ Instance variables ································································································
+ //~ Instance variables
/**
* OS architecture from java system properties
@@ -74,7 +74,7 @@
*/
private String version;
- //~ Constructors ······································································································
+ //~ Constructors
/**
* Constructs a new instance. Please remember, MacOSX belongs to Unix family.
@@ -125,7 +125,7 @@
this(family, name, version, arch, null);
} // end OsConstraint()
- //~ Methods ···········································································································
+ //~ Methods
/**
* Matches OS specification in this class against current system properties.
More information about the izpack-changes
mailing list