svn commit: r601137 - /commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/io/SCXMLParser.java

[ra...@apache.org]

Author: rahul
Date: Tue Dec  4 15:02:53 2007
New Revision: 601137

URL: http://svn.apache.org/viewvc?rev=601137&view=rev
Log:
Notes on switching to the new parser.

Modified:
    commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/io/SCXMLParser.java

Modified: commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/io/SCXMLParser.java
URL: http://svn.apache.org/viewvc/commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/io/SCXMLParser.java?rev=601137&r1=601136&r2=601137&view=diff
==============================================================================
--- commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/io/SCXMLParser.java (original)
+++ commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/io/SCXMLParser.java Tue Dec  4 15:02:53 2007
@@ -86,6 +86,18 @@
  *  <li>Obtain a SCXML Parser for further customization of the default
  *      ruleset.</li>
  * </ol>
+ *
+ * <p>If switching from {@link SCXMLDigester}, changes need to be made to
+ * the SCXML documents, such as:</p>
+ * <ul>
+ *  <li>A &lt;parallel&gt; should not be wrapped in a &lt;state&gt; element
+ *      unless otherwise necessary</li>
+ *  <li>&lt;var&gt; and &lt;exit&gt; elements continue to be supported by
+ *      Commons SCXML, but in the Commons SCXML namespace:
+ *      <code>http://commons.apache.org/scxml</code></li>
+ *  <li>&lt;event&gt; is now supported</li>
+ * </ul>
+ * <p>See latest version of the SCXML Working Draft for more details.</p>
  */
 public final class SCXMLParser {