style: satisfy linter

Author: heueristik

src/XanV1.sol

@@ -79,15 +79,16 @@ contract XanV1 is
         _;
     }
 
+    /// @notice Disables the initializers on the implementation contract to prevent it from being left uninitialized.
     /// @custom:oz-upgrades-unsafe-allow constructor
     constructor() {
         _disableInitializers();
     }
 
+    // solhint-disable comprehensive-interface
     /// @notice Initializes the XanV1 contract.
     /// @param initialMintRecipient The initial recipient of the minted tokens.
     /// @param council The address of the governance council contract.
-    // solhint-disable-next-line comprehensive-interface
     function initializeV1(address initialMintRecipient, address council) external initializer {
         // Initialize inherited contracts
         __ERC20_init({name_: Parameters.NAME, symbol_: Parameters.SYMBOL});
@@ -98,7 +99,7 @@ contract XanV1 is
         // Initialize the XanV1 contract
         _mint(initialMintRecipient, Parameters.SUPPLY);
         _getCouncilData().council = council;
-    }
+    } // solhint-enable comprehensive-interface
 
     /// @inheritdoc IXanV1
     function lock(uint256 value) external override {
@@ -518,7 +519,7 @@ contract XanV1 is
     }
 
     /// @notice Returns the storage from the Xan V1 storage location.
