svn commit: r502602 - /cocoon/trunk/blocks/cocoon-auth/cocoon-auth-api/src/main/java/org/apache/cocoon/auth/ApplicationUtil.java

[cz...@apache.org]

Author: cziegeler
Date: Fri Feb  2 05:25:17 2007
New Revision: 502602

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

Modified:
    cocoon/trunk/blocks/cocoon-auth/cocoon-auth-api/src/main/java/org/apache/cocoon/auth/ApplicationUtil.java

Modified: cocoon/trunk/blocks/cocoon-auth/cocoon-auth-api/src/main/java/org/apache/cocoon/auth/ApplicationUtil.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/blocks/cocoon-auth/cocoon-auth-api/src/main/java/org/apache/cocoon/auth/ApplicationUtil.java?view=diff&rev=502602&r1=502601&r2=502602
==============================================================================
--- cocoon/trunk/blocks/cocoon-auth/cocoon-auth-api/src/main/java/org/apache/cocoon/auth/ApplicationUtil.java (original)
+++ cocoon/trunk/blocks/cocoon-auth/cocoon-auth-api/src/main/java/org/apache/cocoon/auth/ApplicationUtil.java Fri Feb  2 05:25:17 2007
@@ -26,8 +26,13 @@
 import org.apache.cocoon.spring.configurator.WebAppContextUtils;
 
 /**
- * Utility class that can be used from flow to access the different
+ * Utility class that can be used from flow script to access the different
  * application functions of Cocoon Authentication.
+ * The easiest way to use this class in flow script is to create an instance
+ * using cocoon.createObject():
+ * var util = cocoon.createObject("org.apache.cocoon.auth.ApplicationUtil");
+ * and then you can invoke one of the instance methods like
+ * var user = util.getUser();
  *
  * @version $Id$
  */