cvs commit: cocoon-2.1/src/java/org/apache/cocoon/components/modules/input XMLFileModule.java

[jefft]

jefft       2003/03/12 07:04:38

  Modified:    src/java/org/apache/cocoon/components/modules/input
                        XMLFileModule.java
  Log:
  A more user-oriented Javadoc comment
  
  Revision  Changes    Path
  1.2       +8 -6      
cocoon-2.1/src/java/org/apache/cocoon/components/modules/input/XMLFileModule.java
  
  Index: XMLFileModule.java
  ===================================================================
  RCS file: 
/home/cvs/cocoon-2.1/src/java/org/apache/cocoon/components/modules/input/XMLFileModule.java,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- XMLFileModule.java        9 Mar 2003 00:09:04 -0000       1.1
  +++ XMLFileModule.java        12 Mar 2003 15:04:38 -0000      1.2
  @@ -69,12 +69,14 @@
   import java.util.Map;
   
   /**
  - * This module reads an XML file from any source available to the
  - * system, parses it and returns a Document. Parts can be accessed
  - * using XPath syntax. Sources can be held in memory for better
  - * perfomance and reloaded if changed.
  + * This module provides an Input Module interface to any XML document, by using
  + * XPath expressions as attribute keys.
  + * The XML can be obtained from any Cocoon <code>Source</code> (e.g.,
  + * <code>cocoon:/...</code>, <code>context://..</code>, and regular URLs).
  + * Sources can be held in memory for better performance and reloaded if
  + * changed.
    *
  - * <p> Caching and reloading can be turned on / off (default: on)
  + * <p>Caching and reloading can be turned on / off (default: on)
    * through <code>&lt;reloadable&gt;false&lt;/reloadable&gt;</code> and
    * <code>&lt;cachable&gt;false&lt;/cachable&gt;</code>. The file
    * (source) to use is specified through <code>&lt;file