docs: Add comprehensive NatSpec documentation to core libraries and types #1007
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related Issue
N/A (Improves documentation quality and coverage across core libraries)
Description of changes
This PR enhances the codebase documentation by adding comprehensive NatSpec comments to 14 core library and type files. It specifically focuses on clarifying low-level implementation details, bit manipulation logic, and assembly operations in the
librariesandtypesdirectories.Detailed changes:
@notice,@dev,@param, and@returntags.Currencyvalue type and associated library functions.Files improved:
src/libraries/: BitMath.sol, CurrencyReserves.sol, FixedPoint96.sol, FixedPoint128.sol, LiquidityMath.sol, Lock.sol, ParseBytes.sol, SafeCast.sol, UnsafeMath.sol, NonzeroDeltaCount.sol, CurrencyDelta.solsrc/types/: BalanceDelta.sol, BeforeSwapDelta.sol, PoolId.sol, Currency.sol, Slot0.sol, PoolOperation.soltest/: AddedFixedPointLibraries.t.solfor coverage.