docs: NatSpec improvments

aragon · Oct 23, 2023 · 259f08b · 259f08b
1 parent f473fd4
commit 259f08b
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/contracts/src/utils/VersionComparisonLib.sol b/contracts/src/utils/VersionComparisonLib.sol
@@ -2,6 +2,10 @@
 
 pragma solidity ^0.8.8;
 
+/// @title VersionComparisonLib
+/// @author Aragon Association - 2023
+/// @notice A library containing methods for [semantic version number](https://semver.org/spec/v2.0.0.html) comparison.
+/// @custom:security-contact [email protected]
 library VersionComparisonLib {
     /// @notice Equality comparator for two semantic version numbers.
     /// @param lhs The left-hand side semantic version number.

diff --git a/contracts/src/utils/proxy/ProxyLib.sol b/contracts/src/utils/proxy/ProxyLib.sol
@@ -6,6 +6,10 @@ import {ERC1967Proxy} from "@openzeppelin/contracts/proxy/ERC1967/ERC1967Proxy.s
 import {Clones} from "@openzeppelin/contracts/proxy/Clones.sol";
 import {Address} from "@openzeppelin/contracts/utils/Address.sol";
 
+/// @title ProxyLib
+/// @author Aragon Association - 2023
+/// @notice A library containing methods for the deployment of proxies via the UUPS pattern (see [ERC-1822](https://eips.ethereum.org/EIPS/eip-1822)) and minimal proxy pattern (see [ERC-1167](https://eips.ethereum.org/EIPS/eip-1167)).
+/// @custom:security-contact [email protected]
 library ProxyLib {
     using Clones for address;
     using Address for address;