Skip to content

Commit

Permalink
fix scaladoc (#222)
Browse files Browse the repository at this point in the history
  • Loading branch information
kpodsiad committed Jun 30, 2023
1 parent fe5d19d commit 6b6bc41
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
10 changes: 5 additions & 5 deletions src/main/scala-2/com/evolution/scache/CacheOpsCompat.scala
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,14 @@ object CacheOpsCompat {

/** Gets a value for specific key, or tries to load it.
*
* The difference between this method and [[Cache#getOrUpdate1]] is that
* The difference between this method and [[com.evolution.scache.Cache#getOrUpdate1]] is that
* this one allows the loading function to fail finding the value, i.e.
* return [[scala.None]].
*
* Also this method is meant to be used where [[cats.effect.Resource]] is
* not convenient to use, i.e. when integration with legacy code is
* required or for internal implementation. For all other cases it is
* recommended to use [[#getOrUpdateResourceOpt]] instead as more
* recommended to use [[com.evolution.scache.Cache.CacheOps#getOrUpdateResourceOpt]] instead as more
* human-readable alternative.
*
* @param key
Expand All @@ -41,7 +41,7 @@ object CacheOpsCompat {
* cache.
*
* @return
* The same semantics applies as in [[Cache#getOrUpdate1]], except that
* The same semantics applies as in [[com.evolution.scache.Cache#getOrUpdate1]], except that
* the method may return [[scala.None]] in case `value` completes to
* [[scala.None]].
*/
Expand All @@ -63,7 +63,7 @@ object CacheOpsCompat {

/** Gets a value for specific key, or tries to load it.
*
* The difference between this method and [[#getOrUpdateResource]] is that
* The difference between this method and [[com.evolution.scache.Cache.CacheOps#getOrUpdateResource]] is that
* this one allows the loading function to fail finding the value,
* i.e. return [[scala.None]].
*
Expand All @@ -73,7 +73,7 @@ object CacheOpsCompat {
* The function to run to load the missing value with.
*
* @return
* The same semantics applies as in [[#getOrUpdateResource]], except that
* The same semantics applies as in [[com.evolution.scache.Cache.CacheOps#getOrUpdateResource]], except that
* the method may return [[scala.None]] in case `value` completes to
* [[scala.None]]. The resource will be released normally even if `None`
* is returned.
Expand Down
10 changes: 5 additions & 5 deletions src/main/scala-3/com/evolution/scache/CacheOpsCompat.scala
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,14 @@ object CacheOpsCompat {

/** Gets a value for specific key, or tries to load it.
*
* The difference between this method and [[Cache#getOrUpdate1]] is that
* The difference between this method and [[com.evolution.scache.Cache#getOrUpdate1]] is that
* this one allows the loading function to fail finding the value, i.e.
* return [[scala.None]].
*
* Also this method is meant to be used where [[cats.effect.Resource]] is
* not convenient to use, i.e. when integration with legacy code is
* required or for internal implementation. For all other cases it is
* recommended to use [[#getOrUpdateResourceOpt]] instead as more
* recommended to use [[com.evolution.scache.Cache.CacheOps#getOrUpdateResourceOpt]] instead as more
* human-readable alternative.
*
* @param key
Expand All @@ -40,7 +40,7 @@ object CacheOpsCompat {
* cache.
*
* @return
* The same semantics applies as in [[Cache#getOrUpdate1]], except that
* The same semantics applies as in [[com.evolution.scache.Cache#getOrUpdate1]], except that
* the method may return [[scala.None]] in case `value` completes to
* [[scala.None]].
*/
Expand All @@ -62,7 +62,7 @@ object CacheOpsCompat {

/** Gets a value for specific key, or tries to load it.
*
* The difference between this method and [[#getOrUpdateResource]] is that
* The difference between this method and [[com.evolution.scache.Cache.CacheOps#getOrUpdateResource]] is that
* this one allows the loading function to fail finding the value,
* i.e. return [[scala.None]].
*
Expand All @@ -72,7 +72,7 @@ object CacheOpsCompat {
* The function to run to load the missing value with.
*
* @return
* The same semantics applies as in [[#getOrUpdateResource]], except that
* The same semantics applies as in [[com.evolution.scache.Cache.CacheOps#getOrUpdateResource]], except that
* the method may return [[scala.None]] in case `value` completes to
* [[scala.None]]. The resource will be released normally even if `None`
* is returned.
Expand Down

0 comments on commit 6b6bc41

Please sign in to comment.