Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add natspec #65

Merged
merged 2 commits into from
May 9, 2023
Merged

Add natspec #65

merged 2 commits into from
May 9, 2023

Conversation

zodahu
Copy link
Contributor

@zodahu zodahu commented May 5, 2023

Natspec comments have been added to most /src contracts, except for

  1. Some contracts in /src/fees, as they may be updated recently. For instance, not all functions in FeeVerifier have been provided with Natspec comments.
  2. Some functions are defined in other protocols such as MakerUtility openLockETHAndDraw, AaveV2FlashLoanCallback executeOperation, they don't include the @param Natspec comments, as they are already defined and documented within their respective protocols.

@zodahu zodahu force-pushed the feature/complete_comments branch from f80d999 to e0d8e74 Compare May 5, 2023 09:51
src/Router.sol Outdated Show resolved Hide resolved
src/Router.sol Outdated Show resolved Hide resolved
src/Router.sol Outdated Show resolved Hide resolved
src/Router.sol Show resolved Hide resolved
src/fees/FeeCalculatorBase.sol Outdated Show resolved Hide resolved
src/fees/FeeVerifier.sol Outdated Show resolved Hide resolved
src/interfaces/IParam.sol Outdated Show resolved Hide resolved
src/utilities/MakerUtility.sol Outdated Show resolved Hide resolved
@zodahu zodahu force-pushed the feature/complete_comments branch from e0d8e74 to ef23c9e Compare May 9, 2023 08:32
Copy link
Contributor

@hihiben hihiben left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@zodahu zodahu merged commit 971dbaa into dinngo:master May 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants