dion 02/05/13 00:26:38
Modified: src/java/org/apache/maven Jxr.java
Log:
Fixed checkstyle issues
Revision Changes Path
1.5 +8 -5 jakarta-turbine-maven/src/java/org/apache/maven/Jxr.java
Index: Jxr.java
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/src/java/org/apache/maven/Jxr.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- Jxr.java 13 May 2002 07:15:22 -0000 1.4
+++ Jxr.java 13 May 2002 07:26:38 -0000 1.5
@@ -60,8 +60,6 @@
import org.apache.maven.executor.AbstractExecutor;
import org.apache.tools.ant.types.Reference;
import org.apache.tools.ant.types.Path;
-import org.apache.tools.ant.Project;
-import org.apache.tools.ant.Task;
import org.apache.tools.ant.BuildException;
import java.util.LinkedList;
import java.io.File;
@@ -73,7 +71,7 @@
*
* @author <a href="mailto:[EMAIL PROTECTED]";>Josh Lucas</a>
* @author <a href="mailto:[EMAIL PROTECTED]";>Jason van Zyl</a>
- * @version $Id: Jxr.java,v 1.4 2002/05/13 07:15:22 dion Exp $
+ * @version $Id: Jxr.java,v 1.5 2002/05/13 07:26:38 dion Exp $
*/
public class Jxr
extends AbstractExecutor
@@ -111,6 +109,7 @@
/**
* Starts the cross-referencing and indexing.
+ * @throws BuildException when any error occurs
*/
public void execute()
throws BuildException
@@ -177,6 +176,7 @@
* @param toDir The directory into which the link points.
* @throws IOException
* If a problem is encountered while navigating through the directories.
+ * @return a string of format "../../schmoo/"
*/
private String getRelativeLink(String fromDir, String toDir)
throws IOException
@@ -204,14 +204,14 @@
{
for (int i = 0; i < parents.size(); ++i)
{
- File parent = (File)parents.get(i);
+ File parent = (File) parents.get(i);
if (f.equals(parent))
{
// when we find the common parent, add the subdirectories
// down to toDir itself
for (int j = 0; j < i; ++j)
{
- File p = (File)parents.get(j);
+ File p = (File) parents.get(j);
toLink.insert(0, p.getName() + "/");
}
found = true;
@@ -227,6 +227,7 @@
/**
* Sets the imageFile attribute of the JxrTask object
+ * @param imageFile the image to be used for the {@link DirectoryIndexer}
*/
public void setImageFile(String imageFile)
{
@@ -235,6 +236,7 @@
/**
* Sets the imageFolder attribute of the JxrTask object
+ * @param imageFolder the folder for the {@link #imageFile}
*/
public void setImageFolder(String imageFolder)
{
@@ -269,6 +271,7 @@
/**
* Sets the destDir attribute of the JxrTask object
+ * @param destDir the destination directory for jxr output
*/
public void setDestDir(String destDir)
{
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
