Skip to content

Commit 8a3dbf6

Browse files
authored
Fix comment errors in DSCEngine contract (#98)
* Corrected NatSpec errors * Correct lining accidental space added
1 parent 5de2e52 commit 8a3dbf6

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

Diff for: src/DSCEngine.sol

+4-4
Original file line numberDiff line numberDiff line change
@@ -149,8 +149,8 @@ contract DSCEngine is ReentrancyGuard {
149149
}
150150

151151
/*
152-
* @param tokenCollateralAddress: The ERC20 token address of the collateral you're depositing
153-
* @param amountCollateral: The amount of collateral you're depositing
152+
* @param tokenCollateralAddress: The ERC20 token address of the collateral you're withdrawing
153+
* @param amountCollateral: The amount of collateral you're withdrawing
154154
* @param amountDscToBurn: The amount of DSC you want to burn
155155
* @notice This function will withdraw your collateral and burn DSC in one transaction
156156
*/
@@ -190,7 +190,7 @@ contract DSCEngine is ReentrancyGuard {
190190
/*
191191
* @notice careful! You'll burn your DSC here! Make sure you want to do this...
192192
* @dev you might want to use this if you're nervous you might get liquidated and want to just burn
193-
* you DSC but keep your collateral in.
193+
* your DSC but keep your collateral in.
194194
*/
195195
function burnDsc(uint256 amount) external moreThanZero(amount) {
196196
_burnDsc(amount, msg.sender, msg.sender);
@@ -250,7 +250,7 @@ contract DSCEngine is ReentrancyGuard {
250250
///////////////////
251251
/*
252252
* @param amountDscToMint: The amount of DSC you want to mint
253-
* You can only mint DSC if you hav enough collateral
253+
* You can only mint DSC if you have enough collateral
254254
*/
255255
function mintDsc(uint256 amountDscToMint) public moreThanZero(amountDscToMint) nonReentrant {
256256
s_DSCMinted[msg.sender] += amountDscToMint;

0 commit comments

Comments
 (0)