|
96 | 96 | * </ul>
|
97 | 97 | *
|
98 | 98 | *<p>
|
99 |
| - * {@code addEdge} adds a new edge between two existing nodes. |
100 |
| - * {@code -gov} and {@code -dep} will be nodes matched by the Semgrex pattern. |
| 99 | + * {@code addEdge} adds a new edge between two existing nodes. <br> |
| 100 | + * {@code -gov} and {@code -dep} will be nodes matched by the Semgrex pattern. <br> |
101 | 101 | * {@code -reln} is the name of the dependency type to add.
|
102 | 102 | *</p><p>
|
103 |
| - * {@code relabelNamedEdge} changes the dependency type of a named edge. |
104 |
| - * {@code edge} is the name of the edge in the Semgrex pattern. |
| 103 | + * {@code relabelNamedEdge} changes the dependency type of a named edge. <br> |
| 104 | + * {@code edge} is the name of the edge in the Semgrex pattern. <br> |
105 | 105 | * {@code -reln} is the name of the dependency type to use.
|
106 | 106 | *</p><p>
|
107 |
| - * {@code removeEdge} deletes an edge based on its description. |
108 |
| - * {@code -gov} is the governor to delete, a named node from the Semgrex pattern. |
109 |
| - * {@code -dep} is the dependent to delete, a named node from the Semgrex pattern. |
110 |
| - * {@code -reln} is the name of the dependency to delete. |
| 107 | + * {@code removeEdge} deletes an edge based on its description. <br> |
| 108 | + * {@code -gov} is the governor to delete, a named node from the Semgrex pattern. <br> |
| 109 | + * {@code -dep} is the dependent to delete, a named node from the Semgrex pattern. <br> |
| 110 | + * {@code -reln} is the name of the dependency to delete. <br> |
111 | 111 | * If {@code -gov} or {@code -dep} are left empty, then all (matching) edges to or from the
|
112 | 112 | * remaining argument will be deleted.
|
113 | 113 | *</p><p>
|
114 |
| - * {@code removeNamedEdge} deletes an edge based on its name. |
| 114 | + * {@code removeNamedEdge} deletes an edge based on its name. <br> |
115 | 115 | * {@code edge} is the name of the edge in the Semgrex pattern.
|
116 | 116 | *</p><p>
|
117 |
| - * {@code reattachNamedEdge} changes an edge's gov and/or dep based on its name. |
118 |
| - * {@code edge} is the name of the edge in the Semgrex pattern. |
119 |
| - * {@code -gov} is the governor to attach to, a named node from the Semgrex pattern. If left blank, no edit. |
120 |
| - * {@code -dep} is the dependent to attach to, a named node from the Semgrex pattern. If left blank, no edit. |
| 117 | + * {@code reattachNamedEdge} changes an edge's gov and/or dep based on its name. <br> |
| 118 | + * {@code edge} is the name of the edge in the Semgrex pattern. <br> |
| 119 | + * {@code -gov} is the governor to attach to, a named node from the Semgrex pattern. If left blank, no edit. <br> |
| 120 | + * {@code -dep} is the dependent to attach to, a named node from the Semgrex pattern. If left blank, no edit. <br> |
121 | 121 | * At least one of {@code -gov} or {@code -dep} must be set.
|
122 | 122 | *</p><p>
|
123 |
| - * {@code addDep} adds a word and a dependency arc to the dependency graph. |
124 |
| - * {@code -gov} is the governor to attach to, a named node from the Semgrex pattern. |
125 |
| - * {@code -reln} is the name of the dependency type to use. |
| 123 | + * {@code addDep} adds a word and a dependency arc to the dependency graph. <br> |
| 124 | + * {@code -gov} is the governor to attach to, a named node from the Semgrex pattern. <br> |
| 125 | + * {@code -reln} is the name of the dependency type to use. <br> |
126 | 126 | * {@code -position} is where in the sentence the word should go. {@code -} will be the first word of the sentence,
|
127 | 127 | * {@code +} will be the last word of the sentence, and {@code -node} or {@code +node} will be before or after the
|
128 |
| - * named node. |
| 128 | + * named node. <br> |
129 | 129 | * {@code ...attributes...} means any attributes which can be set from a string or numerical value
|
130 | 130 | * eg {@code -text ...} sets the text of the word
|
131 | 131 | * {@code -pos ...} sets the xpos of the word, {@code -cpos ...} sets the upos of the word, etc.
|
132 |
| - * You cannot set the index of a word this way; an exception will be thrown. |
133 |
| - * To put whitespace in an attribute, you can quote it. |
| 132 | + * You cannot set the index of a word this way; an exception will be thrown. <br> |
| 133 | + * To put whitespace in an attribute, you can quote it. <br> |
134 | 134 | * So, for example, a Vietnamese word can be set as {@code -word "xin chào"}
|
135 | 135 | *</p><p>
|
136 |
| - * {@code editNode} will edit the attributes of a word. |
137 |
| - * {@code -node} is the node to edit. |
138 |
| - * {@code ...attributes...} are the attributes to change, same as with {@code addDep} |
139 |
| - * {@code -morphofeatures ...} will set the features to be exactly as written. |
140 |
| - * {@code -updateMorphoFeatures ...} will edit or add the features without overwriting existing features. |
141 |
| - * {@code -removeMorphoFeatures ...} will remove this one morpho feature. |
| 136 | + * {@code editNode} will edit the attributes of a word. <br> |
| 137 | + * {@code -node} is the node to edit. <br> |
| 138 | + * {@code ...attributes...} are the attributes to change, same as with {@code addDep} <br> |
| 139 | + * {@code -morphofeatures ...} will set the features to be exactly as written. <br> |
| 140 | + * {@code -updateMorphoFeatures ...} will edit or add the features without overwriting existing features. <br> |
| 141 | + * {@code -removeMorphoFeatures ...} will remove this one morpho feature. <br> |
142 | 142 | * {@code -remove ...} will remove the attribute entirely, such as doing {@code -remove lemma} to remove the lemma.
|
143 | 143 | *</p><p>
|
144 |
| - * {@code lemmatize} will put a lemma on a word. |
145 |
| - * {@code -node} is the node to edit. |
| 144 | + * {@code lemmatize} will put a lemma on a word. <br> |
| 145 | + * {@code -node} is the node to edit. <br> |
146 | 146 | * This only works on English text.
|
147 | 147 | *</p><p>
|
148 |
| - * {@code combineMWT} will add MWT attributes to a sequence of two or more words. |
149 |
| - * {@code -node} (repeated) is the nodes to edit. |
| 148 | + * {@code combineMWT} will add MWT attributes to a sequence of two or more words. <br> |
| 149 | + * {@code -node} (repeated) is the nodes to edit. <br> |
150 | 150 | * {@code -word} is the optional text to use for the new MWT. If not set, the words will be concatenated.
|
151 | 151 | *</p><p>
|
152 |
| - * {@code splitWord} will split a single word into multiple pieces from the text of the current word |
153 |
| - * {@code -node} is the node to split. |
154 |
| - * {@code -headIndex} is the index (counting from 0) of the word piece to make the head. |
155 |
| - * {@code -reln} is the name of the dependency type to use. pieces other than the head will connect using this relation |
| 152 | + * {@code splitWord} will split a single word into multiple pieces from the text of the current word <br> |
| 153 | + * {@code -node} is the node to split. <br> |
| 154 | + * {@code -headIndex} is the index (counting from 0) of the word piece to make the head. <br> |
| 155 | + * {@code -reln} is the name of the dependency type to use. pieces other than the head will connect using this relation <br> |
156 | 156 | * {@code -regex} regex must match the matched node. all matching groups will be concatenated to form a new word. need at least 2 to split a word
|
157 | 157 | *</p><p>
|
158 |
| - * {@code setRoots} sets the roots of the sentence to a new root. |
159 |
| - * {@code n1, n2, ...} are the names of the nodes from the Semgrex to use as the root(s). |
| 158 | + * {@code setRoots} sets the roots of the sentence to a new root. <br> |
| 159 | + * {@code n1, n2, ...} are the names of the nodes from the Semgrex to use as the root(s). <br> |
160 | 160 | * This is best done in conjunction with other operations which actually manipulate the structure
|
161 | 161 | * of the graph, or the new root will weirdly have dependents and the graph will be incorrect.
|
162 | 162 | *</p><p>
|
163 |
| - * {@code mergeNodes} will merge n1 and n2, assuming they are mergeable. |
| 163 | + * {@code mergeNodes} will merge n1 and n2, assuming they are mergeable. <br> |
164 | 164 | * The nodes can be merged if one of the nodes is the head of a phrase
|
165 | 165 | * and the other node depends on the head. TODO: can make it process
|
166 | 166 | * more than two nodes at once.
|
167 | 167 | *</p><p>
|
168 |
| - * {@code killAllIncomingEdges} deletes all edges to a node. |
169 |
| - * {@code -node} is the node to edit. |
| 168 | + * {@code killAllIncomingEdges} deletes all edges to a node. <br> |
| 169 | + * {@code -node} is the node to edit. <br> |
170 | 170 | * Note that this is the same as {@code removeEdge} with only the dependent set.
|
171 | 171 | *</p><p>
|
172 |
| - * {@code delete} deletes all nodes reachable from a specific node. |
173 |
| - * {@code -node} is the node to delete. |
| 172 | + * {@code delete} deletes all nodes reachable from a specific node. <br> |
| 173 | + * {@code -node} is the node to delete. <br> |
174 | 174 | * You will only want to do this after separating the node from the parts of the graph you want to keep.
|
175 | 175 | *</p><p>
|
176 |
| - * {@code deleteLeaf} deletes a node as long as it is a leaf. |
177 |
| - * {@code -node} is the node to delete. |
| 176 | + * {@code deleteLeaf} deletes a node as long as it is a leaf. <br> |
| 177 | + * {@code -node} is the node to delete. <br> |
178 | 178 | * If the node is not a leaf (no outgoing edges), it will not be deleted.
|
179 | 179 | *</p><p>
|
180 | 180 | * {@code killNonRootedNodes} searches the graph and deletes all nodes which have no path to a root.
|
|
0 commit comments