chore: expand getVersion natspec

0xPolygon · Oct 17, 2023 · 190f5de · 190f5de
1 parent 3ee4da9
commit 190f5de
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 4 deletions.
diff --git a/docs/src/src/DefaultEmissionManager.sol/contract.DefaultEmissionManager.md b/docs/src/src/DefaultEmissionManager.sol/contract.DefaultEmissionManager.md
@@ -130,6 +130,8 @@ function inflatedSupplyAfter(uint256 timeElapsed) public pure returns (uint256 s
 
 ### getVersion
 
+returns the version of the contract
+
 
 ```solidity
 function getVersion() external pure returns (string memory);
@@ -138,6 +140,6 @@ function getVersion() external pure returns (string memory);
 
 |Name|Type|Description|
 |----|----|-----------|
-|`<none>`|`string`|version the implementation version|
+|`<none>`|`string`|version version string|
 
 
diff --git a/docs/src/src/PolygonMigration.sol/contract.PolygonMigration.md b/docs/src/src/PolygonMigration.sol/contract.PolygonMigration.md
@@ -172,6 +172,8 @@ function updateUnmigrationLock(bool unmigrationLocked_) external onlyOwner;
 
 ### getVersion
 
+returns the version of the contract
+
 
 ```solidity
 function getVersion() external pure returns (string memory);
@@ -180,7 +182,7 @@ function getVersion() external pure returns (string memory);
 
 |Name|Type|Description|
 |----|----|-----------|
-|`<none>`|`string`|version the implementation version|
+|`<none>`|`string`|version version string|
 
 
 ### burn

diff --git a/...src/interfaces/IDefaultEmissionManager.sol/interface.IDefaultEmissionManager.md b/...src/interfaces/IDefaultEmissionManager.sol/interface.IDefaultEmissionManager.md
@@ -101,6 +101,8 @@ function inflatedSupplyAfter(uint256 timeElapsedInSeconds) external pure returns
 
 ### getVersion
 
+returns the version of the contract
+
 
 ```solidity
 function getVersion() external pure returns (string memory version);
@@ -109,7 +111,7 @@ function getVersion() external pure returns (string memory version);
 
 |Name|Type|Description|
 |----|----|-----------|
-|`version`|`string`|the implementation version|
+|`version`|`string`|version string|
 
 
 ## Events

diff --git a/docs/src/src/interfaces/IPolygonMigration.sol/interface.IPolygonMigration.md b/docs/src/src/interfaces/IPolygonMigration.sol/interface.IPolygonMigration.md
@@ -166,6 +166,8 @@ function unmigrationLocked() external view returns (bool isUnmigrationLocked);
 
 ### getVersion
 
+returns the version of the contract
+
 
 ```solidity
 function getVersion() external pure returns (string memory version);
@@ -174,7 +176,7 @@ function getVersion() external pure returns (string memory version);
 
 |Name|Type|Description|
 |----|----|-----------|
-|`version`|`string`|the implementation version|
+|`version`|`string`|version string|
 
 
 ## Events