-    /// @return xanV1Storage The data associated with Xan token storage.
+    /// @return xanV1Storage The data associated with the Xan V1 token storage.
     function _getXanV1Storage() internal pure returns (XanV1Storage storage xanV1Storage) {
         // solhint-disable no-inline-assembly
         {

src/drafts/XanV2.sol

@@ -28,12 +28,12 @@ contract XanV2 is IXanV2, XanV1 {
         _;
     }
 
+    // solhint-disable comprehensive-interface
     /// @notice Initializes the XanV2 contract.
     /// @param initialMintRecipient The initial recipient of the minted tokens.
     /// @param council The address of the governance council contract.
     /// @param xanV2Forwarder The XanV2 forwarder contract.
     /// @custom:oz-upgrades-validate-as-initializer
-    // solhint-disable-next-line comprehensive-interface
     function initializeV2(address initialMintRecipient, address council, address xanV2Forwarder)
         external
         reinitializer(2)
@@ -50,17 +50,17 @@ contract XanV2 is IXanV2, XanV1 {
 
         // Initialize the XanV2 contract
         _getXanV2Storage().forwarder = xanV2Forwarder;
-    }
+    } // solhint-enable comprehensive-interface
 
+    // solhint-disable comprehensive-interface
     /// @notice Reinitializes the XanV2 contract after an upgrade from XanV1.
     /// @param xanV2Forwarder The XanV2 forwarder contract.
     /// @custom:oz-upgrades-unsafe-allow missing-initializer-call
     /// @custom:oz-upgrades-validate-as-initializer
-    // solhint-disable-next-line comprehensive-interface
     function reinitializeFromV1(address xanV2Forwarder) external reinitializer(2) {
         // Initialize the XanV2 contract
         _getXanV2Storage().forwarder = xanV2Forwarder;
-    }
+    } // solhint-enable comprehensive-interface
 
     /// @inheritdoc IXanV2
     function mint(address account, uint256 value) external override onlyForwarder {
@@ -80,13 +80,13 @@ contract XanV2 is IXanV2, XanV1 {
     }
 
     /// @notice Returns the storage from the Xan V2 storage location.
-    /// @return $ The data associated with Xan token storage.
-    function _getXanV2Storage() internal pure returns (XanV2Storage storage $) {
+    /// @return xanV2Storage The data associated with the Xan V2 token storage.
+    function _getXanV2Storage() internal pure returns (XanV2Storage storage xanV2Storage) {
         // solhint-disable no-inline-assembly
         {
             // slither-disable-next-line assembly
             assembly {
-                $.slot := _XAN_V2_STORAGE_LOCATION
+                xanV2Storage.slot := _XAN_V2_STORAGE_LOCATION
             }
         }
         // solhint-enable no-inline-assembly

src/drafts/XanV2Forwarder.sol

@@ -13,6 +13,10 @@ contract XanV2Forwarder is ForwarderBase {
     error InvalidFunctionSelector(bytes4 expected, bytes4 actual);
     error InvalidMintRecipient(address recipient);
 
+    /// @notice Constructs a forwarder.
+    /// @param xanProxy The of the XAN proxy contract.
+    /// @param protocolAdapter The address of the protocol adapter.
+    /// @param calldataCarrierLogicRef The logic reference of the associated calldata carrier resource.
     constructor(address xanProxy, address protocolAdapter, bytes32 calldataCarrierLogicRef)
         ForwarderBase(protocolAdapter, calldataCarrierLogicRef)
     {

src/interfaces/IXanV1.sol

@@ -96,16 +96,16 @@ interface IXanV1 {
 
     /// @notice Returns the unlocked token balance of an account.
     /// @param from The account to query.
-    /// @param unlockedBalance The unlocked balance.
+    /// @return unlockedBalance The unlocked balance.
     function unlockedBalanceOf(address from) external view returns (uint256 unlockedBalance);
 
     /// @notice Returns the locked token balance of an account.
     /// @param from The account to query.
-    /// @param lockedBalance The locked balance.
+    /// @return lockedBalance The locked balance.
     function lockedBalanceOf(address from) external view returns (uint256 lockedBalance);
 
     /// @notice Returns the locked total supply of the token.
-    /// @param locked The locked supply.
+    /// @return locked The locked supply.
     function lockedSupply() external view returns (uint256 locked);
 
     /// @notice Returns the upgrade scheduled by the voter body or `ScheduledUpgrade(0)`

src/libs/Voting.sol

@@ -31,7 +31,7 @@ library Voting {
     }
 
     /// @notice Assigns the highest rank to a proposed implementation.
-    /// @param data The voting data containing the proposed upgrades.
+    /// @param data The voting data containing the ballots and ranking of proposed implementations.
     /// @param proposedImpl The proposed implementation to assign the highest rank to.
     function assignWorstRank(Data storage data, address proposedImpl) internal {
         Ballot storage ballot = data.ballots[proposedImpl];
@@ -44,7 +44,7 @@ library Voting {
     }
 
     /// @notice Bubble the proposed implementation up in the ranking.
-    /// @param data The voting data containing the ballots for proposed upgrades.
+    /// @param data The voting data containing the ballots and ranking of proposed upgrades.
     /// @param proposedImpl The proposed implementation.
     function bubbleUp(Data storage data, address proposedImpl) internal {
         Ballot storage ballot = data.ballots[proposedImpl];
@@ -71,7 +71,7 @@ library Voting {
     }
 
     /// @notice Bubble the proposed implementation down in the ranking.
-    /// @param data The voting data containing the ballots for proposed upgrades.
+    /// @param data The voting data containing the ballots and ranking of proposed upgrades.
     /// @param proposedImpl The proposed implementation.
     function bubbleDown(Data storage data, address proposedImpl) internal {
         Ballot storage ballot = data.ballots[proposedImpl];
@@ -99,6 +99,7 @@ library Voting {
     }
 
     /// @notice Returns the implementation with the respective rank or `address(0)` if the rank does not exist.
+    /// @param data The storage containing the implementation ranking and count.
     /// @param rank The rank to return the implementation for.
     /// @return impl The proposed implementation with the respective rank or `address(0)` if the rank does not exist.
     function implementationByRank(Data storage data, uint48 rank) internal view returns (address impl) {
@@ -112,13 +113,14 @@ library Voting {
     }
 
     /// @notice Returns the number of implementations.
+    /// @param data The storage containing the number of implementations being ranked.
     /// @return count implementation count.
     function implementationsCount(Data storage data) internal view returns (uint48 count) {
         count = data.implCount;
     }
 
     /// @notice Swaps the rank of two implementations A and B.
-    /// @param data The storage containing the ballots for proposed upgrades.
+    /// @param data The storage containing the implementation ranking.
     /// @param implA Implementation A.
     /// @param rankA The rank of implementation A before the swap.
     /// @param implB Implementation B.