Author: mkirby
Date: 2011-11-03 23:58:00 -0700 (Thu, 03 Nov 2011)
New Revision: 27402
Modified:
core3/api/trunk/layout-api/src/main/java/org/cytoscape/view/layout/AbstractBasicLayoutTask.java
core3/api/trunk/layout-api/src/main/java/org/cytoscape/view/layout/AbstractLayoutAlgorithm.java
core3/api/trunk/layout-api/src/main/java/org/cytoscape/view/layout/AbstractPartitionLayoutTask.java
core3/api/trunk/layout-api/src/main/java/org/cytoscape/view/layout/CyLayoutAlgorithm.java
core3/api/trunk/layout-api/src/main/java/org/cytoscape/view/layout/CyLayoutAlgorithmManager.java
core3/api/trunk/layout-api/src/main/java/org/cytoscape/view/layout/EdgeWeighter.java
core3/api/trunk/layout-api/src/main/java/org/cytoscape/view/layout/LayoutEdge.java
core3/api/trunk/layout-api/src/main/java/org/cytoscape/view/layout/LayoutNode.java
core3/api/trunk/layout-api/src/main/java/org/cytoscape/view/layout/LayoutPartition.java
core3/api/trunk/layout-api/src/main/java/org/cytoscape/view/layout/PartitionUtil.java
Log:
Fixed Javadoc.
Modified:
core3/api/trunk/layout-api/src/main/java/org/cytoscape/view/layout/AbstractBasicLayoutTask.java
===================================================================
---
core3/api/trunk/layout-api/src/main/java/org/cytoscape/view/layout/AbstractBasicLayoutTask.java
2011-11-04 06:35:12 UTC (rev 27401)
+++
core3/api/trunk/layout-api/src/main/java/org/cytoscape/view/layout/AbstractBasicLayoutTask.java
2011-11-04 06:58:00 UTC (rev 27402)
@@ -23,6 +23,7 @@
* Extensions of this class are meant to operate on the CyNetworkView
* provided to the constructor (and is available as a protected member
* variable).
+ * @CyAPI.Abstract.Class
*/
public abstract class AbstractBasicLayoutTask extends AbstractTask {
Modified:
core3/api/trunk/layout-api/src/main/java/org/cytoscape/view/layout/AbstractLayoutAlgorithm.java
===================================================================
---
core3/api/trunk/layout-api/src/main/java/org/cytoscape/view/layout/AbstractLayoutAlgorithm.java
2011-11-04 06:35:12 UTC (rev 27401)
+++
core3/api/trunk/layout-api/src/main/java/org/cytoscape/view/layout/AbstractLayoutAlgorithm.java
2011-11-04 06:58:00 UTC (rev 27402)
@@ -52,6 +52,7 @@
/**
* The AbstractLayoutAlgorithm provides a basic implementation of a layout
TaskFactory.
+ * @CyAPI.Abstract.Class
*/
abstract public class AbstractLayoutAlgorithm implements CyLayoutAlgorithm {
@@ -67,6 +68,7 @@
* Never use this method from within a layout to access the submenu
options,
* instead call the configureLayoutFromSubmenuSelection() method to
configure
* the layout based on menu selection.
+ * @return #ASKMIKE
*/
@Tunable(description="Submenu definition")
public ListSingleSelection<String> getSubmenuOptions() {
@@ -232,6 +234,7 @@
/**
* A computer readable name used to construct property strings.
+ * @return a computer readable name used to construct property strings.
*/
public String getName() {
return computerName;
@@ -239,6 +242,7 @@
/**
* Used to get the user-visible name of the layout.
+ * @return the user-visible name of the layout.
*/
public String toString() {
return humanName;
Modified:
core3/api/trunk/layout-api/src/main/java/org/cytoscape/view/layout/AbstractPartitionLayoutTask.java
===================================================================
---
core3/api/trunk/layout-api/src/main/java/org/cytoscape/view/layout/AbstractPartitionLayoutTask.java
2011-11-04 06:35:12 UTC (rev 27401)
+++
core3/api/trunk/layout-api/src/main/java/org/cytoscape/view/layout/AbstractPartitionLayoutTask.java
2011-11-04 06:58:00 UTC (rev 27402)
@@ -20,6 +20,7 @@
* Extensions of this class are meant to implement the layoutPartition()
* method and operate on the LayoutParition object that is passed to that
* method as an argument.
+ * @CyAPI.Abstract.Class
*/
public abstract class AbstractPartitionLayoutTask extends
AbstractBasicLayoutTask {
Modified:
core3/api/trunk/layout-api/src/main/java/org/cytoscape/view/layout/CyLayoutAlgorithm.java
===================================================================
---
core3/api/trunk/layout-api/src/main/java/org/cytoscape/view/layout/CyLayoutAlgorithm.java
2011-11-04 06:35:12 UTC (rev 27401)
+++
core3/api/trunk/layout-api/src/main/java/org/cytoscape/view/layout/CyLayoutAlgorithm.java
2011-11-04 06:58:00 UTC (rev 27402)
@@ -42,6 +42,7 @@
/**
* An extension of NetworkViewTaskFactory specific to layout algorithms.
+ * @CyAPI.Spi.Interface
*/
public interface CyLayoutAlgorithm extends NetworkViewTaskFactory {
/**
Modified:
core3/api/trunk/layout-api/src/main/java/org/cytoscape/view/layout/CyLayoutAlgorithmManager.java
===================================================================
---
core3/api/trunk/layout-api/src/main/java/org/cytoscape/view/layout/CyLayoutAlgorithmManager.java
2011-11-04 06:35:12 UTC (rev 27401)
+++
core3/api/trunk/layout-api/src/main/java/org/cytoscape/view/layout/CyLayoutAlgorithmManager.java
2011-11-04 06:58:00 UTC (rev 27402)
@@ -34,6 +34,7 @@
/**
* This class provides access to the available layout algorithms.
+ * @CyAPI.Api.Interface
*/
public interface CyLayoutAlgorithmManager {
Modified:
core3/api/trunk/layout-api/src/main/java/org/cytoscape/view/layout/EdgeWeighter.java
===================================================================
---
core3/api/trunk/layout-api/src/main/java/org/cytoscape/view/layout/EdgeWeighter.java
2011-11-04 06:35:12 UTC (rev 27401)
+++
core3/api/trunk/layout-api/src/main/java/org/cytoscape/view/layout/EdgeWeighter.java
2011-11-04 06:58:00 UTC (rev 27402)
@@ -36,6 +36,10 @@
import org.cytoscape.model.CyRow;
import org.cytoscape.work.Tunable;
+/**
+ * #ASKMIKE
+ * @CyAPI.Enum.Class
+ */
enum WeightTypes {
GUESS("Heuristic"),
LOG("-Log(value)"),
@@ -50,6 +54,7 @@
/**
* The EdgeWeighter class. This class is used as a container for information
* about how to interpret weights in an weighted layout.
+ * @CyAPI.Final.Class
*/
public final class EdgeWeighter {
Modified:
core3/api/trunk/layout-api/src/main/java/org/cytoscape/view/layout/LayoutEdge.java
===================================================================
---
core3/api/trunk/layout-api/src/main/java/org/cytoscape/view/layout/LayoutEdge.java
2011-11-04 06:35:12 UTC (rev 27401)
+++
core3/api/trunk/layout-api/src/main/java/org/cytoscape/view/layout/LayoutEdge.java
2011-11-04 06:58:00 UTC (rev 27402)
@@ -39,6 +39,7 @@
* about the edges in a layout. In particular, it provides a convenient handle
* to information about the weights associated with edges, and pointers to the
* LayoutNodes that are joined by this edge.
+ * @CyAPI.Final.Class
*/
public final class LayoutEdge {
// instance variables
@@ -164,7 +165,7 @@
/**
* Return a string representation for this LayoutEdge.
*
- * @return A String containting the name of the Edge, the connecting
LayoutNodes
+ * @return A String containing the name of the Edge, the connecting
LayoutNodes
* and the current weight.
*/
public String toString() {
Modified:
core3/api/trunk/layout-api/src/main/java/org/cytoscape/view/layout/LayoutNode.java
===================================================================
---
core3/api/trunk/layout-api/src/main/java/org/cytoscape/view/layout/LayoutNode.java
2011-11-04 06:35:12 UTC (rev 27401)
+++
core3/api/trunk/layout-api/src/main/java/org/cytoscape/view/layout/LayoutNode.java
2011-11-04 06:58:00 UTC (rev 27402)
@@ -46,6 +46,7 @@
* to information about position, the node itself, the node view. Many of
* the methods of this class are wrappers for Node or View<CyNode> methods, and
* these are often wrapped by LayoutPartition methods.
+ * @CyAPI.Final.Class
*/
public final class LayoutNode {
// static (class) variables
@@ -105,8 +106,8 @@
* that location. Users should call moveToLocation to actually
* accomplish the move.
*
- * @param x Double representing the new X corrdinate of this node
- * @param y Double representing the new Y corrdinate of this node
+ * @param x Double representing the new X coordinate of this node
+ * @param y Double representing the new Y coordinate of this node
*/
public void setLocation(double x, double y) {
this.x = x;
@@ -119,7 +120,7 @@
* that location. Users should call moveToLocation to actually
* accomplish the move.
*
- * @param x Double representing the new X corrdinate of this node
+ * @param x Double representing the new X coordinate of this node
*/
public void setX(double x) {
this.x = x;
@@ -131,7 +132,7 @@
* that location. Users should call moveToLocation to actually
* accomplish the move.
*
- * @param y Double representing the new Y corrdinate of this node
+ * @param y Double representing the new Y coordinate of this node
*/
public void setY(double y) {
this.y = y;
@@ -311,10 +312,10 @@
}
/**
- * Return the euclidean distance between this node and another node
+ * Return the Euclidean distance between this node and another node
*
* @param otherNode the node to measure the distance to
- * @return the euclidean distance from this node to otherNode
+ * @return the Euclidean distance from this node to otherNode
*/
public double distance(LayoutNode otherNode) {
double deltaX = this.x - otherNode.getX();
@@ -324,11 +325,11 @@
}
/**
- * Return the euclidean distance between this node and a location
+ * Return the Euclidean distance between this node and a location
*
* @param uX the X location to measure the distance to
* @param uY the Y location to measure the distance to
- * @return the euclidean distance from this node to (uX,uY)
+ * @return the Euclidean distance from this node to (uX,uY)
*/
public double distance(double uX, double uY) {
double deltaX = this.x - uX;
Modified:
core3/api/trunk/layout-api/src/main/java/org/cytoscape/view/layout/LayoutPartition.java
===================================================================
---
core3/api/trunk/layout-api/src/main/java/org/cytoscape/view/layout/LayoutPartition.java
2011-11-04 06:35:12 UTC (rev 27401)
+++
core3/api/trunk/layout-api/src/main/java/org/cytoscape/view/layout/LayoutPartition.java
2011-11-04 06:58:00 UTC (rev 27402)
@@ -59,6 +59,7 @@
*
* @author <a href="mailto:[email protected]";>Scooter Morris</a>
* @version 0.9
+ * @CyAPI.Final.Class
*/
public final class LayoutPartition {
@@ -321,7 +322,7 @@
}
/**
- * Return an iterator over all of the LayoutNodes in this parition
+ * Return an iterator over all of the LayoutNodes in this partition
*
* @return Iterator over the list of LayoutNodes
* @see LayoutNode
@@ -331,7 +332,7 @@
}
/**
- * Return an iterator over all of the LayoutEdges in this parition
+ * Return an iterator over all of the LayoutEdges in this partition
*
* @return Iterator over the list of LayoutEdges
* @see LayoutEdge
@@ -431,7 +432,7 @@
}
/**
- * Return the number of locked nodes within this parititon
+ * Return the number of locked nodes within this partition
*
* @return number of locked nodes in partition
*/
Modified:
core3/api/trunk/layout-api/src/main/java/org/cytoscape/view/layout/PartitionUtil.java
===================================================================
---
core3/api/trunk/layout-api/src/main/java/org/cytoscape/view/layout/PartitionUtil.java
2011-11-04 06:35:12 UTC (rev 27401)
+++
core3/api/trunk/layout-api/src/main/java/org/cytoscape/view/layout/PartitionUtil.java
2011-11-04 06:58:00 UTC (rev 27402)
@@ -58,6 +58,7 @@
/**
* This class also provides static methods that are used to partition a
network.
+ * @CyAPI.Static.Class
*/
public final class PartitionUtil {
--
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.
