svn commit: r505508 - in /myfaces/tobago/trunk: contrib/fileupload/src/main/java/org/apache/myfaces/tobago/fileupload/FileUploadFacesContextFactoryImpl.java src/site/fml/faq.fml

[bo...@apache.org]

Author: bommel
Date: Fri Feb  9 13:29:28 2007
New Revision: 505508

URL: http://svn.apache.org/viewvc?view=rev&rev=505508
Log:
added javadoc description for fileupload.jar

Modified:
    myfaces/tobago/trunk/contrib/fileupload/src/main/java/org/apache/myfaces/tobago/fileupload/FileUploadFacesContextFactoryImpl.java
    myfaces/tobago/trunk/src/site/fml/faq.fml

Modified: myfaces/tobago/trunk/contrib/fileupload/src/main/java/org/apache/myfaces/tobago/fileupload/FileUploadFacesContextFactoryImpl.java
URL: http://svn.apache.org/viewvc/myfaces/tobago/trunk/contrib/fileupload/src/main/java/org/apache/myfaces/tobago/fileupload/FileUploadFacesContextFactoryImpl.java?view=diff&rev=505508&r1=505507&r2=505508
==============================================================================
--- myfaces/tobago/trunk/contrib/fileupload/src/main/java/org/apache/myfaces/tobago/fileupload/FileUploadFacesContextFactoryImpl.java (original)
+++ myfaces/tobago/trunk/contrib/fileupload/src/main/java/org/apache/myfaces/tobago/fileupload/FileUploadFacesContextFactoryImpl.java Fri Feb  9 13:29:28 2007
@@ -32,11 +32,32 @@
 import javax.naming.NamingException;
 import java.io.File;
 
-/*
- * Created by IntelliJ IDEA.
- * User: bommel
- * Date: Oct 8, 2006
- * Time: 4:45:47 PM
+/**
+ * This FacesContextFactory handles multipart request. Add the tobago-fileupload.jar to your web application.
+ * Configuration:
+ *
+ * <p><blockquote><pre>
+    &lt;env-entry&gt;
+      &lt;description&gt;Set the size limit for uploaded files. Default value is 1 MB.
+        Format: 10 = 10 bytes
+        10k = 10 KB
+        10m = 10 MB
+        1g = 1 GB
+      &lt;/description&gt;
+      &lt;env-entry-name&gt;uploadMaxFileSize&lt;/env-entry-name&gt;
+      &lt;env-entry-type&gt;java.lang.String&lt;/env-entry-type&gt;
+      &lt;env-entry-value&gt;20m&lt;/env-entry-value&gt;
+    &lt;/env-entry&gt;
+    &lt;env-entry&gt;
+      &lt;description&gt;Set the upload repository path for uploaded files.
+             Default value is java.io.tmpdir.&lt;/description&gt;
+      &lt;env-entry-name&gt;uploadRepositoryPath&lt;/env-entry-name&gt;
+      &lt;env-entry-type&gt;java.lang.String&lt;/env-entry-type&gt;
+      &lt;env-entry-value&gt;/tmp&lt;/env-entry-value&gt;
+    &lt;/env-entry&gt;
+ </pre></blockquote><p>
+
+ *
  */
 public class FileUploadFacesContextFactoryImpl extends FacesContextFactory {
   private static final Log LOG = LogFactory.getLog(FileUploadFacesContextFactoryImpl.class);

Modified: myfaces/tobago/trunk/src/site/fml/faq.fml
URL: http://svn.apache.org/viewvc/myfaces/tobago/trunk/src/site/fml/faq.fml?view=diff&rev=505508&r1=505507&r2=505508
==============================================================================
--- myfaces/tobago/trunk/src/site/fml/faq.fml (original)
+++ myfaces/tobago/trunk/src/site/fml/faq.fml Fri Feb  9 13:29:28 2007
@@ -92,11 +92,13 @@
       <answer>
         <p>You have two options.</p>
         <p>Add a TobagoMultipartFormdataFilter to your web.xml.
-        <a href="http://myfaces.apache.org/tobago/apidocs/org/apache/myfaces/tobago/webapp/TobagoMultipartFormdataFilter.html">Javadoc Description</a> 
+          <a href="http://myfaces.apache.org/tobago/apidocs/org/apache/myfaces/tobago/webapp/TobagoMultipartFormdataFilter.html">Javadoc Description</a>
         </p>
         <p>Add the tobago-fileupload.jar to your project.
            The tobago-fileupload.jar contains a FacesContextFactory that wraps the
-            multipart-formdata request inside the FacesContext.</p>
+            multipart-formdata request inside the FacesContext.
+          <a href="http://myfaces.apache.org/tobago/apidocs/org/apache/myfaces/tobago/fileupload/FileUploadFacesContextFactoryImpl.html">Javadoc Description</a>
+        </p>
       </answer>
     </faq>