Author: veithen
Date: Fri Dec 16 19:29:46 2011
New Revision: 1215246
URL: http://svn.apache.org/viewvc?rev=1215246&view=rev
Log:
Resolved some TODO items related to Javadoc.
Modified:
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/attachments/AttachmentCacheMonitor.java
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/attachments/PartContentOnFile.java
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/attachments/impl/BufferUtils.java
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/attachments/lifecycle/LifecycleManager.java
Modified:
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/attachments/AttachmentCacheMonitor.java
URL:
http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/attachments/AttachmentCacheMonitor.java?rev=1215246&r1=1215245&r2=1215246&view=diff
==============================================================================
---
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/attachments/AttachmentCacheMonitor.java
(original)
+++
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/attachments/AttachmentCacheMonitor.java
Fri Dec 16 19:29:46 2011
@@ -69,7 +69,7 @@ public final class AttachmentCacheMonito
/**
* Get or Create an AttachmentCacheMonitor singleton
- * @return TODO
+ * @return the singleton instance
*/
public static synchronized AttachmentCacheMonitor
getAttachmentCacheMonitor() {
if (_singleton == null) {
Modified:
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/attachments/PartContentOnFile.java
URL:
http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/attachments/PartContentOnFile.java?rev=1215246&r1=1215245&r2=1215246&view=diff
==============================================================================
---
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/attachments/PartContentOnFile.java
(original)
+++
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/attachments/PartContentOnFile.java
Fri Dec 16 19:29:46 2011
@@ -41,10 +41,16 @@ class PartContentOnFile extends PartCont
/**
* Constructor.
*
- * @param manager TODO
- * @param in1 InputStream containing data
- * @param in2 InputStream containing data
- * @param attachmentDir String
+ * @param manager
+ * the lifecycle manager that will be used for managing
temporary files created by
+ * this instance
+ * @param in1
+ * InputStream containing data
+ * @param in2
+ * InputStream containing data
+ * @param attachmentDir
+ * the file system location where temporary files are created;
this value will be
+ * used in calls to {@link LifecycleManager#create(String)}
*/
PartContentOnFile(LifecycleManager manager, InputStream is1, InputStream
is2, String attachmentDir) throws IOException {
this.manager = manager;
Modified:
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/attachments/impl/BufferUtils.java
URL:
http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/attachments/impl/BufferUtils.java?rev=1215246&r1=1215245&r2=1215246&view=diff
==============================================================================
---
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/attachments/impl/BufferUtils.java
(original)
+++
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/attachments/impl/BufferUtils.java
Fri Dec 16 19:29:46 2011
@@ -195,7 +195,7 @@ public class BufferUtils {
* @param is
* @param baaos
* @param limit
- * @return TODO
+ * @return the number of bytes copied
*/
public static long inputStream2BAAOutputStream(InputStream is,
BAAOutputStream baaos,
Modified:
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/attachments/lifecycle/LifecycleManager.java
URL:
http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/attachments/lifecycle/LifecycleManager.java?rev=1215246&r1=1215245&r2=1215246&view=diff
==============================================================================
---
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/attachments/lifecycle/LifecycleManager.java
(original)
+++
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/attachments/lifecycle/LifecycleManager.java
Fri Dec 16 19:29:46 2011
@@ -39,7 +39,7 @@ public interface LifecycleManager {
/**
* Create a unique file in the designated directory
* @param attachmentDir
- * @return TODO
+ * @return the {@link FileAccessor} for the file created by this method
* @throws IOException
*/
public FileAccessor create(String attachmentDir) throws IOException;
@@ -70,7 +70,7 @@ public interface LifecycleManager {
/**
* This method will return the file accessor associated with this file.
* @param file
- * @return TODO
+ * @return the {@link FileAccessor} object for the given file
* @throws IOException
*/
public FileAccessor getFileAccessor(String file) throws IOException;
