fix some javadocs

This commit is contained in:
kimchy 2010-08-02 09:53:08 +03:00
parent 38fe6860d8
commit 4bbbf186b6
6 changed files with 17 additions and 31 deletions

View File

@ -16,11 +16,10 @@
<orderEntry type="module-library" exported=""> <orderEntry type="module-library" exported="">
<library name="jarjar"> <library name="jarjar">
<CLASSES> <CLASSES>
<root url="file://$MODULE_DIR$/../../modules/jarjar/build/libs" /> <root url="jar://$MODULE_DIR$/../../modules/jarjar/build/libs/jarjar-0.9.1-SNAPSHOT.jar!/" />
</CLASSES> </CLASSES>
<JAVADOC /> <JAVADOC />
<SOURCES /> <SOURCES />
<jarDirectory url="file://$MODULE_DIR$/../../modules/jarjar/build/libs" recursive="false" />
</library> </library>
</orderEntry> </orderEntry>
<orderEntry type="library" exported="" name="logging" level="project" /> <orderEntry type="library" exported="" name="logging" level="project" />

View File

@ -175,7 +175,7 @@ public class IndexRequestBuilder extends BaseRequestBuilder<IndexRequest, IndexR
} }
/** /**
* Set to <tt>true</tt> to force this index to use {@link IndexRequest.OpType#CREATE}. * Set to <tt>true</tt> to force this index to use {@link org.elasticsearch.action.index.IndexRequest.OpType#CREATE}.
*/ */
public IndexRequestBuilder setCreate(boolean create) { public IndexRequestBuilder setCreate(boolean create) {
request.create(create); request.create(create);

View File

@ -26,7 +26,7 @@ import java.util.concurrent.locks.ReadWriteLock;
import java.util.concurrent.locks.ReentrantReadWriteLock; import java.util.concurrent.locks.ReentrantReadWriteLock;
/** /**
* An implementation of {@link VersionedMap} based on trove {@link org.elasticsearch.util.gnu.trove.TIntIntHashMap}. * An implementation of {@link VersionedMap} based on trove {@link org.elasticsearch.common.trove.TIntIntHashMap}.
* *
* @author kimchy (Shay Banon) * @author kimchy (Shay Banon)
*/ */

View File

@ -19,6 +19,6 @@
/** /**
* Settings loader (parser) allowing to parse different "source" formats into * Settings loader (parser) allowing to parse different "source" formats into
* a {@link Settings}. * a {@link org.elasticsearch.common.settings.Settings}.
*/ */
package org.elasticsearch.common.settings.loader; package org.elasticsearch.common.settings.loader;

View File

@ -113,7 +113,7 @@ import java.util.concurrent.TimeoutException;
* } * }
* </pre> * </pre>
* *
* @author kimchy (Shay Banon) * @author kimchy (shay.banon)
*/ */
public class ThreadBarrier extends CyclicBarrier { public class ThreadBarrier extends CyclicBarrier {
/** /**
@ -122,23 +122,14 @@ public class ThreadBarrier extends CyclicBarrier {
*/ */
private Throwable cause; private Throwable cause;
/**
* {@inheritDoc}
*/
public ThreadBarrier(int parties) { public ThreadBarrier(int parties) {
super(parties); super(parties);
} }
/**
* {@inheritDoc}
*/
public ThreadBarrier(int parties, Runnable barrierAction) { public ThreadBarrier(int parties, Runnable barrierAction) {
super(parties, barrierAction); super(parties, barrierAction);
} }
/**
* {@inheritDoc}
*/
@Override @Override
public int await() throws InterruptedException, BrokenBarrierException { public int await() throws InterruptedException, BrokenBarrierException {
try { try {
@ -150,9 +141,6 @@ public class ThreadBarrier extends CyclicBarrier {
} }
} }
/**
* {@inheritDoc}
*/
@Override public int await(long timeout, TimeUnit unit) throws InterruptedException, BrokenBarrierException, TimeoutException { @Override public int await(long timeout, TimeUnit unit) throws InterruptedException, BrokenBarrierException, TimeoutException {
try { try {
breakIfBroken(); breakIfBroken();
@ -258,18 +246,18 @@ public class ThreadBarrier extends CyclicBarrier {
* <p/> * <p/>
* <B>Usage example:</B><br> * <B>Usage example:</B><br>
* <pre><code> * <pre><code>
* BarrierTimer timer = new BarrierTimer(); * BarrierTimer timer = new BarrierTimer();
* ThreadBarrier barrier = new ThreadBarrier( nTHREADS + 1, timer ); * ThreadBarrier barrier = new ThreadBarrier( nTHREADS + 1, timer );
* .. * ..
* barrier.await(); // starts timer when all threads trip on await * barrier.await(); // starts timer when all threads trip on await
* barrier.await(); // stops timer when all threads trip on await * barrier.await(); // stops timer when all threads trip on await
* .. * ..
* long time = timer.getTimeInNanos(); * long time = timer.getTimeInNanos();
* long tpi = time / ((long)nREPEATS * nTHREADS); //throughput per thread iteration * long tpi = time / ((long)nREPEATS * nTHREADS); //throughput per thread iteration
* long secs = timer.getTimeInSeconds(); //total runtime in seconds * long secs = timer.getTimeInSeconds(); //total runtime in seconds
* .. * ..
* timer.reset(); // reuse timer * timer.reset(); // reuse timer
* </code></pre> * </code></pre>
*/ */
public static class BarrierTimer implements Runnable { public static class BarrierTimer implements Runnable {
volatile boolean started; volatile boolean started;

View File

@ -33,7 +33,6 @@ public interface FieldsFunction {
/** /**
* @param docId * @param docId
* @param vars The vars providing additional parameters, should be reused and has values added to it in execute * @param vars The vars providing additional parameters, should be reused and has values added to it in execute
* @return
*/ */
Object execute(int docId, Map<String, Object> vars); Object execute(int docId, Map<String, Object> vars);
} }