cocoon-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From je...@apache.org
Subject cvs commit: xml-cocoon2/src/java/org/apache/cocoon/xml/dom DocumentWrapper.java
Date Fri, 28 Feb 2003 15:26:04 GMT
jefft       2003/02/28 07:26:03

  Modified:    src/java/org/apache/cocoon Constants.java
               src/java/org/apache/cocoon/components/modules/input
                        XMLFormInput.java
               src/java/org/apache/cocoon/components/source SourceUtil.java
               src/java/org/apache/cocoon/components/source/impl
                        ContextSourceFactory.java
               src/java/org/apache/cocoon/xml/dom DocumentWrapper.java
  Log:
  Fix up Javadocs
  
  Revision  Changes    Path
  1.22      +2 -2      xml-cocoon2/src/java/org/apache/cocoon/Constants.java
  
  Index: Constants.java
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/src/java/org/apache/cocoon/Constants.java,v
  retrieving revision 1.21
  retrieving revision 1.22
  diff -u -r1.21 -r1.22
  --- Constants.java	26 Feb 2003 09:11:18 -0000	1.21
  +++ Constants.java	28 Feb 2003 15:26:02 -0000	1.22
  @@ -250,7 +250,7 @@
        * This constant is also defined in the org.apache.cocoon.environment.ObjectModelHelper
