Pulled changesets from branches/4.0.0-SRIT into trunk, done by

mohamed.atique@renaissance-it.com. All changes are related to javadocs only.
Merge was done beetween revisions 924:1192.



svn changeset:1212/svn branch:trunk

1 files changed, 32 insertions, 15 deletions

diff --git a/src/com/itmill/toolkit/terminal/ApplicationResource.java b/src/com/itmill/toolkit/terminal/ApplicationResource.java
index 2307b1e58f..22f286ef66 100644
--- a/src/com/itmill/toolkit/terminal/ApplicationResource.java
+++ b/src/com/itmill/toolkit/terminal/ApplicationResource.java
@@ -30,46 +30,63 @@ package com.itmill.toolkit.terminal;
 
 import com.itmill.toolkit.Application;
 
-/** This interface must be implemented by classes wishing to provide Application resources.
- * 
- * Application resources are a set of named resources (pictures, sounds, etc) associated
+/** 
+ * This interface must be implemented by classes wishing to provide Application resources.
+ * <p>
+ * <code>ApplicationResource</code> are a set of named resources (pictures, sounds, etc) associated
  * with some specific application. Having named application resources provides a convenient 
  * method for having inter-theme common resources for an application.
- * 
+ * </p>
  * @author IT Mill Ltd.
  * @version @VERSION@
  * @since 3.0
  */
 public interface ApplicationResource extends Resource {
 
-	/** Default cache time. */
+	/** 
+	 * Default cache time. 
+	 */
 	public static final long DEFAULT_CACHETIME = 1000*60*60*24;
 
-	/** Get resource as stream */
+	/** 
+	 * Gets resource as stream. 
+	 */
 	public DownloadStream getStream();
 		
-	/** Get the application of the resource */
+	/** 
+	 * Gets the application of the resource. 
+	 */
 	public Application getApplication();
 
-	/** Get virtual filename for the resource */
+	/** 
+	 * Gets the virtual filename for this resource. 
+	 * @return the file name associated to this resource.
+	 */
 	public String getFilename();
 	
-	/** Get lenght of cache expiration time.
+	/** 
+	 * Gets the length of cache expiration time.
 	 * 
-	 * <p>This gives the adapter the possibility cache streams sent to the 
+	 * <p>
+	 * This gives the adapter the possibility cache streams sent to the 
 	 * client. The caching may be made in adapter or at the client if the 
-	 * client supports caching. Default is DEFAULT_CACHETIME.</p>
+	 * client supports caching. Default is <code>DEFAULT_CACHETIME</code>.
+	 * </p>
 	 * 
 	 * @return Cache time in milliseconds
 	 */
 	public long getCacheTime();
 
-	/** Get the size of the download buffer used for this resource.
+	/** 
+	 * Gets the size of the download buffer used for this resource.
 	 * 
-	 * <p>If the buffer size is 0, the buffer size is decided by the 
-	 * terminal adapter. The default value is 0.</p>
+	 * <p>
+	 * If the buffer size is 0, the buffer size is decided by the 
+	 * terminal adapter. The default value is 0.
+	 * </p>
 	 * 
-	 * @return int The size of the buffer in bytes.
+	 * @return int 
+	 * 			the size of the buffer in bytes.
 	 */
 	public int getBufferSize();