Author: mkirby
Date: 2011-11-04 18:32:29 -0700 (Fri, 04 Nov 2011)
New Revision: 27421
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/AbstractVisualProperty.java
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/ContinuousRange.java
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/CyNetworkView.java
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/CyNetworkViewManager.java
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/DiscreteRange.java
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/Range.java
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/View.java
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/VisualLexicon.java
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/AboutToRemoveEdgeViewsListener.java
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/AboutToRemoveNodeViewsListener.java
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/AbstractNetworkViewEvent.java
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/AddedNodeViewsListener.java
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/EdgeViewsChangedEvent.java
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/NetworkViewChangedEvent.java
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/NodeViewsChangedEvent.java
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/ViewChangeRecord.java
Log:
Fixed Javadoc.
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/AbstractVisualProperty.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/AbstractVisualProperty.java
2011-11-05 00:59:47 UTC (rev 27420)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/AbstractVisualProperty.java
2011-11-05 01:32:29 UTC (rev 27421)
@@ -67,6 +67,7 @@
* @param range the {@link Range} for the visual property.
* @param id unique string for serialization.
* @param displayName human-readable name for this visual property.
+ * @param targetObjectDataType #ASKMIKE
*
*/
@SuppressWarnings("unchecked")
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/ContinuousRange.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/ContinuousRange.java
2011-11-05 00:59:47 UTC (rev 27420)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/ContinuousRange.java
2011-11-05 01:32:29 UTC (rev 27421)
@@ -4,6 +4,7 @@
* Defines a continuous range of values for {@link VisualProperty}s.
*
* @param <T> The generic type of this ContinuousRange.
+ * @CyAPI.Api.Interface
*/
public class ContinuousRange<T> implements Range<T> {
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/CyNetworkView.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/CyNetworkView.java
2011-11-05 00:59:47 UTC (rev 27420)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/CyNetworkView.java
2011-11-05 01:32:29 UTC (rev 27421)
@@ -44,7 +44,7 @@
/**
*
* Additional methods for CyNetworkView. Network view should implement BOTH
View
- * and CyNetworkView. #ASKMIKE
+ * and CyNetworkView.
*
* Consolidated data structure for graph object views.
* @CyAPI.Api.Interface
@@ -112,6 +112,8 @@
/**
* Sets the default value to be used for the specified visual property.
+ * @param <T> #ASKMIKE
+ * @param <V> #ASKMIKE
* @param vp The visual property whose default value we're specifying.
* @param defaultValue The default value to be used for this visual
property for this view.
*/
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/CyNetworkViewManager.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/CyNetworkViewManager.java
2011-11-05 00:59:47 UTC (rev 27420)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/CyNetworkViewManager.java
2011-11-05 01:32:29 UTC (rev 27421)
@@ -37,6 +37,7 @@
/**
* Basic access to network views in an instance of Cytoscape.
+ * @CyAPI.Api.Interface
*/
public interface CyNetworkViewManager {
/**
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/DiscreteRange.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/DiscreteRange.java
2011-11-05 00:59:47 UTC (rev 27420)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/DiscreteRange.java
2011-11-05 01:32:29 UTC (rev 27421)
@@ -7,6 +7,7 @@
* Defines a discrete range of values for {@link VisualProperty}s.
*
* @param <T> The generic type of this DiscreteRange.
+ * @CyAPI.Api.Interface
*/
public class DiscreteRange<T> implements Range<T> {
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/Range.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/Range.java
2011-11-05 00:59:47 UTC (rev 27420)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/Range.java
2011-11-05 01:32:29 UTC (rev 27421)
@@ -4,6 +4,7 @@
* Defines a range of values for {@link VisualProperty}s.
*
* @param <T> The generic type of this Range.
+ * @CyAPI.Api.Interface
*/
public interface Range<T> {
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/View.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/View.java
2011-11-05 00:59:47 UTC (rev 27420)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/View.java
2011-11-05 01:32:29 UTC (rev 27421)
@@ -45,7 +45,7 @@
*
* @param <S> the base (model-level) object for which this is a View. For
example, CyNode or CyEdge.
* In the future versions, Attributes can be this parameter.
- *
+ * @CyAPI.Api.Interface #ASKMIKE
*/
public interface View<S> extends Identifiable {
@@ -75,7 +75,8 @@
/**
* Set locked value. This value will be used to bypass the style.
*
- * @param <T>
+ * @param <T> Data type of the visual property. This can be subclasses
of type T.
+ * @param <V> Value of the visual property. This can be subclasses of
T.
* @param vp the VisualProperty
* @param value DOCUMENT ME!
*/
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/VisualLexicon.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/VisualLexicon.java
2011-11-05 00:59:47 UTC (rev 27420)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/VisualLexicon.java
2011-11-05 01:32:29 UTC (rev 27421)
@@ -44,7 +44,7 @@
* This is a pre-defined tree of VisualProperties designed by the {@linkplain
org.cytoscape.view.presentation.RenderingEngine} developer.
*
* @since Cytoscape 3.0
- *
+ * @CyAPI.Api.Interface
*/
public interface VisualLexicon {
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/AboutToRemoveEdgeViewsListener.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/AboutToRemoveEdgeViewsListener.java
2011-11-05 00:59:47 UTC (rev 27420)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/AboutToRemoveEdgeViewsListener.java
2011-11-05 01:32:29 UTC (rev 27421)
@@ -9,7 +9,7 @@
public interface AboutToRemoveEdgeViewsListener extends CyListener {
/**
- * Process event
+ * Process event.
*
* @param e the {@link AboutToRemoveEdgeViewsEvent} to be handled.
*/
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/AboutToRemoveNodeViewsListener.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/AboutToRemoveNodeViewsListener.java
2011-11-05 00:59:47 UTC (rev 27420)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/AboutToRemoveNodeViewsListener.java
2011-11-05 01:32:29 UTC (rev 27421)
@@ -9,7 +9,7 @@
public interface AboutToRemoveNodeViewsListener extends CyListener{
/**
- * Process event
+ * Process event.
*
* @param e the {@link AboutToRemoveNodeViewsEvent} to be handled.
*/
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/AbstractNetworkViewEvent.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/AbstractNetworkViewEvent.java
2011-11-05 00:59:47 UTC (rev 27420)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/AbstractNetworkViewEvent.java
2011-11-05 01:32:29 UTC (rev 27421)
@@ -8,7 +8,7 @@
/**
* Base class for all derived concrete event classes classes in this package
that require a {@link CyNetworkView}.
- * #ASKMIKE
+ *
*/
class AbstractNetworkViewEvent extends AbstractCyEvent<CyNetworkViewManager> {
private final CyNetworkView view;
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/AddedNodeViewsListener.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/AddedNodeViewsListener.java
2011-11-05 00:59:47 UTC (rev 27420)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/AddedNodeViewsListener.java
2011-11-05 01:32:29 UTC (rev 27421)
@@ -10,7 +10,7 @@
public interface AddedNodeViewsListener extends CyListener {
/**
- * Process event
+ * Process event.
*
* @param e the {@link AddedNodeViewsEvent} to be handled.
*/
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/EdgeViewsChangedEvent.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/EdgeViewsChangedEvent.java
2011-11-05 00:59:47 UTC (rev 27420)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/EdgeViewsChangedEvent.java
2011-11-05 01:32:29 UTC (rev 27421)
@@ -6,8 +6,17 @@
import org.cytoscape.model.CyEdge;
import org.cytoscape.view.model.CyNetworkView;
+/**
+ * #ASKMIKE
+ * @CyAPI.Final.Class
+ */
public final class EdgeViewsChangedEvent extends
AbstractCyPayloadEvent<CyNetworkView, ViewChangeRecord<CyEdge>> {
+ /**
+ * #ASKMIKE
+ * @param source
+ * @param edgeViewChanges
+ */
public EdgeViewsChangedEvent(CyNetworkView source,
Collection<ViewChangeRecord<CyEdge>> edgeViewChanges) {
super(source, EdgeViewsChangedListener.class, edgeViewChanges);
}
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/NetworkViewChangedEvent.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/NetworkViewChangedEvent.java
2011-11-05 00:59:47 UTC (rev 27420)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/NetworkViewChangedEvent.java
2011-11-05 01:32:29 UTC (rev 27421)
@@ -6,8 +6,17 @@
import org.cytoscape.model.CyNetwork;
import org.cytoscape.view.model.CyNetworkView;
+/**
+ * #ASKMIKE
+ * @CyAPI.Final.Class
+ */
public final class NetworkViewChangedEvent extends
AbstractCyPayloadEvent<CyNetworkView, ViewChangeRecord<CyNetwork>> {
+ /**
+ * #ASKMIKE
+ * @param source
+ * @param networkViewChanges
+ */
public NetworkViewChangedEvent(CyNetworkView source,
Collection<ViewChangeRecord<CyNetwork>> networkViewChanges) {
super(source, NetworkViewChangedListener.class,
networkViewChanges);
}
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/NodeViewsChangedEvent.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/NodeViewsChangedEvent.java
2011-11-05 00:59:47 UTC (rev 27420)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/NodeViewsChangedEvent.java
2011-11-05 01:32:29 UTC (rev 27421)
@@ -6,8 +6,17 @@
import org.cytoscape.model.CyNode;
import org.cytoscape.view.model.CyNetworkView;
+/**
+ * #ASKMIKE
+ * @CyAPI.Final.Class
+ */
public final class NodeViewsChangedEvent extends
AbstractCyPayloadEvent<CyNetworkView, ViewChangeRecord<CyNode>> {
+ /**
+ * #ASKMIKE
+ * @param source
+ * @param nodeViewChanges
+ */
public NodeViewsChangedEvent(CyNetworkView source,
Collection<ViewChangeRecord<CyNode>> nodeViewChanges) {
super(source, NodeViewsChangedListener.class, nodeViewChanges);
}
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/ViewChangeRecord.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/ViewChangeRecord.java
2011-11-05 00:59:47 UTC (rev 27420)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/events/ViewChangeRecord.java
2011-11-05 01:32:29 UTC (rev 27421)
@@ -4,6 +4,7 @@
import org.cytoscape.view.model.VisualProperty;
/**
+ * #ASKMIKE Needs class description and method descriptions.
* @CyAPI.Final.Class
*/
public final class ViewChangeRecord<T> {
--
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.
