Author: mkirby
Date: 2011-10-07 14:25:26 -0700 (Fri, 07 Oct 2011)
New Revision: 27091
Modified:
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/VisualMappingFunctionFactory.java
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/VisualMappingManager.java
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/events/VisualStyleAboutToBeRemovedEvent.java
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/events/VisualStyleAboutToBeRemovedListener.java
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/events/VisualStyleAddedListener.java
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/mappings/AbstractVisualMappingFunction.java
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/mappings/ContinuousMapping.java
Log:
Fixed Javadoc.
Modified:
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/VisualMappingFunctionFactory.java
===================================================================
---
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/VisualMappingFunctionFactory.java
2011-10-07 21:24:23 UTC (rev 27090)
+++
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/VisualMappingFunctionFactory.java
2011-10-07 21:25:26 UTC (rev 27091)
@@ -13,7 +13,7 @@
* Create a new {@linkplain VisualMappingFunction}.
*
* @param <K> Data type of controlling attribute.
- * @param <V> Data type of {@linkplain VisualProperty}, such as
{@linkplain Color}, {@linkplain String}, etc.
+ * @param <V> Data type of {@linkplain VisualProperty}, such as
{@linkplain java.awt.Color}, {@linkplain String}, etc.
*
* @param attributeName Controlling attribute name. This is a name of
the column in a data table.
* @param attrValueType Data type of controlling attribute.
Modified:
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/VisualMappingManager.java
===================================================================
---
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/VisualMappingManager.java
2011-10-07 21:24:23 UTC (rev 27090)
+++
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/VisualMappingManager.java
2011-10-07 21:25:26 UTC (rev 27091)
@@ -43,7 +43,7 @@
import org.cytoscape.view.vizmap.events.VisualStyleAddedEvent;
/**
- * Manager for {@linkplain Visual Style}s. This object manages mapping from
view
+ * Manager for {@linkplain VisualStyle}s. This object manages mapping from view
* model to VisualStyle. User objects can access all VisualStyles and
* VisualMappingFunctions through this class.
*
@@ -59,10 +59,8 @@
/**
* Set a {@linkplain VisualStyle} to the target network view model.
*
- * @param vs
- * Visual Style to be set.
- * @param nv
- * Target network view
+ * @param visualStyle Visual Style to be set.
+ * @param networkViewModel The target network view model.
*/
void setVisualStyle(final VisualStyle visualStyle,
final CyNetworkView networkViewModel);
Modified:
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/events/VisualStyleAboutToBeRemovedEvent.java
===================================================================
---
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/events/VisualStyleAboutToBeRemovedEvent.java
2011-10-07 21:24:23 UTC (rev 27090)
+++
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/events/VisualStyleAboutToBeRemovedEvent.java
2011-10-07 21:25:26 UTC (rev 27091)
@@ -50,7 +50,7 @@
* Create an event for the removed VisualStyle.
*
* @param source Source of event. This is always a {@link
VisualMappingManager}.
- * @param destroyed VisualStyle to be deleted.
+ * @param style VisualStyle to be deleted.
*/
public VisualStyleAboutToBeRemovedEvent(final VisualMappingManager
source, final VisualStyle style) {
super(source, VisualStyleAboutToBeRemovedListener.class);
Modified:
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/events/VisualStyleAboutToBeRemovedListener.java
===================================================================
---
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/events/VisualStyleAboutToBeRemovedListener.java
2011-10-07 21:24:23 UTC (rev 27090)
+++
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/events/VisualStyleAboutToBeRemovedListener.java
2011-10-07 21:25:26 UTC (rev 27091)
@@ -42,7 +42,7 @@
public interface VisualStyleAboutToBeRemovedListener extends CyListener {
/**
- * Update states/GUI using deleted {@linkplain VisualStyle} information.
+ * Update states/GUI using deleted {@linkplain
org.cytoscape.view.vizmap.VisualStyle} information.
*
* @param e
* Event containing deleted VisualStyle.
Modified:
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/events/VisualStyleAddedListener.java
===================================================================
---
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/events/VisualStyleAddedListener.java
2011-10-07 21:24:23 UTC (rev 27090)
+++
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/events/VisualStyleAddedListener.java
2011-10-07 21:25:26 UTC (rev 27091)
@@ -42,11 +42,11 @@
public interface VisualStyleAddedListener extends CyListener {
/**
- * Do something with a new {@linkplain VisualStyle}. Usually, GUI
components
+ * Do something with a new {@linkplain
org.cytoscape.view.vizmap.VisualStyle}. Usually, GUI components
* and managers executes this method to update their states.
*
* @param e
- * event contains new {@linkplain VisualStyle} object.
+ * event contains new {@linkplain
org.cytoscape.view.vizmap.VisualStyle} object.
*/
void handleEvent(final VisualStyleAddedEvent e);
}
Modified:
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/mappings/AbstractVisualMappingFunction.java
===================================================================
---
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/mappings/AbstractVisualMappingFunction.java
2011-10-07 21:24:23 UTC (rev 27090)
+++
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/mappings/AbstractVisualMappingFunction.java
2011-10-07 21:25:26 UTC (rev 27091)
@@ -14,13 +14,13 @@
public abstract class AbstractVisualMappingFunction<K, V> implements
VisualMappingFunction<K, V> {
- // Mapping attribute name. This is immutable.
+ /** Mapping attribute name. This is immutable. */
protected final String attrName;
- // Type of attribute
+ /** Type of attribute. */
protected final Class<K> attrType;
- // Visual Property used in this mapping.
+ /** Visual Property used in this mapping. */
protected final VisualProperty<V> vp;
Modified:
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/mappings/ContinuousMapping.java
===================================================================
---
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/mappings/ContinuousMapping.java
2011-10-07 21:24:23 UTC (rev 27090)
+++
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/mappings/ContinuousMapping.java
2011-10-07 21:25:26 UTC (rev 27091)
@@ -27,6 +27,7 @@
/**
* Gets Total Point Count.
+ * @return the total point count.
*/
public int getPointCount();
--
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.
