doc: add natspec to getFeeSide

thesandboxgame · Oct 3, 2023 · 8bc3d5e · 8bc3d5e · github-actions · Oct 3, 2023
1 parent 32453a7
commit 8bc3d5e
Showing 1 changed file with 10 additions and 6 deletions.
diff --git a/packages/marketplace/contracts/lib-asset/LibAsset.sol b/packages/marketplace/contracts/lib-asset/LibAsset.sol
@@ -35,6 +35,10 @@ library LibAsset {
     bytes32 internal constant ASSET_TYPEHASH =
         keccak256("Asset(AssetType assetType,uint256 value)AssetType(uint256 assetClass,bytes data)");
 
+    /// @notice decides if the fees will be taken and from which side
+    /// @param leftClass left side asset class type
+    /// @param rightClass right side asset class type
+    /// @return side from which the fees will be taken or none
     function getFeeSide(AssetClassType leftClass, AssetClassType rightClass) internal pure returns (FeeSide) {
         if (leftClass == AssetClassType.ERC20_ASSET_CLASS && rightClass != AssetClassType.ERC20_ASSET_CLASS) {
             return FeeSide.LEFT;
@@ -45,16 +49,16 @@ library LibAsset {
         return FeeSide.NONE;
     }
 
-    ///    @notice calculate hash of asset type
-    ///    @param assetType to be hashed
-    ///    @return hash of assetType
+    /// @notice calculate hash of asset type
+    /// @param assetType to be hashed
+    /// @return hash of assetType
     function hash(AssetType memory assetType) internal pure returns (bytes32) {
         return keccak256(abi.encode(ASSET_TYPE_TYPEHASH, assetType.assetClass, keccak256(assetType.data)));
     }
 
-    ///    @notice calculate hash of asset
-    ///    @param asset to be hashed
-    ///    @return hash of asset
+    /// @notice calculate hash of asset
+    /// @param asset to be hashed
+    /// @return hash of asset
     function hash(Asset memory asset) internal pure returns (bytes32) {
         return keccak256(abi.encode(ASSET_TYPEHASH, hash(asset.assetType), asset.value));
     }