Author: mkirby
Date: 2011-11-07 16:41:15 -0800 (Mon, 07 Nov 2011)
New Revision: 27424
Modified:
core3/api/trunk/dnd-api/src/main/java/org/cytoscape/dnd/DropNetworkViewTaskFactory.java
core3/api/trunk/dnd-api/src/main/java/org/cytoscape/dnd/DropNodeViewTaskFactory.java
core3/api/trunk/dnd-api/src/main/java/org/cytoscape/dnd/DropUtil.java
core3/api/trunk/dnd-api/src/main/java/org/cytoscape/dnd/GraphicalEntity.java
Log:
Fixed Javadoc.
Modified:
core3/api/trunk/dnd-api/src/main/java/org/cytoscape/dnd/DropNetworkViewTaskFactory.java
===================================================================
---
core3/api/trunk/dnd-api/src/main/java/org/cytoscape/dnd/DropNetworkViewTaskFactory.java
2011-11-07 21:33:21 UTC (rev 27423)
+++
core3/api/trunk/dnd-api/src/main/java/org/cytoscape/dnd/DropNetworkViewTaskFactory.java
2011-11-08 00:41:15 UTC (rev 27424)
@@ -11,6 +11,7 @@
/**
* An extension of TaskFactory that provides support for
* tasks to deal with drag and drop.
+ * @CyAPI.Spi.Interface
*/
public interface DropNetworkViewTaskFactory extends NetworkViewTaskFactory {
Modified:
core3/api/trunk/dnd-api/src/main/java/org/cytoscape/dnd/DropNodeViewTaskFactory.java
===================================================================
---
core3/api/trunk/dnd-api/src/main/java/org/cytoscape/dnd/DropNodeViewTaskFactory.java
2011-11-07 21:33:21 UTC (rev 27423)
+++
core3/api/trunk/dnd-api/src/main/java/org/cytoscape/dnd/DropNodeViewTaskFactory.java
2011-11-08 00:41:15 UTC (rev 27424)
@@ -10,6 +10,7 @@
/**
* An extension of TaskFactory that provides support for
* tasks to deal with drag and drop.
+ * @CyAPI.Spi.Interface
*/
public interface DropNodeViewTaskFactory extends NodeViewTaskFactory {
Modified: core3/api/trunk/dnd-api/src/main/java/org/cytoscape/dnd/DropUtil.java
===================================================================
--- core3/api/trunk/dnd-api/src/main/java/org/cytoscape/dnd/DropUtil.java
2011-11-07 21:33:21 UTC (rev 27423)
+++ core3/api/trunk/dnd-api/src/main/java/org/cytoscape/dnd/DropUtil.java
2011-11-08 00:41:15 UTC (rev 27424)
@@ -11,6 +11,7 @@
/**
* A stateless, static utility class that provides a few methods useful for
* interacting with Drag-n-Drop related objects.
+ * @CyAPI.Static.Class
*/
public final class DropUtil {
Modified:
core3/api/trunk/dnd-api/src/main/java/org/cytoscape/dnd/GraphicalEntity.java
===================================================================
---
core3/api/trunk/dnd-api/src/main/java/org/cytoscape/dnd/GraphicalEntity.java
2011-11-07 21:33:21 UTC (rev 27423)
+++
core3/api/trunk/dnd-api/src/main/java/org/cytoscape/dnd/GraphicalEntity.java
2011-11-08 00:41:15 UTC (rev 27424)
@@ -18,48 +18,49 @@
public interface GraphicalEntity {
/**
- * get the Title of the graphical entity
- * @return the Title
+ * Get the Title of this GraphicalEntity.
+ * @return the Title of this GraphicalEntity.
*/
public String getTitle();
/**
- * retrieves the source of the drag operation, used when dragging a
graphical entity from the palette onto
- * the canvas
- * @return the drag source
+ * Retrieves the source of the drag operation, used when dragging a
GraphicalEntity from the palette onto
+ * the canvas.
+ * @return the the source of the drag operation, used when dragging a
GraphicalEntity from the palette onto
+ * the canvas.
*/
public DragSource getMyDragSource();
/**
- * get the image for the icon used on the palette to represent the
graphical entity
- * @return the image
+ * Get the image for the icon used on the palette to represent the
GraphicalEntity.
+ * @return the image for the icon used on the palette to represent the
GraphicalEntity.
*/
public Image getImage();
/**
- * get the icon used on the palette to represent the graphical entity
- * @return the icon used on the palette to represent the graphical
entity
+ * Get the icon used on the palette to represent this GraphicalEntity.
+ * @return the icon used on the palette to represent this
GraphicalEntity.
*/
public Icon getIcon();
/**
- * returns the name of the attribute associated with the Graphical
Entity.
+ * Returns the name of the attribute associated with this
GraphicalEntity.
* This is used to determine whether a Node or an Edge has been dropped
on the canvas.
* This attribute will also be set for the CyNode or CyEdge created as
a result of the drop operation.
- * @return the attribute name
+ * @return the name of the attribute associated with this
GraphicalEntity.
*/
public String getAttributeName();
/**
- * returns the value of the attribute associated with the Graphical
Entity.
+ * Returns the value of the attribute associated with this
GraphicalEntity.
* This attribute will be set for the CyNode or CyEdge created as a
result of the drop operation.
- * @return the attribute value
+ * @return the value of the attribute associated with this
GraphicalEntity.
*/
public String getAttributeValue();
/**
- * Returns descriptive text for the Graphical Entity. May be used as
tool tip text.
- * @return descriptive text for the Graphical Entity.
+ * Returns descriptive text for this GraphicalEntity. May be used as
tool tip text.
+ * @return descriptive text for this GraphicalEntity.
*/
public String getDescription();
}
--
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.
