Author: ruschein
Date: 2010-10-25 14:59:51 -0700 (Mon, 25 Oct 2010)
New Revision: 22394
Modified:
core3/session-api/trunk/src/main/java/org/cytoscape/session/CyNetworkNaming.java
Log:
Added missing JavaDoc.
Modified:
core3/session-api/trunk/src/main/java/org/cytoscape/session/CyNetworkNaming.java
===================================================================
---
core3/session-api/trunk/src/main/java/org/cytoscape/session/CyNetworkNaming.java
2010-10-25 21:58:04 UTC (rev 22393)
+++
core3/session-api/trunk/src/main/java/org/cytoscape/session/CyNetworkNaming.java
2010-10-25 21:59:51 UTC (rev 22394)
@@ -1,24 +1,25 @@
package org.cytoscape.session;
+
import org.cytoscape.model.CyNetwork;
+
public interface CyNetworkNaming {
-
/**
- * DOCUMENT ME!
+ * Generates a unique title for a subnetwork based on a parent network
*
- * @param parentNetwork DOCUMENT ME!
+ * @param parentNetwork a non-null reference to a parent network
*
- * @return DOCUMENT ME!
+ * @return a unique title somehow based on the title of the parent
network
*/
String getSuggestedSubnetworkTitle(CyNetwork parentNetwork);
/**
- * DOCUMENT ME!
+ * Generates a unique network title based on a provided suggestion.
*
- * @param desiredTitle DOCUMENT ME!
+ * @param desiredTitle the "ideal" title that we would like
*
- * @return DOCUMENT ME!
+ * @return "desiredTitle" if this title is not yet in use, o/w a title
that is unique and uses "desiredTitle" as a prefix
*/
String getSuggestedNetworkTitle(String desiredTitle);
}
--
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.
