Skip to content

Commit

Permalink
Add more scaladocs to the project (#181)
Browse files Browse the repository at this point in the history
* Add documentation for Cache and Cache#empty

* Added a case class as a recommended type for a key.

* Added documentation for Cache#loading methods.

* Fixed some typos.

* Link to sdlib classes.

* Add documentation for Cache#expiring.

* Fixed local links.

* Add #fromPartititons documentation.

* Work in progress on documenting ExpiringCache.Config.

* Document refresh and maxSize.

* Add usage examples.

* Added documentation for #get and #get1.

* Fixed a typo.

* Add documentation for #getOrElse.

* Fixed typo.

* Return final where it was.

* Added getOrUpdate1 documentation.

* Fixed a typo.

* Fixed more typos.

* Added documentation for getOrUpdateOpt.

* Suggest to use resources for readability.

* Added put documentation.

* Fixed typo.

* Added documentation for getOrUpdateResource.

* Added documentation for getOrUpdateOpt1.

* Added documentation for values.

* Added documentation for clear.

* Update src/main/scala/com/evolution/scache/Cache.scala

Co-authored-by: Mareks Rampāns <8796159+mr-git@users.noreply.github.com>

* Improved formatting.

* Added documentation for foldMap.

* Added explanation about the need to have CommutativeMonoid.

* Added documentation for getOrUpdateResourceOpt method.

* Added documentation for getOrUpdate2.

* Added documentation for getOrElse.

* Added withFence documentation.

* Removed performance note.

* Added note about resource releasing undelrying resources.

* Fixed compilation issue.

---------

Co-authored-by: Mareks Rampāns <8796159+mr-git@users.noreply.github.com>
  • Loading branch information
rtar and mr-git committed Mar 8, 2023
1 parent 9bcbc5b commit 1c6baa4
Show file tree
Hide file tree
Showing 3 changed files with 631 additions and 43 deletions.
2 changes: 2 additions & 0 deletions build.sbt
Expand Up @@ -45,6 +45,8 @@ libraryDependencies ++= Seq(
scalatest % Test
)

autoAPIMappings := true

licenses := Seq(("MIT", url("https://opensource.org/licenses/MIT")))

description := "Cache in Scala with cats-effect"
Expand Down

0 comments on commit 1c6baa4

Please sign in to comment.