From 82f0a25c969170f710825ce6aa6920062adbde88 Mon Sep 17 00:00:00 2001
From: Mikhail Melnik <by.zumzoom@gmail.com>
Date: Tue, 26 Nov 2024 13:25:25 +0400
Subject: [PATCH] fix natspec

---
 contracts/SimpleSettlement.sol | 13 +++++++++----
 1 file changed, 9 insertions(+), 4 deletions(-)

diff --git a/contracts/SimpleSettlement.sol b/contracts/SimpleSettlement.sol
index faf1de9..7a78aaa 100644
--- a/contracts/SimpleSettlement.sol
+++ b/contracts/SimpleSettlement.sol
@@ -142,12 +142,17 @@ contract SimpleSettlement is FeeTaker {
     }
 
     /**
-     * @notice See {IPostInteraction-postInteraction}.
-     * @dev Takes the fee in taking tokens and transfers the rest to the maker.
-     * `whitelistData` consists of:
+     * @dev Validates whether the taker is whitelisted.
+     * @param whitelistData Whitelist data is a tightly packed struct of the following format:
+     * ```
      * 4 bytes - allowed time
-     * 1 byte - whitelist size
+     * 1 byte - size of the whitelist
      * (bytes12)[N] — taker whitelist
+     * ```
+     * Only 10 lowest bytes of the address are used for comparison.
+     * @param taker The taker address to check.
+     * @return isWhitelisted Whether the taker is whitelisted.
+     * @return tail Remaining calldata.
      */
     function _isWhitelistedPostInteractionImpl(bytes calldata whitelistData, address taker) internal view override returns (bool isWhitelisted, bytes calldata tail) {
         unchecked {