Skip to content

Commit 9ed9dc8

Browse files
committed
fix : fix natspec based on pr comments
1 parent 59d3875 commit 9ed9dc8

File tree

2 files changed

+11
-8
lines changed

2 files changed

+11
-8
lines changed

src/access/AccessManagerEnumerable.sol

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@ contract AccessManagerEnumerable is AccessManager, IAccessManagerEnumerable {
3030
mapping(uint64 roleId => mapping(address target => EnumerableSet.Bytes32Set))
3131
private _roleTargetFunctions;
3232

33+
/// @dev Constructor.
34+
/// @param initialAdmin_ The address of the initial admin.
3335
constructor(address initialAdmin_) AccessManager(initialAdmin_) {}
3436

3537
/// @inheritdoc IAccessManagerEnumerable

src/access/interfaces/IAccessManagerEnumerable.sol

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,12 @@ import {IAccessManager} from 'src/dependencies/openzeppelin/IAccessManager.sol';
99
/// @notice Interface for AccessManagerEnumerable extension.
1010
interface IAccessManagerEnumerable is IAccessManager {
1111
/// @notice Returns the indentifier of the role at a specified index.
12-
/// @param index The index in the role member list.
12+
/// @param index The index in the role list.
1313
/// @return The identifier of the role.
1414
function getRole(uint256 index) external view returns (uint64);
1515

16-
/// @notice Returns the number of roles tracked by the AccessManager.
16+
/// @notice Returns the total number of existing roles.
17+
/// @dev Does not account for the built-in `ADMIN_ROLE` & `PUBLIC_ROLE` roles.
1718
/// @return The number of roles.
1819
function getRoleCount() external view returns (uint256);
1920

@@ -34,7 +35,7 @@ interface IAccessManagerEnumerable is IAccessManager {
3435
/// @return The number of members for the role.
3536
function getRoleMemberCount(uint64 roleId) external view returns (uint256);
3637

37-
/// @notice Returns the list of members for a specified role.
38+
/// @notice Returns the list of members for a specified role between the specified indexes.
3839
/// @param roleId The identifier of the role.
3940
/// @param start The starting index for the member list.
4041
/// @param end The ending index for the member list.
@@ -45,9 +46,9 @@ interface IAccessManagerEnumerable is IAccessManager {
4546
uint256 end
4647
) external view returns (address[] memory);
4748

48-
/// @notice Returns the address of the target contract at a specified index.
49+
/// @notice Returns the address of the target contract for a specified role and index.
4950
/// @param roleId The identifier of the role.
50-
/// @param index The index in the role member list.
51+
/// @param index The index in the role target list.
5152
/// @return The address of the target contract.
5253
function getRoleTarget(uint64 roleId, uint256 index) external view returns (address);
5354

@@ -56,10 +57,10 @@ interface IAccessManagerEnumerable is IAccessManager {
5657
/// @return The number of targets for the role.
5758
function getRoleTargetCount(uint64 roleId) external view returns (uint256);
5859

59-
/// @notice Returns the list of targets for a specified role.
60+
/// @notice Returns the list of targets for a specified role between the specified indexes.
6061
/// @param roleId The identifier of the role.
61-
/// @param start The starting index for the target list.
62-
/// @param end The ending index for the target list.
62+
/// @param start The starting index for the role target list.
63+
/// @param end The ending index for the role target list.
6364
/// @return The list of targets for the role.
6465
function getRoleTargets(
6566
uint64 roleId,

0 commit comments

Comments
 (0)