You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by ma...@apache.org on 2018/12/19 16:11:30 UTC

svn commit: r1849310 - in /tomcat/trunk: java/org/apache/catalina/Context.java java/org/apache/catalina/core/StandardContext.java webapps/docs/changelog.xml

Author: markt
Date: Wed Dec 19 16:11:30 2018
New Revision: 1849310

URL: http://svn.apache.org/viewvc?rev=1849310&view=rev
Log:
Correct the Javadoc for Context.getDocBase() and Context.setDocBase() and remove text that indicates that a URL may be used for the docBase as this has not been the case for quite some time.

Modified:
    tomcat/trunk/java/org/apache/catalina/Context.java
    tomcat/trunk/java/org/apache/catalina/core/StandardContext.java
    tomcat/trunk/webapps/docs/changelog.xml

Modified: tomcat/trunk/java/org/apache/catalina/Context.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/Context.java?rev=1849310&r1=1849309&r2=1849310&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/Context.java (original)
+++ tomcat/trunk/java/org/apache/catalina/Context.java Wed Dec 19 16:11:30 2018
@@ -398,14 +398,16 @@ public interface Context extends Contain
     /**
      * Obtain the document root for this Context.
      *
-     * @return An absolute pathname, a relative pathname, or a URL.
+     * @return An absolute pathname or a relative (to the Host's appBase)
+     *         pathname.
      */
     public String getDocBase();
 
 
     /**
-     * Set the document root for this Context.  This can be an absolute
-     * pathname, a relative pathname, or a URL.
+     * Set the document root for this Context. This can be either an absolute
+     * pathname or a relative pathname. Relative pathnames are relative to the
+     * containing Host's appBase.
      *
      * @param docBase The new document root
      */

Modified: tomcat/trunk/java/org/apache/catalina/core/StandardContext.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/core/StandardContext.java?rev=1849310&r1=1849309&r2=1849310&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/core/StandardContext.java (original)
+++ tomcat/trunk/java/org/apache/catalina/core/StandardContext.java Wed Dec 19 16:11:30 2018
@@ -1754,27 +1754,18 @@ public class StandardContext extends Con
     }
 
 
-    /**
-     * @return the document root for this Context.  This can be an absolute
-     * pathname, a relative pathname, or a URL.
-     */
     @Override
     public String getDocBase() {
         return this.docBase;
     }
 
 
-    /**
-     * Set the document root for this Context.  This can be an absolute
-     * pathname, a relative pathname, or a URL.
-     *
-     * @param docBase The new document root
-     */
     @Override
     public void setDocBase(String docBase) {
         this.docBase = docBase;
     }
 
+
     public String getJ2EEApplication() {
         return j2EEApplication;
     }

Modified: tomcat/trunk/webapps/docs/changelog.xml
URL: http://svn.apache.org/viewvc/tomcat/trunk/webapps/docs/changelog.xml?rev=1849310&r1=1849309&r2=1849310&view=diff
==============================================================================
--- tomcat/trunk/webapps/docs/changelog.xml (original)
+++ tomcat/trunk/webapps/docs/changelog.xml Wed Dec 19 16:11:30 2018
@@ -66,6 +66,12 @@
         consistent with the requirements of asynchronous I/O and that all of the
         write methods use a single write rather than multiple writes. (markt)
       </fix>
+      <fix>
+        Correct the Javadoc for <code>Context.getDocBase()</code> and
+        <code>Context.setDocBase()</code> and remove text that indicates that a
+        URL may be used for the <code>docBase</code> as this has not been the
+        case for quite some time. (markt)
+      </fix>
     </changelog>
   </subsection>
   <subsection name="Coyote">



---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org