Apache
/
lucene
mirror of https://github.com/apache/lucene.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Avoid javadocs containing only @return statements since they make the method summary blank. 

git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1501875 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Adrien Grand 2013-07-10 17:47:11 +00:00
parent c3bc304aaf
commit 3eed8a6c55
2 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
lucene/core/src/java/org/apache/lucene/util/packed/EliasFanoDecoder.java
View File

@ -38,13 +38,13 @@ public class EliasFanoDecoder {
this.numEncoded = efEncoder.numEncoded; // numEncoded is not final in EliasFanoEncoder this.numEncoded = efEncoder.numEncoded; // numEncoded is not final in EliasFanoEncoder
} }
/** @return The Elias-Fano encoder that is decoded. */ /** Return the Elias-Fano encoder that is decoded. */
public EliasFanoEncoder getEliasFanoEncoder() { public EliasFanoEncoder getEliasFanoEncoder() {
return efEncoder; return efEncoder;
} }
/** @return The index of the last decoded value. /** Return the index of the last decoded value.
* The first value encoded by {@link EliasFanoEncoder#encodeNext} has index 0. * The first value encoded by {@link EliasFanoEncoder#encodeNext} has index 0.
* Only valid directly after * Only valid directly after
* {@link #nextValue}, {@link #advanceToValue}, * {@link #nextValue}, {@link #advanceToValue},
@ -61,12 +61,12 @@ public class EliasFanoDecoder {
return efIndex; return efIndex;
} }
/** @return The high value for the current decoding index. */ /** Return the high value for the current decoding index. */
private long currentHighValue() { private long currentHighValue() {
return setBitForIndex - efIndex; // sequence of unary gaps return setBitForIndex - efIndex; // sequence of unary gaps
} }
/** @return The low value for the current decoding index. */ /** Return the low value for the current decoding index. */
private long currentLowValue() { private long currentLowValue() {
assert efIndex >= 0; assert efIndex >= 0;
assert efIndex < numEncoded; assert efIndex < numEncoded;
@ -84,7 +84,7 @@ public class EliasFanoDecoder {
return lowValue; return lowValue;
} }
/** @return The given highValue shifted left by the number of low bits from by the EliasFanoSequence, /** Return the given highValue shifted left by the number of low bits from by the EliasFanoSequence,
* logically OR-ed with the given lowValue. * logically OR-ed with the given lowValue.
*/ */
private long combineHighLowValues(long highValue, long lowValue) { private long combineHighLowValues(long highValue, long lowValue) {
@ -116,7 +116,7 @@ public class EliasFanoDecoder {
setBitForIndex = -1; setBitForIndex = -1;
} }
/** @return the number of bits in a long after (setBitForIndex modulo Long.SIZE) */ /** Return the number of bits in a long after (setBitForIndex modulo Long.SIZE) */
private int getCurrentRightShift() { private int getCurrentRightShift() {
int s = (int) (setBitForIndex & (Long.SIZE-1)); int s = (int) (setBitForIndex & (Long.SIZE-1));
return s; return s;
@ -275,7 +275,7 @@ public class EliasFanoDecoder {
setBitForIndex = (efEncoder.lastEncoded >>> efEncoder.numLowBits) + numEncoded; setBitForIndex = (efEncoder.lastEncoded >>> efEncoder.numLowBits) + numEncoded;
} }
/** @return the number of bits in a long before (setBitForIndex modulo Long.SIZE) */ /** Return the number of bits in a long before (setBitForIndex modulo Long.SIZE) */
private int getCurrentLeftShift() { private int getCurrentLeftShift() {
int s = Long.SIZE - 1 - (int) (setBitForIndex & (Long.SIZE-1)); int s = Long.SIZE - 1 - (int) (setBitForIndex & (Long.SIZE-1));
return s; return s;

2
lucene/core/src/java/org/apache/lucene/util/packed/EliasFanoEncoder.java
View File

@ -220,7 +220,7 @@ public class EliasFanoEncoder {
} }
/** /**
* @return An {@link EliasFanoDecoder} to access the encoded values. * Returns an {@link EliasFanoDecoder} to access the encoded values.
* Perform all calls to {@link #encodeNext} before calling {@link #getDecoder}. * Perform all calls to {@link #encodeNext} before calling {@link #getDecoder}.
*/ */
public EliasFanoDecoder getDecoder() { public EliasFanoDecoder getDecoder() {