Author: mkirby
Date: 2011-11-07 17:33:05 -0800 (Mon, 07 Nov 2011)
New Revision: 27428
Modified:
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/AbstractCyAction.java
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/AbstractToolBarComponent.java
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/AcceleratorParser.java
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/CyAction.java
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/CyHelpBroker.java
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/CySwingApplication.java
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/CytoPanel.java
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/CytoPanelComponent.java
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/CytoPanelName.java
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/CytoPanelState.java
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/MenuEnableSupport.java
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/ToolBarComponent.java
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/ViewUpdater.java
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/events/CytoPanelComponentSelectedEvent.java
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/events/CytoPanelComponentSelectedListener.java
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/events/CytoPanelStateChangedEvent.java
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/events/CytoPanelStateChangedListener.java
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/events/PreferencesUpdatedEvent.java
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/events/PreferencesUpdatedListener.java
Log:
Fixed Javadoc.
Modified:
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/AbstractCyAction.java
===================================================================
---
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/AbstractCyAction.java
2011-11-08 01:24:06 UTC (rev 27427)
+++
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/AbstractCyAction.java
2011-11-08 01:33:05 UTC (rev 27428)
@@ -52,13 +52,17 @@
/**
* An abstract implementation of the CyAction interface. Instead of using this
* class directly you should (strongly) consider implementing a
- * org.cytoscape.work.TaskFactory/org.cytoscape.work.Task pair. Doing so will
+ * {@link org.cytoscape.work.TaskFactory}/{@link org.cytoscape.work.Task}
pair. Doing so will
* allow your action to be used outside of a Swing specific application (which
* the CyAction interface binds you to)!
+ * @CyAPI.Abstract.Class
*/
public abstract class AbstractCyAction extends AbstractAction implements
CyAction {
private static final long serialVersionUID = -2245672104075936952L;
private static final Logger logger =
LoggerFactory.getLogger(AbstractCyAction.class);
+ /**
+ * #ASKMIKE and other protected attributes right below
+ */
protected String preferredMenu = null;
// Value 100.0 means end of menu/tool bar
@@ -379,6 +383,9 @@
enabler.enableForNetwork();
}
+ /**
+ * #ASKMIKE and all methods below this
+ */
protected void enableForNetworkWithoutView() {
enabler.enableForNetworkWithoutView() ;
}
Modified:
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/AbstractToolBarComponent.java
===================================================================
---
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/AbstractToolBarComponent.java
2011-11-08 01:24:06 UTC (rev 27427)
+++
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/AbstractToolBarComponent.java
2011-11-08 01:33:05 UTC (rev 27428)
@@ -1,6 +1,10 @@
package org.cytoscape.application.swing;
+/**
+ * #ASKMIKE needs class descript and method comments.
+ * @CyAPI.Abstract.Class
+ */
public abstract class AbstractToolBarComponent implements ToolBarComponent{
protected float toolbarGravity = 100.0f;
Modified:
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/AcceleratorParser.java
===================================================================
---
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/AcceleratorParser.java
2011-11-08 01:24:06 UTC (rev 27427)
+++
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/AcceleratorParser.java
2011-11-08 01:33:05 UTC (rev 27428)
@@ -36,6 +36,7 @@
* <code>AcceleratorParser</code> will convert the Control key modifier to an
* Apple key modifier if one is running on a Mac and vice-versa.</li>
* </ol>
+ * @CyAPI.Static.Class
*/
final class AcceleratorParser {
Modified:
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/CyAction.java
===================================================================
---
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/CyAction.java
2011-11-08 01:24:06 UTC (rev 27427)
+++
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/CyAction.java
2011-11-08 01:33:05 UTC (rev 27428)
@@ -48,6 +48,7 @@
/**
* An interface that describes how an action should be placed within
* the menus and/or toolbars of the Swing application.
+ * @CyAPI.Spi.Interface
*/
public interface CyAction extends Action, MenuListener, PopupMenuListener {
@@ -90,7 +91,7 @@
KeyStroke getAcceleratorKeyStroke();
/**
- * This method returns a Menu specification string. Submenus are
preceeded
+ * This method returns a Menu specification string. Submenus are
preceded
* by dots in this string, so the result "File.Import" specifies the
submenu
* "Import" of the menu "File". If the result is null, the menu will be
* placed in a default location.
Modified:
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/CyHelpBroker.java
===================================================================
---
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/CyHelpBroker.java
2011-11-08 01:24:06 UTC (rev 27427)
+++
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/CyHelpBroker.java
2011-11-08 01:33:05 UTC (rev 27428)
@@ -43,6 +43,7 @@
/**
* This interface provides access to the Cytoscape Help Broker and
* Help Set for managing the JavaHelp system.
+ * @CyAPI.Api.Interface
*/
public interface CyHelpBroker {
Modified:
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/CySwingApplication.java
===================================================================
---
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/CySwingApplication.java
2011-11-08 01:24:06 UTC (rev 27427)
+++
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/CySwingApplication.java
2011-11-08 01:33:05 UTC (rev 27428)
@@ -46,6 +46,7 @@
/**
* This interface provides basic access to the Swing objects that
* constitute this application.
+ * @CyAPI.Api.Interface
*/
public interface CySwingApplication {
Modified:
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/CytoPanel.java
===================================================================
---
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/CytoPanel.java
2011-11-08 01:24:06 UTC (rev 27427)
+++
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/CytoPanel.java
2011-11-08 01:33:05 UTC (rev 27428)
@@ -38,6 +38,7 @@
* Interface to a CytoPanel.
*
* @author Ben Gross.
+ * @CyAPI.Api.Interface
*/
public interface CytoPanel {
Modified:
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/CytoPanelComponent.java
===================================================================
---
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/CytoPanelComponent.java
2011-11-08 01:24:06 UTC (rev 27427)
+++
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/CytoPanelComponent.java
2011-11-08 01:33:05 UTC (rev 27428)
@@ -37,7 +37,8 @@
/**
* An interface that allows a component to be registered as a service
- * that will then be added to the appropriate CytoPanel.
+ * that will then be added to the appropriate {@link CytoPanel}.
+ * @CyAPI.Spi.Interface
*/
public interface CytoPanelComponent {
Modified:
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/CytoPanelName.java
===================================================================
---
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/CytoPanelName.java
2011-11-08 01:24:06 UTC (rev 27427)
+++
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/CytoPanelName.java
2011-11-08 01:33:05 UTC (rev 27428)
@@ -31,8 +31,9 @@
/**
- * An enum that describes CytoPanels uses compass directions
+ * An enum that describes {@link CytoPanel}s uses compass directions
* to describe their location within the application.
+ * @CyAPI.Enum.Class
*/
public enum CytoPanelName {
/**
@@ -41,17 +42,17 @@
SOUTH("Data Panel"),
/**
- * The east or righthand panel.
+ * The east or right-hand panel.
*/
EAST("Results Panel"),
/**
- * The west or lefthand panel.
+ * The west or left-hand panel.
*/
WEST("Control Panel"),
/**
- * The southwest or bottom left panel.
+ * The south-west or bottom left panel.
*/
SOUTH_WEST("Tool Panel"),
;
Modified:
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/CytoPanelState.java
===================================================================
---
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/CytoPanelState.java
2011-11-08 01:24:06 UTC (rev 27427)
+++
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/CytoPanelState.java
2011-11-08 01:33:05 UTC (rev 27428)
@@ -39,22 +39,23 @@
/**
- * The different display states available for a CytoPanel.
+ * The different display states available for a {@link CytoPanel}.
+ * @CyAPI.Enum.Class
*/
public enum CytoPanelState {
/**
- * The CytoPanel will be hidden and only appear as a menu item.
+ * The {@link CytoPanel} will be hidden and only appear as a menu item.
*/
HIDE,
/**
- * The CytoPanel will be open and appear as a separate frame
+ * The {@link CytoPanel} will be open and appear as a separate frame
* independent of the application.
*/
FLOAT,
/**
- * The CytoPanel will be open and appear as a nested frame
+ * The {@link CytoPanel} will be open and appear as a nested frame
* within the application.
*/
DOCK,
Modified:
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/MenuEnableSupport.java
===================================================================
---
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/MenuEnableSupport.java
2011-11-08 01:24:06 UTC (rev 27427)
+++
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/MenuEnableSupport.java
2011-11-08 01:33:05 UTC (rev 27428)
@@ -42,7 +42,8 @@
/**
* A class that allows the enabled state of an Action of JMenuItem to managed
in
- * a consistent way.
+ * a consistent way. #ASKMIKE needs comments on several methods
+ * @CyAPI.Final.Class
*/
public final class MenuEnableSupport {
Modified:
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/ToolBarComponent.java
===================================================================
---
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/ToolBarComponent.java
2011-11-08 01:24:06 UTC (rev 27427)
+++
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/ToolBarComponent.java
2011-11-08 01:33:05 UTC (rev 27428)
@@ -7,6 +7,7 @@
/**
* An interface that allows a component to be registered as a service
* that will then be added to the ToolBar.
+ * @CyAPI.Spi.Interface
*/
public interface ToolBarComponent {
Modified:
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/ViewUpdater.java
===================================================================
---
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/ViewUpdater.java
2011-11-08 01:24:06 UTC (rev 27427)
+++
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/ViewUpdater.java
2011-11-08 01:33:05 UTC (rev 27428)
@@ -40,6 +40,7 @@
* A utility class that provides an implementation of {@link RowsSetListener}
* for a particular column and {@link VisualProperty}.
* @param <S> The generic type of this ViewUpdater.
+ * #ASKMIKE taglet?
*/
public class ViewUpdater<S> implements RowsSetListener {
Modified:
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/events/CytoPanelComponentSelectedEvent.java
===================================================================
---
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/events/CytoPanelComponentSelectedEvent.java
2011-11-08 01:24:06 UTC (rev 27427)
+++
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/events/CytoPanelComponentSelectedEvent.java
2011-11-08 01:33:05 UTC (rev 27428)
@@ -6,7 +6,8 @@
import org.cytoscape.event.AbstractCyEvent;
/**
- * The event fired to indicate that a CytoPanelComponent has been selected.
+ * The event fired to indicate that a {@link
org.cytoscape.application.swing.CytoPanelComponent} has been selected.
+ * @CyAPI.Final.Class
*/
public final class CytoPanelComponentSelectedEvent extends
AbstractCyEvent<Object> {
Modified:
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/events/CytoPanelComponentSelectedListener.java
===================================================================
---
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/events/CytoPanelComponentSelectedListener.java
2011-11-08 01:24:06 UTC (rev 27427)
+++
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/events/CytoPanelComponentSelectedListener.java
2011-11-08 01:33:05 UTC (rev 27428)
@@ -4,7 +4,8 @@
import org.cytoscape.event.CyListener;
/**
- * The listener for handling CytoPanelComponentSelectedEvent.
+ * The listener for handling {@link CytoPanelComponentSelectedEvent}.
+ * @CyAPI.Spi.Interface
*/
public interface CytoPanelComponentSelectedListener extends CyListener {
Modified:
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/events/CytoPanelStateChangedEvent.java
===================================================================
---
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/events/CytoPanelStateChangedEvent.java
2011-11-08 01:24:06 UTC (rev 27427)
+++
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/events/CytoPanelStateChangedEvent.java
2011-11-08 01:33:05 UTC (rev 27428)
@@ -7,6 +7,7 @@
/**
* An event to indicate that a CytoPanel has changed state.
+ * @CyAPI.Final.Class
*/
public final class CytoPanelStateChangedEvent extends AbstractCyEvent<Object> {
Modified:
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/events/CytoPanelStateChangedListener.java
===================================================================
---
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/events/CytoPanelStateChangedListener.java
2011-11-08 01:24:06 UTC (rev 27427)
+++
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/events/CytoPanelStateChangedListener.java
2011-11-08 01:33:05 UTC (rev 27428)
@@ -4,7 +4,8 @@
import org.cytoscape.event.CyListener;
/**
- * A listener for handling CytoPanelStateChangedEvents.
+ * A listener for handling {@link CytoPanelStateChangedEvent}s.
+ * @CyAPI.Spi.Interface
*/
public interface CytoPanelStateChangedListener extends CyListener {
Modified:
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/events/PreferencesUpdatedEvent.java
===================================================================
---
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/events/PreferencesUpdatedEvent.java
2011-11-08 01:24:06 UTC (rev 27427)
+++
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/events/PreferencesUpdatedEvent.java
2011-11-08 01:33:05 UTC (rev 27428)
@@ -6,6 +6,7 @@
/**
* An event indicating that system preferences have been updated.
+ * @CyAPI.Final.Class
*/
public final class PreferencesUpdatedEvent extends AbstractCyEvent<Object> {
private final Properties oldProps;
Modified:
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/events/PreferencesUpdatedListener.java
===================================================================
---
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/events/PreferencesUpdatedListener.java
2011-11-08 01:24:06 UTC (rev 27427)
+++
core3/api/trunk/swing-application-api/src/main/java/org/cytoscape/application/swing/events/PreferencesUpdatedListener.java
2011-11-08 01:33:05 UTC (rev 27428)
@@ -4,12 +4,13 @@
import org.cytoscape.event.CyListener;
/**
- * A listener for the PreferencesUpdatedEvent.
+ * A listener for the {@link PreferencesUpdatedEvent}.
+ * @CyAPI.Spi.Interface
*/
public interface PreferencesUpdatedListener extends CyListener {
/**
- * Proces the specified event.
+ * Process the specified event.
* @param e The even to be processed.
*/
public void handleEvent(PreferencesUpdatedEvent e);
--
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.
