From d8e9afac83873b733c1e45941642813f19b03a22 Mon Sep 17 00:00:00 2001
From: "chris.ditcher" <Chris.Ditcher@QP.GOV.BC.CA>
Date: Mon, 17 Jul 2023 13:23:11 -0700
Subject: [PATCH] Added comment

---
 .../educ/api/distribution/config/ScheduledTasksConfig.java    | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/api/src/main/java/ca/bc/gov/educ/api/distribution/config/ScheduledTasksConfig.java b/api/src/main/java/ca/bc/gov/educ/api/distribution/config/ScheduledTasksConfig.java
index fd040909..7777d0af 100644
--- a/api/src/main/java/ca/bc/gov/educ/api/distribution/config/ScheduledTasksConfig.java
+++ b/api/src/main/java/ca/bc/gov/educ/api/distribution/config/ScheduledTasksConfig.java
@@ -28,6 +28,9 @@ public ScheduledTasksConfig(@Qualifier("TmpCacheFileVisitor") FileVisitor<Path>
         this.educDistributionApiConstants = educDistributionApiConstants;
     }
 
+    /**
+     * Removes artifacts from the /tmp/Batch directory that are expired
+     */
     @Scheduled(cron = "${scheduler.clean-tmp-cache-cron}")
     public void cleanTmpCacheFiles() {
         Path startingDir = Paths.get(educDistributionApiConstants.getCleanTmpCacheBaseDir());
@@ -38,7 +41,6 @@ public void cleanTmpCacheFiles() {
                 logger.error("ScheduledTasksConfig: There was an error removing file cache: {}", e.getLocalizedMessage());
             }
         }
-
     }