Author: mes
Date: 2012-01-24 11:45:11 -0800 (Tue, 24 Jan 2012)
New Revision: 28090
Modified:
core3/api/trunk/model-api/src/main/java/org/cytoscape/model/CyNetwork.java
core3/api/trunk/model-api/src/main/java/org/cytoscape/model/CyTable.java
Log:
javadoc updates
Modified:
core3/api/trunk/model-api/src/main/java/org/cytoscape/model/CyNetwork.java
===================================================================
--- core3/api/trunk/model-api/src/main/java/org/cytoscape/model/CyNetwork.java
2012-01-24 19:12:08 UTC (rev 28089)
+++ core3/api/trunk/model-api/src/main/java/org/cytoscape/model/CyNetwork.java
2012-01-24 19:45:11 UTC (rev 28090)
@@ -74,7 +74,12 @@
/**
* Remove a node from the network and delete the node (if it only
exists in
* this network). See {@link
org.cytoscape.model.subnetwork.CyRootNetwork}
- * for information about having the same node in two networks.
+ * for information about having the same node in two networks.
+ * <br/>
+ * To delete a single node it is convenient to do it this way:
+ * <code>
+ * network.removeNodes(Collections.singletonList(node));
+ * </code>
*
* @param node the node to be deleted
* @return true if the node was successfully deleted
@@ -95,6 +100,11 @@
* Remove an edge from the network and delete the edge (if it only
exists in
* this network). See {@link
org.cytoscape.model.subnetwork.CyRootNetwork}
* for information about having the same edge in two networks.
+ * <br/>
+ * To delete a single edge it is convenient to do it this way:
+ * <code>
+ * network.removeEdges(Collections.singletonList(edge));
+ * </code>
*
* @param edges the edges to be deleted
* @return true if the edge was successfully deleted
Modified:
core3/api/trunk/model-api/src/main/java/org/cytoscape/model/CyTable.java
===================================================================
--- core3/api/trunk/model-api/src/main/java/org/cytoscape/model/CyTable.java
2012-01-24 19:12:08 UTC (rev 28089)
+++ core3/api/trunk/model-api/src/main/java/org/cytoscape/model/CyTable.java
2012-01-24 19:45:11 UTC (rev 28090)
@@ -132,7 +132,7 @@
/**
* Will delete the column of the specified name. columnName must be not
null. If the column does not exist,
* there is no effect. If the column is immutable,
IllegalArgumentException will be thrown. If the deletion is
- * successful, {@link ColumnDeletedEvent} will be fired.
+ * successful, {@link org.cytoscape.model.events.ColumnDeletedEvent}
will be fired.
* @param columnName The name identifying the attribute.
*/
void deleteColumn(String columnName);
--
You received this message because you are subscribed to the Google Groups
"cytoscape-cvs" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/cytoscape-cvs?hl=en.
