Author: mkirby
Date: 2011-10-07 14:19:27 -0700 (Fri, 07 Oct 2011)
New Revision: 27087
Modified:
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/BasicCyFileFilter.java
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/CyFileFilterProvider.java
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/util/RecentlyOpenedTracker.java
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/util/StreamUtil.java
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/AbstractCyWriter.java
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/VizmapWriterFactory.java
Log:
Fixed Javadoc.
Modified:
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/BasicCyFileFilter.java
===================================================================
---
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/BasicCyFileFilter.java
2011-10-07 21:02:47 UTC (rev 27086)
+++
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/BasicCyFileFilter.java
2011-10-07 21:19:27 UTC (rev 27087)
@@ -192,6 +192,7 @@
/**
* Returns a string containing the specified number of lines from the
* beginning of the file. This is useful for testing input streams.
+ * @param numLines the number of lines from the beginning of the file.
* @return a string containing the specified number of lines from the
* beginning of the file.
*/
Modified:
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/CyFileFilterProvider.java
===================================================================
---
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/CyFileFilterProvider.java
2011-10-07 21:02:47 UTC (rev 27086)
+++
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/CyFileFilterProvider.java
2011-10-07 21:19:27 UTC (rev 27087)
@@ -7,7 +7,8 @@
*/
public interface CyFileFilterProvider {
/**
- * Return the file filter associated with the IOFactory
+ * Return the file filter associated with the IOFactory.
+ * @return the {@link CyFileFilter} associated with the IOFactory.
*/
CyFileFilter getCyFileFilter();
Modified:
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/util/RecentlyOpenedTracker.java
===================================================================
---
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/util/RecentlyOpenedTracker.java
2011-10-07 21:02:47 UTC (rev 27086)
+++
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/util/RecentlyOpenedTracker.java
2011-10-07 21:19:27 UTC (rev 27087)
@@ -19,7 +19,8 @@
/**
- * @returns the current list of recently opened file names
+ * Returns the current list of recently opened file names.
+ * @return the current list of recently opened file names
*/
List<URL> getRecentlyOpenedURLs();
@@ -27,6 +28,7 @@
/**
* Adds "newURL" to the list of recently opened file names and trims the
* list if it has exceeded its maximum length.
+ * @param newURL the URL to add to the list of recently opened file
names.
*/
void add(final URL newURL);
@@ -34,6 +36,7 @@
/**
* Writes the list of recently opened files to the file specified by the
* constructor argument.
+ * @throws FileNotFoundException
*/
void writeOut() throws FileNotFoundException;
Modified:
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/util/StreamUtil.java
===================================================================
--- core3/api/trunk/io-api/src/main/java/org/cytoscape/io/util/StreamUtil.java
2011-10-07 21:02:47 UTC (rev 27086)
+++ core3/api/trunk/io-api/src/main/java/org/cytoscape/io/util/StreamUtil.java
2011-10-07 21:19:27 UTC (rev 27087)
@@ -30,7 +30,7 @@
InputStream getBasicInputStream(URL source) throws IOException;
/**
- * Obtain a {@link java.net.URLConnectio} for a given {@link
java.net.URL}.
+ * Obtain a {@link java.net.URLConnection} for a given {@link
java.net.URL}.
* @param source The URL from which to generate the URLConnection.
* @return An URLConnection from the specified URL.
*/
Modified:
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/AbstractCyWriter.java
===================================================================
---
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/AbstractCyWriter.java
2011-10-07 21:02:47 UTC (rev 27086)
+++
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/AbstractCyWriter.java
2011-10-07 21:19:27 UTC (rev 27087)
@@ -25,6 +25,7 @@
public abstract class AbstractCyWriter<T extends CyWriterManager> extends
AbstractTask
implements CyWriter
{
+ /** The file to be written. */
protected File outputFile;
/**
@@ -101,6 +102,7 @@
* Should return a {@link org.cytoscape.io.write.CyWriter} object for
writing the specified file of the specified type.
* @param filter The specific type of file to be written.
* @param out The file that will be written.
+ * @return a {@link org.cytoscape.io.write.CyWriter} object for writing
the specified file of the specified type.
*/
protected abstract CyWriter getWriter(CyFileFilter filter, File out)
throws Exception;
Modified:
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/VizmapWriterFactory.java
===================================================================
---
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/VizmapWriterFactory.java
2011-10-07 21:02:47 UTC (rev 27086)
+++
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/VizmapWriterFactory.java
2011-10-07 21:19:27 UTC (rev 27087)
@@ -40,7 +40,7 @@
/**
- * A specialization of {@link CyWriterFactory} that allows a {@link
org.cytoscape.view.vizmap.model.Vizmap} to
+ * A specialization of {@link CyWriterFactory} that allows a {@link
org.cytoscape.view.vizmap.VisualStyle} to
* be specified and written.
*/
public interface VizmapWriterFactory extends CyWriterFactory {
--
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.
