fix: add missing docs

package.json

@@ -19,6 +19,7 @@
     "postinstall": "husky",
     "lint:check": "yarn lint:sol-tests && yarn lint:sol-logic && forge fmt --check",
     "lint:fix": "sort-package-json && forge fmt && yarn lint:sol-tests --fix && yarn lint:sol-logic --fix",
+    "lint:natspec": "npx @defi-wonderland/natspec-smells --config natspec-smells.config.js",
     "lint:sol-logic": "solhint 'solidity/contracts/**/*.sol' 'solidity/interfaces/**/*.sol'",
     "lint:sol-tests": "solhint -c .solhint.tests.json 'solidity/test/**/*.sol'",
     "prepare": "husky",

solidity/contracts/Module.sol

@@ -6,6 +6,10 @@ import {IOracle} from '../interfaces/IOracle.sol';
 
 import {Validator} from './Validator.sol';
 
+/**
+ * @title Module
+ * @notice abstract contract implemented by all Modules
+ */
 abstract contract Module is Validator, IModule {
   constructor(IOracle _oracle) Validator(_oracle) {}
 

solidity/contracts/Oracle.sol

@@ -13,6 +13,10 @@ import {ValidatorLib} from '../libraries/ValidatorLib.sol';
 import {OracleAccessController} from './access/OracleAccessController.sol';
 import {OracleTypehash} from './utils/OracleTypehash.sol';
 
+/**
+ * @title Oracle
+ * @notice Source of truth for applications built on top of Prophet
+ */
 contract Oracle is IOracle, OracleAccessController {
   using ValidatorLib for *;
 

solidity/contracts/access/CommonAccessController.sol

@@ -4,6 +4,10 @@ pragma solidity ^0.8.19;
 import {IAccessController} from '../../interfaces/access/IAccessController.sol';
 import {IAccessModule} from '../../interfaces/modules/access/IAccessModule.sol';
 
+/**
+ * @title CommonAccessController
+ * @notice abstract contract implemented by AccessControllers
+ */
 abstract contract CommonAccessController is IAccessController {
   /**
    * @notice Check whether the caller is authorized for the given parameters.

solidity/contracts/access/ModuleAccessController.sol

@@ -6,6 +6,10 @@ import {IModuleAccessController} from '../../interfaces/access/IModuleAccessCont
 import {Module} from '../Module.sol';
 import {CommonAccessController} from './CommonAccessController.sol';
 
+/**
+ * @title ModuleAccessController
+ * @notice abstract contract to manage access control at the Modules level
+ */
 abstract contract ModuleAccessController is IModuleAccessController, CommonAccessController, Module {
   constructor(IOracle _oracle) Module(_oracle) {}
 
@@ -29,6 +33,13 @@ abstract contract ModuleAccessController is IModuleAccessController, CommonAcces
     _accessControl = _defaultAccessControl(bytes(''));
   }
 
+  /**
+   * @dev Modifier to check if the caller is authorized to operate on behalf of a user
+   * @param _accessModule The address of the access module
+   * @param _typehash The typehash of the called function
+   * @param _params The typehash function parameters
+   * @param _accessControl The access control struct
+   */
   modifier hasAccess(
     address _accessModule,
     bytes32 _typehash,

solidity/contracts/access/OracleAccessController.sol

@@ -4,10 +4,21 @@ pragma solidity ^0.8.19;
 import {IOracleAccessController} from '../../interfaces/access/IOracleAccessController.sol';
 import {CommonAccessController} from './CommonAccessController.sol';
 
+/**
+ * @title OracleAccessController
+ * @notice abstract contract to manage access control at the Oracle level
+ */
 abstract contract OracleAccessController is IOracleAccessController, CommonAccessController {
   /// @inheritdoc IOracleAccessController
   mapping(address _user => mapping(address _accessModule => bool _approved)) public isAccessModuleApproved;
 
+  /**
+   * @dev Modifier to check if the caller is authorized to operate on behalf of a user
+   * @param _accessModule The address of the access module
+   * @param _typehash The typehash of the called function
+   * @param _params The typehash function parameters
+   * @param _accessControl The access control struct
+   */
   modifier hasAccess(
     address _accessModule,
     bytes32 _typehash,

solidity/contracts/utils/OracleTypehash.sol

@@ -1,6 +1,9 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.19;
 
+/**
+ * @title OracleTypehash
+ */
 library OracleTypehash {
   bytes32 public constant CREATE_TYPEHASH =
     keccak256('createRequest(Request _request,bytes32 _ipfsHash,AccessControl _accessControl');

solidity/interfaces/IValidator.sol

@@ -28,6 +28,7 @@ interface IValidator {
 
   /**
    * @notice The oracle contract
+   * @return _oracle The oracle contract
    */
   function ORACLE() external view returns (IOracle _oracle);
 }

solidity/interfaces/modules/access/IAccessModule.sol

@@ -16,8 +16,8 @@ interface IAccessModule is IModule {
   /**
    * @notice Access control parameters
    * @param sender The address of the sender
+   * @param accessControl The access control struct
    * @param typehash The typehash of the access control
-   * @param data The data for access control validation
    * @param typehashParams The parameters for access control validation
    */
   struct AccessControlParameters {

solidity/interfaces/modules/dispute/IDisputeModule.sol

@@ -4,6 +4,10 @@ pragma solidity ^0.8.19;
 import {IModule} from '../../IModule.sol';
 import {IOracle} from '../../IOracle.sol';
 
+/**
+ * @title DisputeModule
+ * @notice Common interface for all dispute modules
+ */
 interface IDisputeModule is IModule {
   /*///////////////////////////////////////////////////////////////
                               EVENTS

solidity/interfaces/modules/finality/IFinalityModule.sol

@@ -3,4 +3,8 @@ pragma solidity ^0.8.19;
 
 import {IModule} from '../../IModule.sol';
 
+/**
+ * @title FinalityModule
+ * @notice Common interface for all finality modules
+ */
 interface IFinalityModule is IModule {}

solidity/interfaces/modules/request/IRequestModule.sol

@@ -3,6 +3,10 @@ pragma solidity ^0.8.19;
 
 import {IModule} from '../../IModule.sol';
 
+/**
+ * @title RequestModule
+ * @notice Common interface for all request modules
+ */
 interface IRequestModule is IModule {
   /**
    * @notice Called by the oracle when a request has been made

solidity/libraries/ValidatorLib.sol

@@ -3,6 +3,9 @@ pragma solidity ^0.8.19;
 
 import {IOracle} from '../interfaces/IOracle.sol';
 
+/**
+ * @title ValidatorLib
+ */
 library ValidatorLib {
   /**
    * @notice Thrown when the response provided does not match the request