Add some more doc to the new Ssurgeon CombineMWT operation

Author: AngledLuffa

src/edu/stanford/nlp/semgraph/semgrex/ssurgeon/CombineMWT.java

@@ -11,6 +11,18 @@
 import edu.stanford.nlp.semgraph.semgrex.SemgrexMatcher;
 import edu.stanford.nlp.util.StringUtils;
 
+
+/**
+ * Combines two or more words into one MWT
+ *<br>
+ * For the most part, the nodes themselves are unchanged, but the
+ * nodes now have the CoreAnnotations representing MWTness added
+ *<br>
+ * This is a convenience operation which exists because the basic
+ * version of it using EditNode is a bit of a pain
+ *
+ * @author John Bauer
+ */
 public class CombineMWT extends SsurgeonEdit {
   public static final String LABEL = "combineMWT";
   final List<String> names;

src/edu/stanford/nlp/semgraph/semgrex/ssurgeon/Ssurgeon.java

@@ -132,6 +132,10 @@
  * {@code -node} is the node to edit.
  * {@code ...attributes...} are the attributes to change, same as with {@code addDep}
  *</p><p>
+ * {@code combineMWT} will add MWT attributes to a sequence of two or more words.
+ * {@code -node} (repeated) is the nodes to edit.
+ * {@code -word} is the optional text to use for the new MWT.  If not set, the words will be concatenated.
+ *</p><p>
  * {@code setRoots} sets the roots of the sentence to a new root.
  * {@code n1, n2, ...} are the names of the nodes from the Semgrex to use as the root(s).
  * This is best done in conjunction with other operations which actually manipulate the structure