From 43dec863aebd8c14bf90aacf2ad462943f8c44b2 Mon Sep 17 00:00:00 2001
From: Pavel Vojtechovsky <p.vojtechovsky@post.cz>
Date: Sun, 4 Jun 2017 22:03:48 +0200
Subject: [PATCH] javadoc of SubstitutionVisitor

---
 .../support/template/SubstitutionVisitor.java | 19 +++++++++++--------
 1 file changed, 11 insertions(+), 8 deletions(-)

diff --git a/src/main/java/spoon/support/template/SubstitutionVisitor.java b/src/main/java/spoon/support/template/SubstitutionVisitor.java
index fffd0b913e4..ae34653b26d 100644
--- a/src/main/java/spoon/support/template/SubstitutionVisitor.java
+++ b/src/main/java/spoon/support/template/SubstitutionVisitor.java
@@ -71,14 +71,17 @@ class DoNotFurtherTemplateThisElement extends SpoonException {
  * This algorithm replaces:
  * <ul>
  * <li>parameters of {@link CtExecutable}
- * <li>
- * <li>
- * <li>
- * <li>
- * <li>
- * <li>
- * <li>
- * <li>
+ * <li>substring of variable name occurrence in any simpleName of any {@link CtNamedElement}
+ * <li>substring of variable name occurrence in any simpleName of any {@link CtReference}
+ * <li>foreach block whose expression is a parameter
+ * <li>length of array of parameters is replaced by number Literal equal to size of the array
+ * <li>field parameter with value of type TemplateParameter is replaced by clone of this TemplateParameter
+ * <li>field parameter with value of type Class is replaced by class access (e.g.: AnClass.class)
+ * <li>field parameter with value of type Enum is replaced by Enum access (e.g.: AnEnum...)
+ * <li>field parameter with array value is replaced by Array Literal
+ * <li>field parameter with other value is replaced by Literal
+ * <li>invocation of method {@link TemplateParameter#S()}) is replaced by value of type {@link CtCodeElement}
+ * <li>{@link CtTypeReference} with name equal to variable name by the reference to type defined by variable value
  * </ul>
  */
 public class SubstitutionVisitor extends CtScanner {