fix javadoc comments

This commit is contained in:
jendave
2011-08-15 19:26:10 +00:00
parent 6d51d2f964
commit 70428f1fa5
16 changed files with 71 additions and 84 deletions

View File

@@ -1,18 +1,18 @@
/** Licensed under both the GPL and the Apache 2.0 License. */
package net.slightlymagic.braids.util.generator;
import java.io.File;
import com.google.code.jyield.Generator;
import com.google.code.jyield.Yieldable;
import java.io.File;
/**
* This is a generator over all of the non-directories residing in a given
* starting directory and all subdirectories of it that do NOT start with a
* dot; this prevents the code from descending into .svn directories.
*
* For documentation on Java-Yield and its generators, see
* {@link http://code.google.com/p/java-yield/}
* {@link com.google.code.jyield.Generator}
*/
public class FindNonDirectoriesSkipDotDirectoriesGenerator implements Generator<File> {
private File startDir;
@@ -36,7 +36,7 @@ public class FindNonDirectoriesSkipDotDirectoriesGenerator implements Generator<
* <p>Yields results to the given Yieldable. Convert Generator instances to
* Iterables with YieldUtils.toIterable.</p>
*
* See {@link https://java-yield.googlecode.com/hg/docs/com/google/code/jyield/YieldUtils.html#toIterable(com.google.code.jyield.Generator)}
* See {@link com.google.code.jyield.YieldUtils#toIterable(com.google.code.jyield.Generator)}
*/
public void generate(Yieldable<File> yy) {
String[] list = startDir.list();

View File

@@ -8,7 +8,7 @@ import com.google.code.jyield.Yieldable;
* substitute for passing around and creating temporary
* lists, collections, and arrays.
*
* @see http://code.google.com/p/jyield/
* {@link com.google.code.jyield.Generator}
*/
public class GeneratorFromArray<T> implements Generator<T> {
private T[] array;

View File

@@ -1,18 +1,17 @@
/** Licensed under both the GPL and the Apache 2.0 License. */
package net.slightlymagic.braids.util.generator;
import java.util.ArrayList;
import java.util.NoSuchElementException;
import net.slightlymagic.braids.util.lambda.Lambda1;
import com.google.code.jyield.Generator;
import com.google.code.jyield.YieldUtils;
import com.google.code.jyield.Yieldable;
import net.slightlymagic.braids.util.lambda.Lambda1;
import java.util.ArrayList;
import java.util.NoSuchElementException;
/**
* For documentation on Java-Yield and its generators, see
* {@link http://code.google.com/p/java-yield/}
* {@link com.google.code.jyield.Generator}.
*/
public final class GeneratorFunctions {

View File

@@ -5,7 +5,7 @@
* They are licensed under both the GPL and the Apache 2.0 license.
*
* For documentation on Java-Yield and its generators, see
* {@link http://code.google.com/p/java-yield/} .
* {@link com.google.code.jyield.Generator}.
*/
package net.slightlymagic.braids.util.generator;

View File

@@ -3,14 +3,14 @@ package net.slightlymagic.braids.util.progress_monitor;
public class StderrProgressMonitor extends BaseProgressMonitor {
/**
* @see BaseProgressMonitor(int,long)
* @see net.slightlymagic.braids.util.progress_monitor.BaseProgressMonitor#BaseProgressMonitor(int, long)
*/
public StderrProgressMonitor(int numPhases, long totalUnitsFirstPhase) {
this(numPhases, totalUnitsFirstPhase, 2.0f, null);
}
/**
* @see BaseProgressMonitor(int,long,float)
* @see net.slightlymagic.braids.util.progress_monitor.BaseProgressMonitor#BaseProgressMonitor(int, long, float)
*/
public StderrProgressMonitor(int numPhases, long totalUnitsFirstPhase,
float minUpdateIntervalSec)
@@ -19,7 +19,7 @@ public class StderrProgressMonitor extends BaseProgressMonitor {
}
/**
* @see BaseProgressMonitor(int,long,float,float[])
* @see net.slightlymagic.braids.util.progress_monitor.BaseProgressMonitor#BaseProgressMonitor(int, long, float, float[])
*/
public StderrProgressMonitor(int numPhases, long totalUnitsFirstPhase,
float minUpdateIntervalSec, float[] phaseWeights)
@@ -29,7 +29,7 @@ public class StderrProgressMonitor extends BaseProgressMonitor {
@Override
/**
* @see BaseProgressMonitor#incrementUnitsCompletedThisPhase(long)
* @see net.slightlymagic.braids.util.progress_monitor.BaseProgressMonitor#BaseProgressMonitor(int)
*/
public void incrementUnitsCompletedThisPhase(long numUnits) {
super.incrementUnitsCompletedThisPhase(numUnits);