Skip to content

Commit

Permalink
docs: correct natspec in LockupTranched namespace
Browse files Browse the repository at this point in the history
  • Loading branch information
andreivladbrg committed Feb 14, 2024
1 parent 842d550 commit ed72561
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions src/types/DataTypes.sol
Original file line number Diff line number Diff line change
Expand Up @@ -284,7 +284,7 @@ library LockupLinear {

/// @notice Namespace for the structs used in {SablierV2LockupTranched}.
library LockupTranched {
/// @notice Struct encapsulating the parameters for the {SablierV2LockupDynamic.createWithDurations} function.
/// @notice Struct encapsulating the parameters for the {SablierV2LockupTranched.createWithDurations} function.
/// @param sender The address streaming the assets, with the ability to cancel the stream. It doesn't have to be the
/// same as `msg.sender`.
/// @param recipient The address receiving the assets.
Expand All @@ -308,7 +308,7 @@ library LockupTranched {
Broker broker;
}

/// @notice Struct encapsulating the parameters for the {SablierV2LockupDynamic.createWithTimestamps}
/// @notice Struct encapsulating the parameters for the {SablierV2LockupTranched.createWithTimestamps}
/// function.
/// @param sender The address streaming the assets, with the ability to cancel the stream. It doesn't have to be the
/// same as `msg.sender`.
Expand Down Expand Up @@ -359,7 +359,7 @@ library LockupTranched {
Tranche[] tranches;
}

/// @notice Tranche struct used in the Lockup Dynamic stream.
/// @notice Tranche struct used in the Lockup Tranched stream.
/// @param amount The amount of assets to be streamed in this tranche, denoted in units of the asset's decimals.
/// @param timestamp The Unix timestamp indicating this tranche's end.
struct Tranche {
Expand All @@ -368,7 +368,7 @@ library LockupTranched {
uint40 timestamp;
}

/// @notice Tranche struct used at runtime in {SablierV2LockupDynamic.createWithDurations}.
/// @notice Tranche struct used at runtime in {SablierV2LockupTranched.createWithDurations}.
/// @param amount The amount of assets to be streamed in this tranche, denoted in units of the asset's decimals.
/// @param duration The time difference in seconds between this tranche and the previous one.
struct TrancheWithDuration {
Expand Down

0 comments on commit ed72561

Please sign in to comment.