Author: mkirby
Date: 2011-10-07 14:28:05 -0700 (Fri, 07 Oct 2011)
New Revision: 27092
Modified:
core3/api/trunk/session-api/src/main/java/org/cytoscape/session/events/SessionAboutToBeSavedEvent.java
core3/api/trunk/session-api/src/main/java/org/cytoscape/session/events/SessionLoadedEvent.java
Log:
Fixed Javadoc.
Modified:
core3/api/trunk/session-api/src/main/java/org/cytoscape/session/events/SessionAboutToBeSavedEvent.java
===================================================================
---
core3/api/trunk/session-api/src/main/java/org/cytoscape/session/events/SessionAboutToBeSavedEvent.java
2011-10-07 21:25:26 UTC (rev 27091)
+++
core3/api/trunk/session-api/src/main/java/org/cytoscape/session/events/SessionAboutToBeSavedEvent.java
2011-10-07 21:28:05 UTC (rev 27092)
@@ -15,7 +15,7 @@
/**
* This event is fired synchronously by the CySessionManager at beginning of
the
- * {@link CySessionManager#getCySession()} method. The intent is to allow
+ * {@link CySessionManager#getCurrentSession()} method. The intent is to allow
* listeners to provide information to this event object or to update their
* state before that state is interrogated by the CySessionManager.
*/
@@ -42,6 +42,7 @@
* stored in the session.
* @param pluginName The name of the plugin that these files should be
stored for.
* @param files The list of File objects to be stored in the session
file.
+ * @throws Exception
*/
public void addPluginFiles(final String pluginName, final List<File>
files) throws Exception {
// Throw checked Exceptions here to force plugin authors to
deal with
@@ -107,6 +108,7 @@
* A method that allows plugins to add Cytopanel-related information to
be
* stored in the session.
* @param cytopanel
+ * @throws Exception #ASKMIKE Shouldn't this be nullptrexcept?
*/
public void addCytopanel(Cytopanel cytopanel) throws Exception {
if (cytopanel == null)
Modified:
core3/api/trunk/session-api/src/main/java/org/cytoscape/session/events/SessionLoadedEvent.java
===================================================================
---
core3/api/trunk/session-api/src/main/java/org/cytoscape/session/events/SessionLoadedEvent.java
2011-10-07 21:25:26 UTC (rev 27091)
+++
core3/api/trunk/session-api/src/main/java/org/cytoscape/session/events/SessionLoadedEvent.java
2011-10-07 21:28:05 UTC (rev 27092)
@@ -7,7 +7,7 @@
/**
* This event is fired after a new session has been set in the
- * {@link CySessionManager#setCurrentCySession(session,filename)}
+ * {@link CySessionManager#setCurrentSession(CySession, String)}
* method and is used to notify interested parties in the change
* of state.
*/
@@ -20,6 +20,7 @@
* Constructor.
* @param source The CySessionManager that is the source of this event.
* @param session The CySession object that was just loaded.
+ * @param fileName the name of the file representing the session.
*/
public SessionLoadedEvent(final CySessionManager source, final
CySession session, final String fileName) {
super(source,SessionLoadedListener.class);
--
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.
