svn commit: r618790 - /myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/webapp/StartupServletContextListener.java

[sk...@apache.org]

Author: skitching
Date: Tue Feb  5 13:52:58 2008
New Revision: 618790

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

Modified:
    myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/webapp/StartupServletContextListener.java

Modified: myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/webapp/StartupServletContextListener.java
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/webapp/StartupServletContextListener.java?rev=618790&r1=618789&r2=618790&view=diff
==============================================================================
--- myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/webapp/StartupServletContextListener.java (original)
+++ myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/webapp/StartupServletContextListener.java Tue Feb  5 13:52:58 2008
@@ -35,6 +35,20 @@
 import java.util.List;
 
 /**
+ * Initialise the MyFaces system.
+ * <p>
+ * This context listener is registered by the JSP TLD file for the standard
+ * JSF "f" components. Normally, servlet containers will automatically load
+ * and process .tld files at startup time, and therefore register and run
+ * this class automatically.
+ * <p>
+ * Some very old servlet containers do not do this correctly, so in those
+ * cases this listener may be registered manually in web.xml. Registering
+ * it twice (ie in both .tld and web.xml) will result in a harmless warning
+ * message being generated. Very old versions of MyFaces Core do not register
+ * the listener in the .tld file, so those also need a manual entry in web.xml.
+ * However all versions since at least 1.1.2 have this entry in the tld.
+ * 
  * @author Manfred Geiler (latest modification by $Author$)
  * @version $Revision$ $Date$
  */