[jira] [Commented] (HBASE-27906) Fix the javadoc for SyncFutureCache

["Hudson (Jira)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/HBASE-27906?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17743951#comment-17743951 ] 

Hudson commented on HBASE-27906:
--------------------------------

Results for branch master
	[build #873 on builds.a.o|https://ci-hbase.apache.org/job/HBase%20Nightly/job/master/873/]: (x) *{color:red}-1 overall{color}*
----
details (if available):

(/) {color:green}+1 general checks{color}
-- For more information [see general report|https://ci-hbase.apache.org/job/HBase%20Nightly/job/master/873/General_20Nightly_20Build_20Report/]




(/) {color:green}+1 jdk8 hadoop3 checks{color}
-- For more information [see jdk8 (hadoop3) report|https://ci-hbase.apache.org/job/HBase%20Nightly/job/master/873/JDK8_20Nightly_20Build_20Report_20_28Hadoop3_29/]


(x) {color:red}-1 jdk11 hadoop3 checks{color}
-- For more information [see jdk11 report|https://ci-hbase.apache.org/job/HBase%20Nightly/job/master/873/JDK11_20Nightly_20Build_20Report_20_28Hadoop3_29/]


(/) {color:green}+1 source release artifact{color}
-- See build output for details.


(/) {color:green}+1 client integration test{color}


> Fix the javadoc for SyncFutureCache
> -----------------------------------
>
>                 Key: HBASE-27906
>                 URL: https://issues.apache.org/jira/browse/HBASE-27906
>             Project: HBase
>          Issue Type: Improvement
>          Components: documentation
>            Reporter: Duo Zhang
>            Assignee: Dimitrios Efthymiou
>            Priority: Minor
>             Fix For: 4.0.0-alpha-1
>
>
> It does not have any html markers so spotless messed it up...
> We should add html markers so it could keep the format after 'spotless:apply'
> {code}
> /**
>  * A cache of {@link SyncFuture}s. This class supports two methods
>  * {@link SyncFutureCache#getIfPresentOrNew()} and {@link SyncFutureCache#offer()}.
>  * <p>
>  * Usage pattern:
>  * 
>  * <pre>
>  *   SyncFuture sf = syncFutureCache.getIfPresentOrNew();
>  *   sf.reset(...);
>  *   // Use the sync future
>  *   finally: syncFutureCache.offer(sf);
>  * </pre>
>  * 
>  * Offering the sync future back to the cache makes it eligible for reuse within the same thread
>  * context. Cache keyed by the accessing thread instance and automatically invalidated if it remains
>  * unused for {@link SyncFutureCache#SYNC_FUTURE_INVALIDATION_TIMEOUT_MINS} minutes.
>  */
> {code}



--
This message was sent by Atlassian Jira
(v8.20.10#820010)