Skip to content

Commit 3788e1a

Browse files
giacomocavalierivitlinda
authored andcommitted
docs: add missing links
1 parent 6055338 commit 3788e1a

File tree

2 files changed

+7
-4
lines changed
  • pricing/src/main/scala/dev/atedeg/mdm/pricing
  • production/src/main/scala/dev/atedeg/mdm/production

2 files changed

+7
-4
lines changed

pricing/src/main/scala/dev/atedeg/mdm/pricing/Types.scala

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,8 @@ final case class Client(code: ClientID)
4242
final case class ClientID(id: UUID)
4343

4444
/**
45-
* A promotion for a [[Client client]], with an expiry date, containing promotion lines for some products.
45+
* A promotion for a [[Client client]], with an expiry date, containing
46+
* [[PromotionLine promotion lines]] for some [[Product products]].
4647
*/
4748
final case class Promotion(client: Client, expiryDate: LocalDateTime, lines: NonEmptyList[PromotionLine])
4849

@@ -51,7 +52,8 @@ final case class Promotion(client: Client, expiryDate: LocalDateTime, lines: Non
5152
*/
5253
enum PromotionLine(val product: Product):
5354
/**
54-
* This promotion line specifies the discounted product and how much to discount it by.
55+
* This promotion line specifies the discounted [[Product product]] and
56+
* [[DiscountPercentage how much to discount it by]].
5557
*
5658
* Every order line which contains the product is discounted by the specified amount.
5759
*
@@ -61,7 +63,8 @@ enum PromotionLine(val product: Product):
6163
case Fixed(override val product: Product, discount: DiscountPercentage) extends PromotionLine(product)
6264

6365
/**
64-
* This promotion line specifies the discounted product, the threshold and how much to discount it by.
66+
* This promotion line specifies the discounted [[Product product]],
67+
* the [[ThresholdQuantity threshold]] and [[DiscountPercentage how much to discount it by]].
6568
*
6669
* Only the products above the threshold are discounted; the other ones are at full price.
6770
*

production/src/main/scala/dev/atedeg/mdm/production/Types.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ enum Production:
3939
case InProgress(ID: ProductionID, productInProduction: Product, unitsInProduction: NumberOfUnits)
4040

4141
/**
42-
* A [[Production production]] that ended, it has a [[BatchID lot number]] and specifies the [[Product product]]
42+
* A [[Production production]] that ended, it has a [[BatchID batch ID]] and specifies the [[Product product]]
4343
* that was produced and in the [[NumberOfUnits units]] produced.
4444
*/
4545
case Ended(ID: ProductionID, batchID: BatchID, producedProduct: Product, producedUnits: NumberOfUnits)

0 commit comments

Comments
 (0)