Refs #7181, fill in TODO docs.

1 files changed, 13 insertions, 5 deletions

diff --git a/plugins/CoreAdminHome/Tasks/ArchivesToPurgeDistributedList.php b/plugins/CoreAdminHome/Tasks/ArchivesToPurgeDistributedList.php
index ff2acc1edf..a1a28de369 100644
--- a/plugins/CoreAdminHome/Tasks/ArchivesToPurgeDistributedList.php
+++ b/plugins/CoreAdminHome/Tasks/ArchivesToPurgeDistributedList.php
@@ -10,14 +10,24 @@ namespace Piwik\Plugins\CoreAdminHome\Tasks;
 use Piwik\Concurrency\DistributedList;
 
 /**
- * TODO
+ * Distributed list that holds a list of year-month archive table identifiers (eg, 2015_01 or 2014_11). Each item in the
+ * list is expected to identify a pair of archive tables that contain invalidated archives.
+ *
+ * The archiving purging scheduled task will read items in this list when executing the daily purge.
+ *
+ * This class is necessary in order to keep the archive purging scheduled task fast. W/o a way to keep track of
+ * tables w/ invalid data, the task would have to iterate over every table, which is not desired for a task that
+ * is executed daily.
+ *
+ * If users find other tables contain invalidated archives, they can use the core:purge-old-archive-data command
+ * to manually purge them.
  */
 class ArchivesToPurgeDistributedList extends DistributedList
 {
     const OPTION_INVALIDATED_DATES_SITES_TO_PURGE = 'InvalidatedOldReports_DatesWebsiteIds';
 
     /**
-     * TODO
+     * Constructor.
      */
     public function __construct()
     {
@@ -25,9 +35,7 @@ class ArchivesToPurgeDistributedList extends DistributedList
     }
 
     /**
-     * TODO
-     *
-     * @param array $yearMonths
+     * @inheritdoc
      */
     public function setAll($yearMonths)
     {