From 4a04eb6fa2852df7783c46db67dacfb6135a8945 Mon Sep 17 00:00:00 2001
From: Tritium-VLK <11885129+Tritium-VLK@users.noreply.github.com>
Date: Sat, 5 Oct 2024 03:16:40 +0200
Subject: [PATCH] add missing setter docs.

---
 contracts/ChildChainGaugeInjectorV2.sol | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/contracts/ChildChainGaugeInjectorV2.sol b/contracts/ChildChainGaugeInjectorV2.sol
index 21b5f2d..7c04aea 100644
--- a/contracts/ChildChainGaugeInjectorV2.sol
+++ b/contracts/ChildChainGaugeInjectorV2.sol
@@ -558,7 +558,7 @@ KeeperCompatibleInterface
     }
 
 /**
- * @notice Sets global MaxInjectionAmount for the injector
+ * @notice Sets global MaxInjectionAmount for the injector which will be checked on each injection.
  * @param amount The max amount that the injector will allow to be paid to a single gauge in single programmed injection
  */
     function setMaxInjectionAmount(uint256 amount) external onlyOwner {
@@ -566,11 +566,19 @@ KeeperCompatibleInterface
         MaxInjectionAmount = amount;
     }
 
+/**
+ * @notice Sets global MaxGlobalAmountPerPeriod for the injector, which will prevent schedules from being added that increases the spend of a single round of all active periods from exceeding this amount.
+ * @param amount The max amount that should be allowed to be scheduled in 1 period across all active programs.
+ */
     function setMaxGlobalAmountPerPeriod(uint256 amount) external onlyOwner {
         emit MaxGlobalAmountPerPeriodUpdated(MaxGlobalAmountPerPeriod, amount);
         MaxGlobalAmountPerPeriod = amount;
     }
 
+/**
+ * @notice Sets global MaxTotalDue for the injector, which will prevent schedules from being added that increases the the total spend of all active programs over all remaining periods from exceeding this amount.
+ * @param amount The max amount that should be allowed to be scheduled across all remaining periods of all active programs.
+ */
     function setMaxTotalDue(uint256 amount) external onlyOwner {
         emit MaxTotalDueUpdated(MaxTotalDue, amount);
         MaxTotalDue = amount;