Improve comments in ASTTraverse and ASTTraverseModify

Author: Steffen Märcker

prism/src/parser/visitor/ASTTraverse.java

@@ -29,12 +29,16 @@
 import parser.ast.*;
 import prism.PrismLangException;
 
-// Performs a depth-first traversal of an asbtract syntax tree (AST).
-// Many traversal-based tasks can be implemented by extending and either:
-// (a) overriding defaultVisitPre or defaultVisitPost
-// (b) overiding visit for leaf (or other selected) nodes
-// See also ASTTraverseModify.
-
+/**
+ *  Performs a depth-first traversal of an abstract syntax tree (AST).
+ *
+ * Many traversal-based tasks can be implemented by extending and either:
+ * <ul>
+ * <li>overriding defaultVisitPre or defaultVisitPost</li>
+ * <li>overriding visit for leaf (or other selected) nodes</li>
+ * </ul>
+ * @see ASTTraverseModify
+ */
 public class ASTTraverse implements ASTVisitor
 {
 	public void defaultVisitPre(ASTElement e) throws PrismLangException {}

prism/src/parser/visitor/ASTTraverseModify.java

@@ -29,13 +29,18 @@
 import parser.ast.*;
 import prism.PrismLangException;
 
-// Variant of ASTTraverse.
-// Performs a depth-first traversal of an asbtract syntax tree (AST),
-// replacing each child node with the object returned by the recursive visit call.
-// Like ASTTraverse, many traversal-based tasks can be implemented by extending and either:
-// (a) overriding defaultVisitPre or defaultVisitPost
-// (b) overiding visit for leaf (or other selected) nodes
-
+/**
+ *  Variant of ASTTraverse.
+ *
+ * Performs a depth-first traversal of an abstract syntax tree (AST),
+ * replacing each child node with the object returned by the recursive visit call.
+ * Like ASTTraverse, many traversal-based tasks can be implemented by extending and either:
+ * <ul>
+ * <li>overriding defaultVisitPre or defaultVisitPost</li>
+ * <li>overriding visit for leaf (or other selected) nodes</li>
+ * </ul>
+ * @see ASTTraverse
+ */
 public class ASTTraverseModify implements ASTVisitor
 {
 	public void defaultVisitPre(ASTElement e) throws PrismLangException {}