class.
        *
        * FIXME(GP): Shouldn't this definition here be removed?
  -     * @deprecated Use the {@link org.apache.cocoon.environment.ObjectModelHelper#getRequest(java.util.Map))}
instead.
  +     * @deprecated Use the {@link org.apache.cocoon.environment.ObjectModelHelper#getRequest(java.util.Map)}
instead.
        */
       public static final String REQUEST_OBJECT  = org.apache.cocoon.environment.ObjectModelHelper.REQUEST_OBJECT;
   
  
  
  
  1.5       +2 -2      xml-cocoon2/src/java/org/apache/cocoon/components/modules/input/XMLFormInput.java
  
  Index: XMLFormInput.java
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/src/java/org/apache/cocoon/components/modules/input/XMLFormInput.java,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- XMLFormInput.java	31 Jan 2003 22:51:28 -0000	1.4
  +++ XMLFormInput.java	28 Feb 2003 15:26:02 -0000	1.5
  @@ -63,7 +63,7 @@
    * The xmlform-id needs to be passed with the configuration. Additionally supports 
    * all configuration options from {@link AbstractJXPathModule AbstractJXPathModule}.
    * This can be used for example to let the 
  - * {@link org.apache.cocoon.acting.modular.DatabaseAction database actions} access 
  + * <code>org.apache.cocoon.acting.modular.DatabaseAction</code> access 
    * form data.
    * 
    * <p>Configuration example:</p>
  
  
  
  1.25      +24 -15    xml-cocoon2/src/java/org/apache/cocoon/components/source/SourceUtil.java
  
  Index: SourceUtil.java
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/src/java/org/apache/cocoon/components/source/SourceUtil.java,v
  retrieving revision 1.24
  retrieving revision 1.25
  diff -u -r1.24 -r1.25
  --- SourceUtil.java	28 Feb 2003 14:07:16 -0000	1.24
  +++ SourceUtil.java	28 Feb 2003 15:26:02 -0000	1.25
  @@ -280,9 +280,11 @@
       /**
        * Get a <code>Source</code> object
        *
  -     * @param uri Uri of the source.
  -     * @param typeParameters
  -     * @param resourceParameters Parameters of the source.
  +     * @param uri URI of the source.
  +     * @param typeParameters Type of Source query.  Currently, only
  +     * <code>method</code> parameter (value typically <code>GET</code>
or
  +     * <code>POST</code>) is recognized.  May be <code>null</code>.
  +     * @param resourceParameters Parameters of the source.  May be <code>null</code>
        * @param resolver Resolver for the source.
        *
        * @return The resolved source.
  @@ -341,6 +343,7 @@
               int pos = uri.indexOf(";jsessionid=");
   
               if (uri.startsWith("cocoon:")==false) {
  +                // It looks like this block is never called (JT)
                   if (pos!=-1) {
                       uri = uri.substring(0, pos);
                   }
  @@ -374,11 +377,14 @@
        * If not, the source is invoked with an additional parameter named
        * "content" containing the XML.
        *
  -     * @param location
  -     * @param typeParameters
  -     * @param parameters
  -     * @param frag
  -     * @param resolver
  +     * @param location URI of the Source
  +     * @param typeParameters Type of Source query.  Currently, only
  +     * <code>method</code> parameter (value typically <code>GET</code>
or
  +     * <code>POST</code>) is recognized.  May be <code>null</code>.
  +     * @param resourceParameters Parameters (e.g. URL params) of the source.
  +     * May be <code>null</code>
  +     * @param frag DOM fragment to serialize to the Source
  +     * @param resolver Resolver for the source.
        * @param serializerName
        * @param manager
        *
  @@ -493,13 +499,16 @@
       /**
        * Read a DOM Fragment from a source
        *
  -     * @param location
  -     * @param typeParameters
  -     * @param parameters
  -     * @param resolver
  -     * @param manager
  +     * @param location URI of the Source
  +     * @param typeParameters Type of Source query.  Currently, only
  +     * <code>method</code> parameter (value typically <code>GET</code>
or
  +     * <code>POST</code>) is recognized.  May be <code>null</code>.
  +     * @param parameters Parameters (e.g. URL params) of the source.
  +     * May be <code>null</code>
  +     * @param resolver Resolver for the source.
        *
  -     * @return
  +     * @return DOM <code>DocumentFragment</code> constructed from the specified
  +     * Source
        *
        * @throws ProcessingException
        */
  
  
  
  1.13      +2 -2      xml-cocoon2/src/java/org/apache/cocoon/components/source/impl/ContextSourceFactory.java
  
  Index: ContextSourceFactory.java
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/src/java/org/apache/cocoon/components/source/impl/ContextSourceFactory.java,v
  retrieving revision 1.12
  retrieving revision 1.13
  diff -u -r1.12 -r1.13
  --- ContextSourceFactory.java	31 Jan 2003 22:51:34 -0000	1.12
  +++ ContextSourceFactory.java	28 Feb 2003 15:26:02 -0000	1.13
  @@ -73,7 +73,7 @@
   /**
    * A factory for the context protocol using the context of the servlet api. It builds the
    * source by asking the environment context for the real URL
  - * ({@see org.apache.cocoon.environment.Context#getResource(String)}) and then resolving
this real URL.
  + * (see {@link org.apache.cocoon.environment.Context#getResource(String)}) and then resolving
this real URL.
    *
    * @author <a href="mailto:cziegeler@apache.org">Carsten Ziegeler</a>
    * @author <a href="http://www.apache.org/~sylvain">Sylvain Wallez</a>
  
  
  
  1.6       +3 -3      xml-cocoon2/src/java/org/apache/cocoon/xml/dom/DocumentWrapper.java
  
  Index: DocumentWrapper.java
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/src/java/org/apache/cocoon/xml/dom/DocumentWrapper.java,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- DocumentWrapper.java	26 Feb 2003 13:58:04 -0000	1.5
  +++ DocumentWrapper.java	28 Feb 2003 15:26:02 -0000	1.6
  @@ -580,7 +580,7 @@
        * this node is a <code>Document</code> or a <code>DocumentType</code>
        * which is not used with any <code>Document</code> yet, this is
        * <code>null</code>.
  -     * @version DOM Level 2
  +     * @since DOM Level 2
        *
        */
       public Document getOwnerDocument() {
  @@ -822,7 +822,7 @@
        * <code>CDATASections</code>, the normalize operation alone may not be
        * sufficient, since XPointers do not differentiate between
        * <code>Text</code> nodes and <code>CDATASection</code> nodes.
  -     * @version DOM Level 2
  +     * @since DOM Level 2
        *
        */
       public void normalize() {
  
  
  

Mime
View raw message