svn commit: r671073 - /myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/renderkit/html/util/AddResource.java

[sk...@apache.org]

Author: skitching
Date: Tue Jun 24 01:51:25 2008
New Revision: 671073

URL: http://svn.apache.org/viewvc?rev=671073&view=rev
Log:
Add documentation only

Modified:
    myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/renderkit/html/util/AddResource.java

Modified: myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/renderkit/html/util/AddResource.java
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/renderkit/html/util/AddResource.java?rev=671073&r1=671072&r2=671073&view=diff
==============================================================================
--- myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/renderkit/html/util/AddResource.java (original)
+++ myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/renderkit/html/util/AddResource.java Tue Jun 24 01:51:25 2008
@@ -212,6 +212,18 @@
     public void addInlineScriptAtPosition(FacesContext context, ResourcePosition position,
             String inlineScript);
 
+    /**
+     * Return a URI that can be embedded into an HTML page.
+     * <p>
+     * When the browser GETs that url, the serveResource method of this class will
+     * be invoked that is expected to write the contents of the specified resource
+     * to the respose stream.
+     * <p>
+     * Parameter myfacesCustomComponent must be an instance of ResourceProvider,
+     * and have a default constructor. When the URL is fetched, an instance of
+     * this class is created and its methods invoked to retrieve info about the
+     * specified resource (including its content).
+     */
     public String getResourceUri(FacesContext context, Class myfacesCustomComponent,
             String resource, boolean withContextPath);