From fa2e093d5209d28fccb6f8690c8adc6efa5a5066 Mon Sep 17 00:00:00 2001
From: Roman Ivanov <ivanov-jr@mail.ru>
Date: Mon, 27 Jun 2016 21:19:09 -0700
Subject: [PATCH] Issue #3209: add example to TokenTypes for FOR_EACH_CLAUSE

---
 .../tools/checkstyle/api/TokenTypes.java      | 31 +++++++++++++++++++
 1 file changed, 31 insertions(+)

diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/api/TokenTypes.java b/src/main/java/com/puppycrawl/tools/checkstyle/api/TokenTypes.java
index 91380cbec..05ac22bb2 100644
--- a/src/main/java/com/puppycrawl/tools/checkstyle/api/TokenTypes.java
+++ b/src/main/java/com/puppycrawl/tools/checkstyle/api/TokenTypes.java
@@ -2858,6 +2858,37 @@ public final class TokenTypes {
      * <code>LITERAL_FOR</code>.  The children of this element may be
      * a parameter definition, the colon literal and an expression.
      *
+     * <p>For example:</p>
+     * <pre>
+     * for (int value : values) {
+     *     doSmth();
+     * }
+     * </pre>
+     * <p>parses as:</p>
+     * <pre>
+     * --LITERAL_FOR (for)
+     *    |--LPAREN (()
+     *    |--FOR_EACH_CLAUSE
+     *    |   |--VARIABLE_DEF
+     *    |   |   |--MODIFIERS
+     *    |   |   |--TYPE
+     *    |   |   |   `--LITERAL_INT (int)
+     *    |   |   `--IDENT (value)
+     *    |   |--COLON (:)
+     *    |   `--EXPR
+     *    |       `--IDENT (values
+     *    |--RPAREN ())
+     *    `--SLIST ({)
+     *        |--EXPR
+     *        |   `--METHOD_CALL (()
+     *        |       |--IDENT (doSmth)
+     *        |       |--ELIST
+     *        |       `--RPAREN ())
+     *        |--SEMI (;)
+     *        `--RCURLY (})
+     *
+     * </pre>
+     *
      * @see #VARIABLE_DEF
      * @see #ELIST
      * @see #LITERAL_FOR