Skip to content

Commit 201ed8d

Browse files
committed
fix scaladoc errors
1 parent 6411782 commit 201ed8d

4 files changed

Lines changed: 11 additions & 7 deletions

File tree

.travis.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
language: scala
22
script:
3-
- sbt -J-Xmx2048M clean test
3+
- sbt -J-Xmx4096M clean test doc
44
scala:
55
- 2.11.7
66
jdk:

src/main/scala/longevity/exceptions/subdomain/AssocIsUnpersistedException.scala

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ import longevity.subdomain.Root
66
// TODO this should be a persistence exception
77

88
/** thrown on attempt to use an unpersisted assoc as a persisted assoc. for instance,
9-
* when calling [[longevity.persistence.Repo.retrieve(Assoc)]], or attempting to persist with
10-
* [[longevity.persistence.Repo.create]]
9+
* when calling [[longevity.persistence.Repo repository method]] `retrieve(Assoc[R])`,
10+
* or attempting to persist with [[longevity.persistence.Repo.create]]
1111
*/
1212
class AssocIsUnpersistedException(assoc: Assoc[_ <: Root])
1313
extends AssocException(assoc, "cannot retrieve a persisted aggregate from an unpersisted assoc")

src/main/scala/longevity/persistence/Repo.scala

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,20 @@ trait Repo[R <: Root] {
1818
def retrieve(assoc: Assoc[R]): Future[Option[PState[R]]]
1919

2020
/** retrieves a non-optional persisted assoc
21-
* @throws longevity.exceptions.subdomain.AssocIsUnpersistedException whenever the assoc is not persisted
22-
* @throws NoSuchElementException whenever the assoc does not refer to an aggregate in the repository.
21+
*
22+
* throws NoSuchElementException whenever the assoc does not refer to an aggregate in the repository.
2323
* most likely it was deleted.
24+
*
25+
* @throws longevity.exceptions.subdomain.AssocIsUnpersistedException whenever the assoc is not persisted
2426
*/
2527
def retrieveOne(assoc: Assoc[R]): Future[PState[R]]
2628

2729
/** retrieves an optional aggregate by a key value */
2830
def retrieve(keyVal: KeyVal[R]): Future[Option[PState[R]]]
2931

3032
/** retrieves a non-optional aggregate by a key value
31-
* @throws NoSuchElementException whenever the key value does not refer to an aggregate in the repository
33+
*
34+
* throws NoSuchElementException whenever the key value does not refer to an aggregate in the repository
3235
*/
3336
def retrieveOne(keyVal: KeyVal[R]): Future[PState[R]]
3437

src/main/scala/longevity/subdomain/Assoc.scala

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,8 @@ object Assoc {
2121
*
2222
* there are basically two kinds of associations that you have to understand. the main kind is a
2323
* "persisted assoc", which means an association to an aggregate that has already been persisted.
24-
* the associated aggregate can be retrieved using [[longevity.persistence.Repo.retrieve(Assoc)]].
24+
* the associated aggregate can be retrieved using [[longevity.persistence.Repo repository method]]
25+
* `retrieve(Assoc[R])`.
2526
*
2627
* the second kind of association is an "unpersisted assoc", which you can use when creating multiple
2728
* aggregates at once with [[longevity.persistence.RepoPool.createMany]]. unpersisted assocs are

0 commit comments

Comments
 (0)