From bc289b2dc898ad2d107d4e3fb723943ee13e0ce8 Mon Sep 17 00:00:00 2001
From: Sahil-Gujrati <sahilgujrati12@gmail.com>
Date: Sun, 19 May 2024 10:44:25 +0530
Subject: [PATCH] chore: Update NatSpec

---
 src/core/lib/LiquiditySupplyAndSwapMath.sol | 5 +++++
 src/governance/Thud.sol                     | 2 +-
 src/governance/ThunderGovernor.sol          | 5 +++++
 src/governance/ThunderTimelock.sol          | 5 +++++
 4 files changed, 16 insertions(+), 1 deletion(-)

diff --git a/src/core/lib/LiquiditySupplyAndSwapMath.sol b/src/core/lib/LiquiditySupplyAndSwapMath.sol
index 8361fd3..27f7a8b 100644
--- a/src/core/lib/LiquiditySupplyAndSwapMath.sol
+++ b/src/core/lib/LiquiditySupplyAndSwapMath.sol
@@ -1,6 +1,11 @@
 // SPDX-License-Identifier: MIT
 pragma solidity 0.8.20;
 
+/**
+ * @title LiquiditySupplyAndSwapMath
+ * @author mgnfy-view
+ * @notice A library to aid in calcultion for supplying liquidity and swapping tokens
+ */
 library LiquiditySupplyAndSwapMath {
     function getPoolToken2LiquidityToAddBasedOnPoolToken1Amount(
         uint256 _poolToken1Amount,
diff --git a/src/governance/Thud.sol b/src/governance/Thud.sol
index caf26d0..963cd44 100644
--- a/src/governance/Thud.sol
+++ b/src/governance/Thud.sol
@@ -7,7 +7,7 @@ import { ERC20Permit, Nonces } from "@openzeppelin/contracts/token/ERC20/extensi
 import { ERC20Votes } from "@openzeppelin/contracts/token/ERC20/extensions/ERC20Votes.sol";
 
 /**
- * @title THUD TOken
+ * @title THUD Token
  * @author Sahil Gujrati aka mgnfy.view
  * @notice This is the key utility and governance token of the Thunder Swap protocol
  */
diff --git a/src/governance/ThunderGovernor.sol b/src/governance/ThunderGovernor.sol
index a373009..817f212 100644
--- a/src/governance/ThunderGovernor.sol
+++ b/src/governance/ThunderGovernor.sol
@@ -19,6 +19,11 @@ import {
 import { GovernorVotesQuorumFraction } from
     "@openzeppelin/contracts/governance/extensions/GovernorVotesQuorumFraction.sol";
 
+/**
+ * @title ThunderGovernor
+ * @author mgnfy-view
+ * @notice Governor contract for creating governance proposals
+ */
 contract ThunderGovernor is
     Governor,
     GovernorSettings,
diff --git a/src/governance/ThunderTimelock.sol b/src/governance/ThunderTimelock.sol
index abaecc5..ad38a40 100644
--- a/src/governance/ThunderTimelock.sol
+++ b/src/governance/ThunderTimelock.sol
@@ -3,6 +3,11 @@ pragma solidity ^0.8.0;
 
 import { TimelockController } from "@openzeppelin/contracts/governance/TimelockController.sol";
 
+/**
+ * @title ThunderGovernor
+ * @author mgnfy-view
+ * @notice The timelock allows execution of passed governance proposals after a certain delay.
+ */
 contract ThunderTimeLock is TimelockController {
     // minDelay is how long you have to wait before executing
     // proposers is the list of addresses that can propose