瀏覽代碼

Fix broken references in doc-site (#5004)

Co-authored-by: ernestognw <ernestognw@gmail.com>
Eric Nordelo 1 年之前
父節點
當前提交
df78791c96

+ 6 - 5
contracts/access/manager/AccessManager.sol

@@ -55,8 +55,8 @@ import {Time} from "../../utils/types/Time.sol";
  * will be {AccessManager} itself.
  *
  * WARNING: When granting permissions over an {Ownable} or {AccessControl} contract to an {AccessManager}, be very
- * mindful of the danger associated with functions such as {{Ownable-renounceOwnership}} or
- * {{AccessControl-renounceRole}}.
+ * mindful of the danger associated with functions such as {Ownable-renounceOwnership} or
+ * {AccessControl-renounceRole}.
  */
 contract AccessManager is Context, Multicall, IAccessManager {
     using Time for *;
@@ -109,8 +109,8 @@ contract AccessManager is Context, Multicall, IAccessManager {
     bytes32 private _executionId;
 
     /**
-     * @dev Check that the caller is authorized to perform the operation, following the restrictions encoded in
-     * {_getAdminRestrictions}.
+     * @dev Check that the caller is authorized to perform the operation.
+     * See {AccessManager} description for a detailed breakdown of the authorization logic.
      */
     modifier onlyAuthorized() {
         _checkAuthorized();
@@ -470,7 +470,8 @@ contract AccessManager is Context, Multicall, IAccessManager {
 
     /**
      * @dev Reverts if the operation is currently scheduled and has not expired.
-     * (Note: This function was introduced due to stack too deep errors in schedule.)
+     *
+     * NOTE: This function was introduced due to stack too deep errors in schedule.
      */
     function _checkNotScheduled(bytes32 operationId) private view {
         uint48 prevTimepoint = _schedules[operationId].timepoint;

+ 1 - 1
contracts/access/manager/IAccessManager.sol

@@ -109,7 +109,7 @@ interface IAccessManager {
      * to identify the indirect workflow, and will consider calls that require a delay to be forbidden.
      *
      * NOTE: This function does not report the permissions of this manager itself. These are defined by the
-     * {_canCallSelf} function instead.
+     * {AccessManager} documentation.
      */
     function canCall(
         address caller,

+ 1 - 1
contracts/token/ERC20/extensions/ERC20FlashMint.sol

@@ -32,7 +32,7 @@ abstract contract ERC20FlashMint is ERC20, IERC3156FlashLender {
     error ERC3156ExceededMaxLoan(uint256 maxLoan);
 
     /**
-     * @dev The receiver of a flashloan is not a valid {onFlashLoan} implementer.
+     * @dev The receiver of a flashloan is not a valid {IERC3156FlashBorrower-onFlashLoan} implementer.
      */
     error ERC3156InvalidReceiver(address receiver);
 

+ 4 - 4
contracts/token/ERC20/extensions/ERC20Votes.sol

@@ -14,8 +14,8 @@ import {Checkpoints} from "../../../utils/structs/Checkpoints.sol";
  * NOTE: This contract does not provide interface compatibility with Compound's COMP token.
  *
  * This extension keeps a history (checkpoints) of each account's vote power. Vote power can be delegated either
- * by calling the {delegate} function directly, or by providing a signature to be used with {delegateBySig}. Voting
- * power can be queried through the public accessors {getVotes} and {getPastVotes}.
+ * by calling the {Votes-delegate} function directly, or by providing a signature to be used with {Votes-delegateBySig}. Voting
+ * power can be queried through the public accessors {Votes-getVotes} and {Votes-getPastVotes}.
  *
  * By default, token balance does not account for voting power. This makes transfers cheaper. The downside is that it
  * requires users to delegate to themselves in order to activate checkpoints and have their voting power tracked.
@@ -30,9 +30,9 @@ abstract contract ERC20Votes is ERC20, Votes {
      * @dev Maximum token supply. Defaults to `type(uint208).max` (2^208^ - 1).
      *
      * This maximum is enforced in {_update}. It limits the total supply of the token, which is otherwise a uint256,
-     * so that checkpoints can be stored in the Trace208 structure used by {{Votes}}. Increasing this value will not
+     * so that checkpoints can be stored in the Trace208 structure used by {Votes}. Increasing this value will not
      * remove the underlying limitation, and will cause {_update} to fail because of a math overflow in
-     * {_transferVotingUnits}. An override could be used to further restrict the total supply (to a lower value) if
+     * {Votes-_transferVotingUnits}. An override could be used to further restrict the total supply (to a lower value) if
      * additional logic requires it. When resolving override conflicts on this function, the minimum should be
      * returned.
      */