You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@zookeeper.apache.org by si...@apache.org on 2014/09/18 06:47:23 UTC
svn commit: r1625885 - in /zookeeper/bookkeeper/trunk: ./
bookkeeper-server/src/main/java/org/apache/bookkeeper/client/
bookkeeper-server/src/main/java/org/apache/bookkeeper/conf/
Author: sijie
Date: Thu Sep 18 04:47:22 2014
New Revision: 1625885
URL: http://svn.apache.org/r1625885
Log:
BOOKKEEPER-785: Fix javadoc warnings in trunk (ivank via sijie)
Modified:
zookeeper/bookkeeper/trunk/CHANGES.txt
zookeeper/bookkeeper/trunk/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/LedgerHandle.java
zookeeper/bookkeeper/trunk/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/LedgerMetadata.java
zookeeper/bookkeeper/trunk/bookkeeper-server/src/main/java/org/apache/bookkeeper/conf/ClientConfiguration.java
zookeeper/bookkeeper/trunk/bookkeeper-server/src/main/java/org/apache/bookkeeper/conf/ServerConfiguration.java
Modified: zookeeper/bookkeeper/trunk/CHANGES.txt
URL: http://svn.apache.org/viewvc/zookeeper/bookkeeper/trunk/CHANGES.txt?rev=1625885&r1=1625884&r2=1625885&view=diff
==============================================================================
--- zookeeper/bookkeeper/trunk/CHANGES.txt (original)
+++ zookeeper/bookkeeper/trunk/CHANGES.txt Thu Sep 18 04:47:22 2014
@@ -230,6 +230,8 @@ Trunk (unreleased changes)
BOOKKEEPER-783: Avoid running out of fds in MutlipleThreadReadTest (sijie via ivank)
+ BOOKKEEPER-785: Fix javadoc warnings in trunk (ivank via sijie)
+
bookkeeper-benchmark:
BOOKKEEPER-768: fix typo 'seconds' to milliseconds in benchmark output (jialin via sijie)
Modified: zookeeper/bookkeeper/trunk/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/LedgerHandle.java
URL: http://svn.apache.org/viewvc/zookeeper/bookkeeper/trunk/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/LedgerHandle.java?rev=1625885&r1=1625884&r2=1625885&view=diff
==============================================================================
--- zookeeper/bookkeeper/trunk/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/LedgerHandle.java (original)
+++ zookeeper/bookkeeper/trunk/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/LedgerHandle.java Thu Sep 18 04:47:22 2014
@@ -187,7 +187,7 @@ public class LedgerHandle {
* Add to the length of the ledger in bytes.
*
* @param delta
- * @return
+ * @return the length of the ledger after the addition
*/
long addToLength(long delta) {
this.length += delta;
Modified: zookeeper/bookkeeper/trunk/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/LedgerMetadata.java
URL: http://svn.apache.org/viewvc/zookeeper/bookkeeper/trunk/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/LedgerMetadata.java?rev=1625885&r1=1625884&r2=1625885&view=diff
==============================================================================
--- zookeeper/bookkeeper/trunk/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/LedgerMetadata.java (original)
+++ zookeeper/bookkeeper/trunk/bookkeeper-server/src/main/java/org/apache/bookkeeper/client/LedgerMetadata.java Thu Sep 18 04:47:22 2014
@@ -227,11 +227,11 @@ public class LedgerMetadata {
}
/**
- * the entry id > the given entry-id at which the next ensemble change takes
- * place ( -1 if no further ensemble changes)
+ * the entry id greater than the given entry-id at which the next ensemble change takes
+ * place
*
* @param entryId
- * @return
+ * @return the entry id of the next ensemble change (-1 if no further ensemble changes)
*/
long getNextEnsembleChange(long entryId) {
SortedMap<Long, ArrayList<BookieSocketAddress>> tailMap = ensembles.tailMap(entryId + 1);
@@ -435,10 +435,10 @@ public class LedgerMetadata {
}
/**
- * Is the metadata newer that given <i>newMeta</i>.
+ * Is the metadata newer than given <i>newMeta</i>.
*
- * @param newMeta
- * @return
+ * @param newMeta the metadata to compare
+ * @return true if <i>this</i> is newer than <i>newMeta</i>, false otherwise
*/
boolean isNewerThan(LedgerMetadata newMeta) {
if (null == version) {
Modified: zookeeper/bookkeeper/trunk/bookkeeper-server/src/main/java/org/apache/bookkeeper/conf/ClientConfiguration.java
URL: http://svn.apache.org/viewvc/zookeeper/bookkeeper/trunk/bookkeeper-server/src/main/java/org/apache/bookkeeper/conf/ClientConfiguration.java?rev=1625885&r1=1625884&r2=1625885&view=diff
==============================================================================
--- zookeeper/bookkeeper/trunk/bookkeeper-server/src/main/java/org/apache/bookkeeper/conf/ClientConfiguration.java (original)
+++ zookeeper/bookkeeper/trunk/bookkeeper-server/src/main/java/org/apache/bookkeeper/conf/ClientConfiguration.java Thu Sep 18 04:47:22 2014
@@ -349,7 +349,7 @@ public class ClientConfiguration extends
* will be executed and it will error out entries that have timed out.
*
* We do it more aggressive to not accumulate pending requests due to slow responses.
- * @return
+ * @return the interval at which request timeouts will be checked
*/
@Deprecated
public long getTimeoutTaskIntervalMillis() {
Modified: zookeeper/bookkeeper/trunk/bookkeeper-server/src/main/java/org/apache/bookkeeper/conf/ServerConfiguration.java
URL: http://svn.apache.org/viewvc/zookeeper/bookkeeper/trunk/bookkeeper-server/src/main/java/org/apache/bookkeeper/conf/ServerConfiguration.java?rev=1625885&r1=1625884&r2=1625885&view=diff
==============================================================================
--- zookeeper/bookkeeper/trunk/bookkeeper-server/src/main/java/org/apache/bookkeeper/conf/ServerConfiguration.java (original)
+++ zookeeper/bookkeeper/trunk/bookkeeper-server/src/main/java/org/apache/bookkeeper/conf/ServerConfiguration.java Thu Sep 18 04:47:22 2014
@@ -808,8 +808,8 @@ public class ServerConfiguration extends
}
/**
- * Get the number of bytes we should use as capacity for the {@link
- * org.apache.bookkeeper.bookie.BufferedReadChannel}
+ * Get the number of bytes we should use as capacity for
+ * org.apache.bookkeeper.bookie.BufferedReadChannel
* Default is 512 bytes
* @return read buffer size
*/
@@ -818,8 +818,8 @@ public class ServerConfiguration extends
}
/**
- * Set the number of bytes we should use as capacity for the {@link
- * org.apache.bookkeeper.bookie.BufferedReadChannel}
+ * Set the number of bytes we should use as capacity for
+ * org.apache.bookkeeper.bookie.BufferedReadChannel
*
* @param readBufferSize
* Read Buffer Size
@@ -874,7 +874,7 @@ public class ServerConfiguration extends
* Get the number of bytes used as capacity for the write buffer. Default is
* 64KB.
* NOTE: Make sure this value is greater than the maximum message size.
- * @return
+ * @return the size of the write buffer in bytes
*/
public int getWriteBufferBytes() {
return getInt(WRITE_BUFFER_SIZE, 65536);
@@ -926,7 +926,7 @@ public class ServerConfiguration extends
/**
* Check if sorted-ledger storage enabled (default true)
*
- * @return
+ * @return true if sorted ledger storage is enabled, false otherwise
*/
public boolean getSortedLedgerStorageEnabled() {
return this.getBoolean(SORTED_LEDGER_STORAGE_ENABLED, true);
@@ -953,18 +953,18 @@ public class ServerConfiguration extends
}
/**
- * Get the number of bytes we should use as chunk allocation for the {@link
- * org.apache.bookkeeper.bookie.SkipListArena}
+ * Get the number of bytes we should use as chunk allocation for
+ * org.apache.bookkeeper.bookie.SkipListArena
* Default is 4 MB
- * @return
+ * @return the number of bytes to use for each chunk in the skiplist arena
*/
public int getSkipListArenaChunkSize() {
return getInt(SKIP_LIST_CHUNK_SIZE_ENTRY, 4096 * 1024);
}
/**
- * Set the number of bytes w used as chunk allocation for {@link
- * org.apache.bookkeeper.bookie.SkipListArena}.
+ * Set the number of bytes w used as chunk allocation for
+ * org.apache.bookkeeper.bookie.SkipListArena
*
* @param size chunk size.
* @return server configuration object.
@@ -975,10 +975,10 @@ public class ServerConfiguration extends
}
/**
- * Get the max size we should delegate memory allocation to VM for the {@link
- * org.apache.bookkeeper.bookie.SkipListArena}
- * Default is 128 KB
- * @return
+ * Get the max size we should allocate from the skiplist arena. Allocations
+ * larger than this should be allocated directly by the VM to avoid fragmentation.
+ *
+ * @return max size allocatable from the skiplist arena (Default is 128 KB)
*/
public int getSkipListArenaMaxAllocSize() {
return getInt(SKIP_LIST_MAX_ALLOC_ENTRY, 128 * 1024);
@@ -1101,7 +1101,7 @@ public class ServerConfiguration extends
/**
* Returns the warning threshold for disk usage. If disk usage
* goes beyond this, a garbage collection cycle will be forced.
- * @return
+ * @return the percentage at which a disk usage warning will trigger
*/
public float getDiskUsageWarnThreshold() {
return getFloat(DISK_USAGE_WARN_THRESHOLD, 0.90f);
@@ -1123,7 +1123,7 @@ public class ServerConfiguration extends
/**
* Returns disk free space threshold. By default it is 0.95.
*
- * @return float
+ * @return the percentage at which a disk will be considered full
*/
public float getDiskUsageThreshold() {
return getFloat(DISK_USAGE_THRESHOLD, 0.95f);