Menu
▾
▴
[Jnode-svn-commits] SF.net SVN: jnode:[5391] trunk/builder/src/builder/org/jnode
|
From: <cr...@us...> - 2009-05-03 11:52:13
|
Revision: 5391
http://jnode.svn.sourceforge.net/jnode/?rev=5391&view=rev
Author: crawley
Date: 2009-05-03 11:52:03 +0000 (Sun, 03 May 2009)
Log Message:
-----------
Correcting javadoc warnings.
Modified Paths:
--------------
trunk/builder/src/builder/org/jnode/ant/taskdefs/AnnotateTask.java
trunk/builder/src/builder/org/jnode/ant/taskdefs/classpath/CompareTask.java
trunk/builder/src/builder/org/jnode/build/AbstractBootImageBuilder.java
trunk/builder/src/builder/org/jnode/build/AsmSourceInfo.java
trunk/builder/src/builder/org/jnode/build/BootFloppyBuilder.java
trunk/builder/src/builder/org/jnode/build/InitJarsBuilder.java
trunk/builder/src/builder/org/jnode/build/dependencies/BCELDependencyChecker.java
trunk/builder/src/builder/org/jnode/build/documentation/PluginDocumentationTask.java
trunk/builder/src/builder/org/jnode/build/packager/MainFinder.java
trunk/builder/src/builder/org/jnode/build/packager/PackagerTask.java
Modified: trunk/builder/src/builder/org/jnode/ant/taskdefs/AnnotateTask.java
===================================================================
--- trunk/builder/src/builder/org/jnode/ant/taskdefs/AnnotateTask.java 2009-05-03 10:41:17 UTC (rev 5390)
+++ trunk/builder/src/builder/org/jnode/ant/taskdefs/AnnotateTask.java 2009-05-03 11:52:03 UTC (rev 5391)
@@ -100,7 +100,7 @@
/**
* Define the time at which build started.
*
- * @param annotationFile
+ * @param buildStartTime
*/
public final void setBuildStartTime(String buildStartTime) {
this.buildStartTime = buildStartTime;
@@ -109,7 +109,7 @@
/**
* Define the pattern with which buildStartTime is defined.
*
- * @param annotationFile
+ * @param pattern
*/
public final void setPattern(String pattern) {
this.pattern = pattern;
@@ -247,6 +247,7 @@
* properly added
*
* @param file
+ * @param message
* @throws IOException
*/
private void traceClass(File file, String message) throws IOException {
@@ -273,7 +274,7 @@
* @param inputClass
* @param tmpFile
* @param annotations
- * @return
+ * @return {@code true} if the class file was modified
* @throws BuildException
*/
private boolean addAnnotation(File classFile, InputStream inputClass, File tmpFile, String annotations)
Modified: trunk/builder/src/builder/org/jnode/ant/taskdefs/classpath/CompareTask.java
===================================================================
--- trunk/builder/src/builder/org/jnode/ant/taskdefs/classpath/CompareTask.java 2009-05-03 10:41:17 UTC (rev 5390)
+++ trunk/builder/src/builder/org/jnode/ant/taskdefs/classpath/CompareTask.java 2009-05-03 11:52:03 UTC (rev 5391)
@@ -586,20 +586,19 @@
this.destDir = destDir;
}
-
/**
- * Returns the type.
+ * Returns the type of the comparison.
*
- * @return
+ * @return the type of the comparison.
*/
public String getType() {
return type;
}
/**
- * The type of the comparesion.
+ * Sets the type of the comparison.
*
- * @param type of the comparesion
+ * @param type of the comparison.
*/
public void setType(String type) {
this.type = type;
Modified: trunk/builder/src/builder/org/jnode/build/AbstractBootImageBuilder.java
===================================================================
--- trunk/builder/src/builder/org/jnode/build/AbstractBootImageBuilder.java 2009-05-03 10:41:17 UTC (rev 5390)
+++ trunk/builder/src/builder/org/jnode/build/AbstractBootImageBuilder.java 2009-05-03 11:52:03 UTC (rev 5391)
@@ -175,7 +175,7 @@
/**
* Create the kernel-sources element.
*
- * @return
+ * @return the element created
*/
public AsmSourceInfo createNanokernelsources() {
return asmSourceInfo;
@@ -198,6 +198,7 @@
* Compile the methods in the given class to native code.
*
* @param os
+ * @param arch
* @throws ClassNotFoundException
*/
private final void compileClasses(NativeStream os, VmArchitecture arch)
@@ -263,6 +264,7 @@
* image.
*
* @param blockedObjects
+ * @param piRegistry
* @return The loaded resource names
* @throws BuildException
*/
@@ -308,7 +310,7 @@
* Copy the jnode.jar file into a byte array that is added to the java
* image.
*
- * @param blockedObjects
+ * @param piRegistry
* @return The loaded resource names
* @throws BuildException
*/
@@ -597,8 +599,8 @@
emitStaticInitializerCalls(os, bootClasses, clInitCaller);
// This is the end of the image
- X86BinaryAssembler.ObjectInfo dummyObjectAtEnd = os
- .startObject(loadClass(VmMethodCode.class));
+ X86BinaryAssembler.ObjectInfo dummyObjectAtEnd =
+ os.startObject(loadClass(VmMethodCode.class));
pageAlign(os);
dummyObjectAtEnd.markEnd();
os.setObjectRef(imageEnd);
@@ -907,7 +909,7 @@
* Should the given type be compiled with the best compiler.
*
* @param vmClass
- * @return
+ * @return {@code true} if it should, {@code false} if not.
*/
protected boolean isCompileHighOptLevel(VmType<?> vmClass) {
if (vmClass.isArray()) {
@@ -1217,7 +1219,6 @@
* Print any unresolved labels to the out stream and generate a list file
* for all public labels.
*
- * @param os
* @param bootClasses
* @throws BuildException
* @throws UnresolvedObjectRefException
Modified: trunk/builder/src/builder/org/jnode/build/AsmSourceInfo.java
===================================================================
--- trunk/builder/src/builder/org/jnode/build/AsmSourceInfo.java 2009-05-03 10:41:17 UTC (rev 5390)
+++ trunk/builder/src/builder/org/jnode/build/AsmSourceInfo.java 2009-05-03 11:52:03 UTC (rev 5391)
@@ -46,7 +46,7 @@
/**
* Return a list of all configured include directories.
*
- * @return
+ * @return the list of all configured include directories.
*/
public final List<File> includeDirs() {
return Collections.unmodifiableList(includeDirs);
@@ -71,9 +71,9 @@
}
/**
- * Create an includeDir sub element.
+ * Create an includeDir subelement.
*
- * @return
+ * @return the subelement created.
*/
public IncludeDir createIncludeDir() {
return new IncludeDir();
Modified: trunk/builder/src/builder/org/jnode/build/BootFloppyBuilder.java
===================================================================
--- trunk/builder/src/builder/org/jnode/build/BootFloppyBuilder.java 2009-05-03 10:41:17 UTC (rev 5390)
+++ trunk/builder/src/builder/org/jnode/build/BootFloppyBuilder.java 2009-05-03 11:52:03 UTC (rev 5391)
@@ -179,9 +179,9 @@
}
/**
- * Gets the last modification date of all parameters.
+ * Gets the latest modification date for all of the parameter fileSets.
*
- * @return
+ * @return the latest modification date.
*/
protected long getLastModified() {
long lm = 0l;
@@ -321,9 +321,9 @@
}
/**
- * Add a fileset to this task.
+ * Create and add a fileset to this task.
*
- * @return
+ * @return the fileset created
*/
public FileSet createFileset() {
final FileSet fs = new FileSet();
Modified: trunk/builder/src/builder/org/jnode/build/InitJarsBuilder.java
===================================================================
--- trunk/builder/src/builder/org/jnode/build/InitJarsBuilder.java 2009-05-03 10:41:17 UTC (rev 5390)
+++ trunk/builder/src/builder/org/jnode/build/InitJarsBuilder.java 2009-05-03 11:52:03 UTC (rev 5391)
@@ -47,9 +47,9 @@
private PluginListInsertor insertor;
/**
- * Add a fileset to this task.
+ * Create and add a fileset to this task.
*
- * @return
+ * @return the fileset created
*/
public FileSet createFileset() {
final FileSet fs = new FileSet();
Modified: trunk/builder/src/builder/org/jnode/build/dependencies/BCELDependencyChecker.java
===================================================================
--- trunk/builder/src/builder/org/jnode/build/dependencies/BCELDependencyChecker.java 2009-05-03 10:41:17 UTC (rev 5390)
+++ trunk/builder/src/builder/org/jnode/build/dependencies/BCELDependencyChecker.java 2009-05-03 11:52:03 UTC (rev 5391)
@@ -211,9 +211,7 @@
/**
- * @param sb
- * @param depends
- * @param descriptors
+ * @param jarFiles
* @param descriptor
* @throws BuildException
*/
Modified: trunk/builder/src/builder/org/jnode/build/documentation/PluginDocumentationTask.java
===================================================================
--- trunk/builder/src/builder/org/jnode/build/documentation/PluginDocumentationTask.java 2009-05-03 10:41:17 UTC (rev 5390)
+++ trunk/builder/src/builder/org/jnode/build/documentation/PluginDocumentationTask.java 2009-05-03 11:52:03 UTC (rev 5391)
@@ -116,7 +116,7 @@
/**
* Get a list of all included descriptor files.
*
- * @return
+ * @return the descriptor files.
*/
protected File[] getDescriptorFiles() {
final List<File> files = new ArrayList<File>();
Modified: trunk/builder/src/builder/org/jnode/build/packager/MainFinder.java
===================================================================
--- trunk/builder/src/builder/org/jnode/build/packager/MainFinder.java 2009-05-03 10:41:17 UTC (rev 5390)
+++ trunk/builder/src/builder/org/jnode/build/packager/MainFinder.java 2009-05-03 11:52:03 UTC (rev 5391)
@@ -51,7 +51,7 @@
* then scans the jars/resources for main classes.
*
* @param userJar
- * @return
+ * @return the names of the main classes.
* @throws FileNotFoundException
* @throws IOException
*/
Modified: trunk/builder/src/builder/org/jnode/build/packager/PackagerTask.java
===================================================================
--- trunk/builder/src/builder/org/jnode/build/packager/PackagerTask.java 2009-05-03 10:41:17 UTC (rev 5390)
+++ trunk/builder/src/builder/org/jnode/build/packager/PackagerTask.java 2009-05-03 11:52:03 UTC (rev 5391)
@@ -84,7 +84,7 @@
/**
* Is that task enabled ?
- * @return
+ * @return Returns {@code true} if this task is enabled, otherwise {@code false}.
*/
protected final boolean isEnabled() {
return (userApplicationsDir != null);
@@ -92,7 +92,7 @@
/**
* Get properties file used to configure the packager tool.
- * @return
+ * @return the property file.
*/
protected final File getPropertiesFile() {
return isEnabled() ? new File(userApplicationsDir, PROPERTIES_FILE) : null;
@@ -100,7 +100,7 @@
/**
* Get the properties and if necessary read it from the file.
- * @return
+ * @return the task's Properties object.
*/
protected final synchronized Properties getProperties() {
if (properties == null) {
@@ -112,7 +112,7 @@
/**
* Read the properties file used to configure the packager tool.
- * @return
+ * @return a Properties object loaded from the file.
*/
private final Properties readProperties() {
try {
@@ -132,11 +132,13 @@
}
/**
- * Read the properties from the given {@link InputStream}.
+ * Read the properties from the given {@link InputStream} into a new
+ * Properties object. A Properties object may be supplied to provide
+ * defaults for the created Properties object.
*
* @param input
- * @param defaultProps
- * @return
+ * @param defaultProps the default Properties object, or {@code null}.
+ * @return a Properties object loaded from the stream.
*/
private static final Properties readProperties(InputStream input, Properties defaultProps) {
Properties properties = (defaultProps == null) ? new Properties() : new Properties(defaultProps);
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
