From 4640cd7131b044c20b0f3158004145011249bee6 Mon Sep 17 00:00:00 2001
From: wangzhaohui <chaos-warzh@smail.nju.edu.cn>
Date: Wed, 29 May 2024 23:59:14 +0800
Subject: [PATCH] Document

---
 .../analysis/pta/plugin/taint/TaintAnalysis.java   | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/src/main/java/pascal/taie/analysis/pta/plugin/taint/TaintAnalysis.java b/src/main/java/pascal/taie/analysis/pta/plugin/taint/TaintAnalysis.java
index b35df5f4a..e216d9ea1 100644
--- a/src/main/java/pascal/taie/analysis/pta/plugin/taint/TaintAnalysis.java
+++ b/src/main/java/pascal/taie/analysis/pta/plugin/taint/TaintAnalysis.java
@@ -42,6 +42,20 @@
 import java.io.File;
 import java.util.Set;
 
+/**
+ * Maintains the process of taint analysis and supports interactive mode.
+ * <br>
+ *
+ * The interactive mode goes as follows:
+ * <ol>
+ *     <li>Captures user's rerun request in {@link #onPhaseFinish()} when pointer analysis finishes
+ *     <li>Call {@link #initialize()} to re-initialize the analysis
+ *     <li>Reset sub-plugins based on the newly loaded taint config
+ *     <li>Clear previous taint objects and taint edges
+ *     <li>Trigger the creation of taint objects based on the new taint config
+ *     <li>P/Taint analysis will continue when exit {@link #initialize()}
+ * </ol>
+ */
 public class TaintAnalysis extends CompositePlugin {
 
     private static final Logger logger = LogManager.getLogger(TaintAnalysis.class);