From 4d2df41cdbc77e5cdd0a5de1091257277175103e Mon Sep 17 00:00:00 2001
From: Sam Harwell <sam@tunnelvisionlabs.com>
Date: Sun, 28 Oct 2012 16:42:23 -0500
Subject: [PATCH] Format and document the 'state' template to improve
 readability

---
 .../antlr/v4/tool/templates/dot/graphs.stg    | 25 ++++++++++++++++---
 1 file changed, 22 insertions(+), 3 deletions(-)

diff --git a/tool/resources/org/antlr/v4/tool/templates/dot/graphs.stg b/tool/resources/org/antlr/v4/tool/templates/dot/graphs.stg
index 0c237669f..09cc877e2 100644
--- a/tool/resources/org/antlr/v4/tool/templates/dot/graphs.stg
+++ b/tool/resources/org/antlr/v4/tool/templates/dot/graphs.stg
@@ -32,9 +32,28 @@ epsilon-edge(src,label,target,arrowhead,transitionIndex,loopback=false) ::= <<
 <src><if(transitionIndex)>:p<transitionIndex><endif> -> <target> [fontname="Times-Italic", label="&epsilon;"<if(loopback)>, style="dashed"<endif>];
 >>
 
-state(state, label, name, transitions) ::= <<
-<name>[fontsize=11, label="<if(rest(transitions))>{<endif><label><if(rest(transitions))>|{<transitions:{t|\<p<i0>\>}; separator="|">}}<endif>", <if(rest(transitions))>shape=record, fixedsize=false<else>shape=circle, fixedsize=true, width=.55<endif>, peripheries=1];
->>
+state(state, label, name, transitions) ::= <%
+<name>[fontsize=11,
+    label="
+        <! rest(transition) tests for decision states: these nodes have a non-empty set of transitions after the first one. !>
+        <if(rest(transitions))>
+            {
+            <! Label on the left side of the record node. !>
+            <label>
+            |
+            <! Named ports in order on right side of record node, no display text. !>
+            {<transitions:{t|\<p<i0>>}; separator="|">}}
+        <else>
+            <label>
+        <endif>
+        "
+    <if(rest(transitions))>
+        , shape=record, fixedsize=false
+    <else>
+        , shape=circle, fixedsize=true, width=.55
+    <endif>
+    , peripheries=1];
+%>
 
 stopstate(name,label,actionIndex,useBox) ::= <<
 <name>[fontsize=11, label="<label><if(actionIndex)>,\naction:<actionIndex><endif>", <if(useBox)>shape=polygon,sides=4,peripheries=2,fixedsize=false<else>shape=doublecircle, fixedsize=true, width=.6<endif>];