Fix natspec comment missing * (#5136)

Signed-off-by: Hadrien Croubois <hadrien.croubois@gmail.com>
OpenZeppelin · Oct 2, 2024 · fe7d748 · fe7d748
1 parent 234427a
commit fe7d748
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/contracts/utils/structs/Heap.sol b/contracts/utils/structs/Heap.sol
@@ -218,7 +218,7 @@ library Heap {
         }
     }
 
-    /*
+    /**
      * @dev Swap node `i` and `j` in the tree.
      */
     function _swap(Uint256Heap storage self, uint64 i, uint64 j) private {
@@ -485,7 +485,7 @@ library Heap {
         }
     }
 
-    /*
+    /**
      * @dev Swap node `i` and `j` in the tree.
      */
     function _swap(Uint208Heap storage self, uint24 i, uint24 j) private {

diff --git a/scripts/generate/templates/Heap.js b/scripts/generate/templates/Heap.js
@@ -220,7 +220,7 @@ function clear(${struct} storage self) internal {
     }
 }
 
-/*
+/**
  * @dev Swap node \`i\` and \`j\` in the tree.
  */
 function _swap(${struct} storage self, ${indexType} i, ${indexType} j) private {
-Original file line number
+Diff line change
@@ Expand Up / @@ -218,7 +218,7 @@ library Heap { @@
             }
         }
-        /*
+        /**
          * @dev Swap node `i` and `j` in the tree.
          */
         function _swap(Uint256Heap storage self, uint64 i, uint64 j) private {
@@ Expand Down Expand Up / @@ -485,7 +485,7 @@ library Heap { @@
             }
         }
-        /*
+        /**
          * @dev Swap node `i` and `j` in the tree.
          */
         function _swap(Uint208Heap storage self, uint24 i, uint24 j) private {
@@ Expand Down @@