Skip to content

Commit

Permalink
chore(contracts): improve natspec documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
PierrickGT committed Sep 20, 2021
1 parent 5753d59 commit 354dd31
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 11 deletions.
10 changes: 5 additions & 5 deletions contracts/Manageable.sol
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,17 @@ import "./Ownable.sol";
* @notice Contract module based on Ownable which provides a basic access control mechanism, where
* there is an owner and a manager that can be granted exclusive access to specific functions.
*
* By default, the owner is the deployer of the contract.
* The `owner` is first set by passing the address of the `initialOwner` to the Ownable constructor.
*
* The owner account is set through a two steps process.
* The owner account can be transferred through a two steps process:
* 1. The current `owner` calls {transferOwnership} to set a `pendingOwner`
* 2. The `pendingOwner` calls {acceptOwnership} to accept the ownership transfer
*
* The manager account needs to be set using {setManager}.
*
* This module is used through inheritance. It will make available the modifier
* `onlyManager`, which can be applied to your functions to restrict their use to
* the manager.
* This module is used through inheritance. It will make available the modifiers
* `onlyManager`, `onlyOwner` and `onlyManagerOrOwner`, which can be applied to your functions
* to restrict their use to the manager and/or the owner.
*/
abstract contract Manageable is Ownable {
address private _manager;
Expand Down
9 changes: 3 additions & 6 deletions contracts/Ownable.sol
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,14 @@ pragma solidity ^0.8.0;
* there is an account (an owner) that can be granted exclusive access to
* specific functions.
*
* By default, the owner is the deployer of the contract.
* The `owner` is first set by passing the address of the `initialOwner` to the Ownable constructor.
*
* The owner account is set through a two steps process.
* The owner account can be transferred through a two steps process:
* 1. The current `owner` calls {transferOwnership} to set a `pendingOwner`
* 2. The `pendingOwner` calls {acceptOwnership} to accept the ownership transfer
*
* The manager account needs to be set using {setManager}.
*
* This module is used through inheritance. It will make available the modifier
* `onlyOwner`, which can be applied to your functions to restrict their use to
* the owner.
* `onlyOwner`, which can be applied to your functions to restrict their use to the owner.
*/
abstract contract Ownable {
address private _owner;
Expand Down

0 comments on commit 354dd31

Please sign in to comment.