cvs commit: xml-xalan/java/src/org/apache/xalan/utils NodeConsumer.java PrefixResolver.java

[sb...@locus.apache.org]

sboag       00/11/22 15:38:40

  Modified:    java/src/org/apache/xalan/utils NodeConsumer.java
                        PrefixResolver.java
  Log:
  Javadoc update.  Some of these files got wacked by JBuilder's
  trimming of trailing spaces (which I didn't realize was on), so if
  you need to do diffs, you should use a diff problem that can turn
  off comparisons based on trailing spaces.
  
  Revision  Changes    Path
  1.3       +5 -5      xml-xalan/java/src/org/apache/xalan/utils/NodeConsumer.java
  
  Index: NodeConsumer.java
  ===================================================================
  RCS file: /home/cvs/xml-xalan/java/src/org/apache/xalan/utils/NodeConsumer.java,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- NodeConsumer.java	2000/10/30 18:57:19	1.2
  +++ NodeConsumer.java	2000/11/22 23:38:39	1.3
  @@ -2,7 +2,7 @@
    * The Apache Software License, Version 1.1
    *
    *
  - * Copyright (c) 1999 The Apache Software Foundation.  All rights 
  + * Copyright (c) 1999 The Apache Software Foundation.  All rights
    * reserved.
    *
    * Redistribution and use in source and binary forms, with or without
  @@ -10,7 +10,7 @@
    * are met:
    *
    * 1. Redistributions of source code must retain the above copyright
  - *    notice, this list of conditions and the following disclaimer. 
  + *    notice, this list of conditions and the following disclaimer.
    *
    * 2. Redistributions in binary form must reproduce the above copyright
    *    notice, this list of conditions and the following disclaimer in
  @@ -18,7 +18,7 @@
    *    distribution.
    *
    * 3. The end-user documentation included with the redistribution,
  - *    if any, must include the following acknowledgment:  
  + *    if any, must include the following acknowledgment:
    *       "This product includes software developed by the
    *        Apache Software Foundation (http://www.apache.org/)."
    *    Alternately, this acknowledgment may appear in the software itself,
  @@ -26,7 +26,7 @@
    *
    * 4. The names "Xalan" and "Apache Software Foundation" must
    *    not be used to endorse or promote products derived from this
  - *    software without prior written permission. For written 
  + *    software without prior written permission. For written
    *    permission, please contact apache@apache.org.
    *
    * 5. Products derived from this software may not be called "Apache",
  @@ -70,7 +70,7 @@
     /**
      * Set the node that is originating the SAX event.
      *
  -   * NEEDSDOC @param n
  +   * @param n Reference to node that originated the current event.
      */
     public void setOriginatingNode(Node n);
   }
  
  
  
  1.4       +10 -7     xml-xalan/java/src/org/apache/xalan/utils/PrefixResolver.java
  
  Index: PrefixResolver.java
  ===================================================================
  RCS file: /home/cvs/xml-xalan/java/src/org/apache/xalan/utils/PrefixResolver.java,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- PrefixResolver.java	2000/10/30 18:57:20	1.3
  +++ PrefixResolver.java	2000/11/22 23:38:39	1.4
  @@ -69,26 +69,29 @@
      * the PrevixResolver hold's it's own namespace context, or is a namespace
      * context itself.
      *
  -   * NEEDSDOC @param prefix
  +   * @param prefix The prefix to look up, which may be an empty string ("") for the default Namespace.
      *
  -   * NEEDSDOC ($objectName$) @return
  +   * @return The associated Namespace URI, or null if the prefix
  +   *         is undeclared in this context.
      */
     String getNamespaceForPrefix(String prefix);
   
     /**
  -   * Given a namespace, get the corrisponding prefix.
  +   * Given a namespace, get the corrisponding prefix, based on the node context.
      *
  -   * NEEDSDOC @param prefix
  -   * NEEDSDOC @param context
  +   * @param prefix The prefix to look up, which may be an empty string ("") for the default Namespace.
  +   * @param context The node context from which to look up the URI.
      *
  -   * NEEDSDOC ($objectName$) @return
  +   * @return The associated Namespace URI, or null if the prefix
  +   *         is undeclared in this context.
      */
     String getNamespaceForPrefix(String prefix, org.w3c.dom.Node context);
   
     /**
      * Return the base identifier.
      *
  -   * NEEDSDOC ($objectName$) @return
  +   * @return The base identifier from where relative URIs should be absolutized, or null 
  +   * if the base ID is unknown.
      */
     public String getBaseIdentifier();
   }