test: add comments in test contracts (#66)

solidity/contracts/ContractTest.sol

@@ -3,6 +3,10 @@ pragma solidity ^0.8.0;
 
 import {IContractTest, MyContract} from '../interfaces/IContractTest.sol';
 
+/**
+ * @notice This contract is for general testing
+ * @dev It contains the most common variables types and functions
+ */
 contract ContractTest is IContractTest {
   uint256 public immutable immutableUintVariable = 10;
 

solidity/contracts/Lib.sol

@@ -1,6 +1,9 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.0;
 
+/**
+ * @notice This contract library is for testing that libraries mocks are not generated
+ */
 library Lib {
   function add(uint256 a, uint256 b) public pure returns (uint256) {
     return a + b;

solidity/contracts/utils/ContractA.sol

@@ -4,6 +4,9 @@ import {IContractA} from '../../interfaces/IContractA.sol';
 import {IContractZ} from '../../interfaces/IContractZ.sol';
 import {ContractB} from './ContractB.sol';
 
+/**
+ * @notice This contract is for testing contracts with interfaces and inheritance
+ */
 contract ContractA is IContractA, ContractB {
   uint256 public uintVariable;
 

solidity/contracts/utils/ContractAbstract.sol

@@ -1,5 +1,8 @@
 pragma solidity ^0.8.0;
 
+/**
+ * @notice This contract is for testing abstract contracts with implemented and unimplemented functions
+ */
 abstract contract ContractAbstract {
   uint256 public uintVariable;
 

solidity/contracts/utils/ContractB.sol

@@ -2,6 +2,9 @@ pragma solidity ^0.8.0;
 
 import {IContractB} from '../../interfaces/IContractB.sol';
 
+/**
+ * @notice This contract is for testing string variables and function with return values
+ */
 contract ContractB is IContractB {
   string public stringVariable;
 

solidity/contracts/utils/ContractBAbstract.sol

@@ -3,6 +3,9 @@ pragma solidity ^0.8.0;
 import {IContractBAbstract} from '../../interfaces/IContractBAbstract.sol';
 import {IContractB2Abstract} from '../../interfaces/IContractB2Abstract.sol';
 
+/**
+ * @notice This contract is for testing abstract contracts with multiple inherited unimplemented functions
+ */
 abstract contract ContractBAbstract is IContractBAbstract, IContractB2Abstract {
   uint256 public uintVariable;
 

solidity/contracts/utils/ContractC.sol

@@ -2,6 +2,9 @@ pragma solidity ^0.8.0;
 
 import {IContractCA} from '../../interfaces/IContractCA.sol';
 
+/**
+ * @notice This contract is for testing uint256 variables and function with return values
+ */
 contract ContractCA is IContractCA {
   uint256 public uint256Variable;
 

solidity/contracts/utils/ContractD.sol

@@ -1,5 +1,8 @@
 pragma solidity ^0.8.0;
 
+/**
+ * @notice This contract is for testing functions with multiple return values
+ */
 contract ContractD {
   uint256 internal _internalUintVar;
 

solidity/contracts/utils/ContractE.sol

@@ -2,6 +2,9 @@ pragma solidity ^0.8.0;
 
 import {ContractD} from './ContractD.sol';
 
+/**
+ * @notice This contract is for testing a contract with internal variables and inheritance from another contract
+ */
 contract ContractE is ContractD {
   uint256 internal _internalUintVar2;
 

solidity/contracts/utils/ContractF.sol

@@ -1,5 +1,8 @@
 pragma solidity ^0.8.0;
 
+/**
+ * @notice Simple Ownable contract
+ */
 contract Ownable {
   address public owner;
 
@@ -8,19 +11,33 @@ contract Ownable {
   }
 }
 
+/**
+ * @notice Simple abstract contract inheriting from a contract
+ */
 abstract contract ContractFAbstract2 is Ownable {
   function setVariablesB(uint256 _newValue) public virtual returns (bool _result);
 }
 
+/**
+ * @notice Interface for ContractFAbstract
+ */
 interface IContractFAbstract {
   function QUORUM() external view returns (uint256 _quorum);
   function setVariablesA(uint256 _newValue) external returns (bool _result);
 }
 
+/**
+ * @notice Contract for testing abstract contracts with a variable and a unimplemented function
+ * while inheriting from another abstract contract and its interface
+ */
 abstract contract ContractFAbstract is IContractFAbstract, ContractFAbstract2 {
   uint256 public constant QUORUM = 70;
 
   function setVariablesA(uint256 _newValue) public virtual returns (bool _result);
 }
 
+/**
+ * @notice Contract for testing abstract contracts with multiple inheritance of same functions
+ * Also testing multiple levels of abstract inheritance
+ */
 abstract contract ContractF is IContractFAbstract, ContractFAbstract {}

solidity/contracts/utils/ContractG.sol

@@ -1,5 +1,12 @@
 pragma solidity ^0.8.0;
 
+/**
+ * @notice This contract is for testing complex data structures with mappings using them
+ *  - Structs with nestep mapings
+ *  - Nested structs
+ *  - Nested structs arrays
+ *  - Structs with multiple structs
+ */
 contract ContractG {
   struct Set {
     bytes32[] _values;

solidity/contracts/utils/ContractH.sol

@@ -1,5 +1,8 @@
 pragma solidity ^0.8.0;
 
+/**
+ * @notice This contract is for testing receive and fallback functions
+ */
 contract ContractH {
   address public owner;
 

solidity/contracts/utils/ContractI.sol

@@ -1,5 +1,8 @@
 pragma solidity ^0.8.0;
 
+/**
+ * @notice Simple Ownable contract
+ */
 contract Ownable {
   address public owner;
 
@@ -8,6 +11,9 @@ contract Ownable {
   }
 }
 
+/**
+ * @notice Simple Pausable contract
+ */
 contract Pausable {
   bool public paused;
 
@@ -16,8 +22,14 @@ contract Pausable {
   }
 }
 
+/**
+ * @notice Testing abstract contract with multiple inherited contracts
+ */
 abstract contract ContractI is Ownable, Pausable {}
 
+/**
+ * @notice Testing abstract contract with constructor and with multiple inherited contracts
+ */
 abstract contract ContractI2 is Ownable, Pausable {
   bool public boolean;
 

solidity/interfaces/IContractTest.sol

@@ -3,6 +3,10 @@ pragma solidity ^0.8.0;
 
 contract MyContract {}
 
+/**
+ * @notice This interface is for general testing
+ * @dev It contains the most common variables types and functions
+ */
 interface IContractTest {
   // Structs
   struct MyStruct {