Author: mkirby
Date: 2011-10-29 14:42:03 -0700 (Sat, 29 Oct 2011)
New Revision: 27343
Modified:
core3/api/trunk/event-api/src/main/java/org/cytoscape/event/AbstractCyEvent.java
core3/api/trunk/event-api/src/main/java/org/cytoscape/event/AbstractCyPayloadEvent.java
core3/api/trunk/event-api/src/main/java/org/cytoscape/event/CyEvent.java
core3/api/trunk/event-api/src/main/java/org/cytoscape/event/CyEventHelper.java
core3/api/trunk/event-api/src/main/java/org/cytoscape/event/CyListener.java
core3/api/trunk/event-api/src/main/java/org/cytoscape/event/CyPayloadEvent.java
Log:
Fixed Javadoc.
Modified:
core3/api/trunk/event-api/src/main/java/org/cytoscape/event/AbstractCyEvent.java
===================================================================
---
core3/api/trunk/event-api/src/main/java/org/cytoscape/event/AbstractCyEvent.java
2011-10-29 21:38:35 UTC (rev 27342)
+++
core3/api/trunk/event-api/src/main/java/org/cytoscape/event/AbstractCyEvent.java
2011-10-29 21:42:03 UTC (rev 27343)
@@ -38,6 +38,7 @@
/**
* A base implementation of CyEvent that can be used by events.
* @param <T> the generic type of the AbstractCyEvent.
+ * @CyAPI.Abstract.Class
*/
public abstract class AbstractCyEvent<T> implements CyEvent<T> {
Modified:
core3/api/trunk/event-api/src/main/java/org/cytoscape/event/AbstractCyPayloadEvent.java
===================================================================
---
core3/api/trunk/event-api/src/main/java/org/cytoscape/event/AbstractCyPayloadEvent.java
2011-10-29 21:38:35 UTC (rev 27342)
+++
core3/api/trunk/event-api/src/main/java/org/cytoscape/event/AbstractCyPayloadEvent.java
2011-10-29 21:42:03 UTC (rev 27343)
@@ -41,6 +41,7 @@
* A base implementation of CyPayloadEvent that can be used by events.
* @param <T> the generic type of the source object.
* @param <P> the generic type of the payloads.
+ * @CyAPI.Abstract.Class
*/
public abstract class AbstractCyPayloadEvent<T,P> extends AbstractCyEvent<T>
implements CyPayloadEvent<T,P> {
Modified:
core3/api/trunk/event-api/src/main/java/org/cytoscape/event/CyEvent.java
===================================================================
--- core3/api/trunk/event-api/src/main/java/org/cytoscape/event/CyEvent.java
2011-10-29 21:38:35 UTC (rev 27342)
+++ core3/api/trunk/event-api/src/main/java/org/cytoscape/event/CyEvent.java
2011-10-29 21:42:03 UTC (rev 27343)
@@ -40,6 +40,7 @@
* event can add additional methods to provide access to information
* relevant to that specific event.
* @param <T> the generic type of the CyEvent.
+ * @CyAPI.Spi.Interface
*/
public interface CyEvent<T> {
Modified:
core3/api/trunk/event-api/src/main/java/org/cytoscape/event/CyEventHelper.java
===================================================================
---
core3/api/trunk/event-api/src/main/java/org/cytoscape/event/CyEventHelper.java
2011-10-29 21:38:35 UTC (rev 27342)
+++
core3/api/trunk/event-api/src/main/java/org/cytoscape/event/CyEventHelper.java
2011-10-29 21:42:03 UTC (rev 27343)
@@ -32,6 +32,7 @@
* The basic event handling interface for Cytoscape. All Cytoscape events
* should be fired using these methods. All listeners should be registered
* as CyListener services.
+ * @CyAPI.Api.Interface #ASKMIKE
*/
public interface CyEventHelper {
/**
Modified:
core3/api/trunk/event-api/src/main/java/org/cytoscape/event/CyListener.java
===================================================================
--- core3/api/trunk/event-api/src/main/java/org/cytoscape/event/CyListener.java
2011-10-29 21:38:35 UTC (rev 27342)
+++ core3/api/trunk/event-api/src/main/java/org/cytoscape/event/CyListener.java
2011-10-29 21:42:03 UTC (rev 27343)
@@ -31,7 +31,7 @@
/**
* The basic interface that any class interested in a particular
* type of event should implement.
- * <p> <b> Any class implementing this inteface must implement the
+ * <p> <b> Any class implementing this interface must implement the
* method:
* <p> <code>public void handleEvent(ZZZ e);</code>
* <p>where ZZZ extends CyEvent! </b>
@@ -53,6 +53,7 @@
* type, but that doesn't appear possible with Java. That
* means users are either must register as different listeners
* or handle different event types in the handleEvent method.
+ * @CyAPI.Spi.Interface #ASKMIKE
*/
public interface CyListener {
// implement
Modified:
core3/api/trunk/event-api/src/main/java/org/cytoscape/event/CyPayloadEvent.java
===================================================================
---
core3/api/trunk/event-api/src/main/java/org/cytoscape/event/CyPayloadEvent.java
2011-10-29 21:38:35 UTC (rev 27342)
+++
core3/api/trunk/event-api/src/main/java/org/cytoscape/event/CyPayloadEvent.java
2011-10-29 21:42:03 UTC (rev 27343)
@@ -41,6 +41,7 @@
* An extension of CyEvent specifically for payload events.
* @param <S> The event source type.
* @param <P> The payload type.
+ * @CyAPI.Spi.Interface
*/
public interface CyPayloadEvent<S,P> extends CyEvent<S> {
--
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.
