Skip to content

Commit

Permalink
JavaDoc fixes.
Browse files Browse the repository at this point in the history
Signed-off-by: Chris Larsen <[email protected]>
  • Loading branch information
manolama committed Jun 9, 2017
1 parent 3fe5133 commit 6635f4c
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 10 deletions.
2 changes: 1 addition & 1 deletion src/AppendRequest.java
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
* later.
* <p>
* Note that the results of the append operation
* are not returned at this time. Issue a {@see GetRequest} to fetch the results.
* are not returned at this time. Issue a {@link GetRequest} to fetch the results.
* <p>
* <h1>A note on passing {@code byte} arrays in argument</h1>
* None of the method that receive a {@code byte[]} in argument will copy it.
Expand Down
3 changes: 2 additions & 1 deletion src/BufferedIncrement.java
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,8 @@ public String toString() {
* reserved to keep track of how many times the value
* got changed.
* <p>
* Implementation details:<br/>
* Implementation details:
* <p>
* The first 49 most significant bits are the value of
* the amount (including 1 bit for the sign), the last
* 15 least significant bits are the number of times
Expand Down
7 changes: 3 additions & 4 deletions src/HBaseClient.java
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,6 @@
* an RPC in flight will lead to <em>unpredictable</em> results and voids
* your warranty</strong>.
*
* <a name="#durability"></a>
* <h1>Data Durability</h1>
* Some methods or RPC types take a {@code durable} argument. When an edit
* requests to be durable, the success of the RPC guarantees that the edit is
Expand Down Expand Up @@ -563,7 +562,7 @@ public HBaseClient(final Config config) {
* "asynchbase.zk.quorum" specified in the format {@code "host1,host2,host3"}
* and an executor thread pool.
* @param config A configuration object
* @param The executor from which to obtain threads for NIO
* @param executor The executor from which to obtain threads for NIO
* operations. It is <strong>strongly</strong> encouraged to use a
* {@link Executors#newCachedThreadPool} or something equivalent unless
* you're sure to understand how Netty creates and uses threads.
Expand Down Expand Up @@ -946,8 +945,8 @@ public short getFlushInterval() {
return flush_interval;
}

/** @returns the default RPC timeout period in milliseconds
* @since 1.7 */
/** @return the default RPC timeout period in milliseconds
* @since 1.7 */
public int getDefaultRpcTimeout() {
return rpc_timeout;
}
Expand Down
2 changes: 1 addition & 1 deletion src/HBaseRpc.java
Original file line number Diff line number Diff line change
Expand Up @@ -528,7 +528,7 @@ synchronized void setSuspendedProbe(boolean suspended_probe) {
* A timeout, in milliseconds, to set for this RPC. If the RPC cannot be
* sent and processed by HBase within this period then a
* {@link RpcTimedOutException} will be returned in the deferred.
* <b>
* <p>
* If no timeout is set, then "hbase.rpc.timeout" will be used by default.
* However if a value of "0" is supplied as the timeout, then the RPC will
* not be timed out.
Expand Down
2 changes: 1 addition & 1 deletion src/RegionLocation.java
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ public byte[] getTable() {
/**
* Returns the full name or ID of the region as used in HBase and displayed
* in the HBase GUI. The format is as follows:
* [<namespace>:]<table>,<start_key>,<creation_timestamp>,<md5>
* [&lt;namespace&gt;:]&lt;table&gt;,&lt;start_key&gt;,&lt;creation_timestamp&gt;,&lt;md5&gt;
* @return The name of the region
*/
public byte[] getRegionName() {
Expand Down
5 changes: 3 additions & 2 deletions src/jsr166e/LongAdder.java
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,9 @@
* instances are expected to be mutated, and so are not useful as
* collection keys.
*
* <p><em>jsr166e note: This class is targeted to be placed in
* java.util.concurrent.atomic<em>
* <p>
* <em>jsr166e note: This class is targeted to be placed in
* java.util.concurrent.atomic</em>
*
* @since 1.8
* @author Doug Lea
Expand Down

0 comments on commit 6635f4c

Please sign in to comment.