svn commit: r1058888 - /maven/doxia/doxia-sitetools/trunk/doxia-decoration-model/src/main/java/org/apache/maven/doxia/site/decoration/inheritance/URIPathDescriptor.java

[lt...@apache.org]

Author: ltheussl
Date: Fri Jan 14 08:23:31 2011
New Revision: 1058888

URL: http://svn.apache.org/viewvc?rev=1058888&view=rev
Log:
javadocs

Modified:
    maven/doxia/doxia-sitetools/trunk/doxia-decoration-model/src/main/java/org/apache/maven/doxia/site/decoration/inheritance/URIPathDescriptor.java

Modified: maven/doxia/doxia-sitetools/trunk/doxia-decoration-model/src/main/java/org/apache/maven/doxia/site/decoration/inheritance/URIPathDescriptor.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia-sitetools/trunk/doxia-decoration-model/src/main/java/org/apache/maven/doxia/site/decoration/inheritance/URIPathDescriptor.java?rev=1058888&r1=1058887&r2=1058888&view=diff
==============================================================================
--- maven/doxia/doxia-sitetools/trunk/doxia-decoration-model/src/main/java/org/apache/maven/doxia/site/decoration/inheritance/URIPathDescriptor.java (original)
+++ maven/doxia/doxia-sitetools/trunk/doxia-decoration-model/src/main/java/org/apache/maven/doxia/site/decoration/inheritance/URIPathDescriptor.java Fri Jan 14 08:23:31 2011
@@ -154,13 +154,16 @@ public class URIPathDescriptor
     /**
      * Calculate the link as viewed from a different base.
      * This returns the original link if link is absolute.
-     * This returns {@link #resolveLink()} if
-     *      newBase == null
-     *      or newBase is not parsable as a URI.
+     * This returns {@link #resolveLink()} if either
+     *      newBase == null,
+     *      or newBase is not parsable as a URI,
+     *      or newBase and this {@link #getBaseURI()} do not share the
+     *      {@link #sameSite(java.net.URI) same site}.
      *
      * @param newBase the new base URI. Has to be parsable as a URI.
      *.
-     * @return a new relative link.
+     * @return a new relative link or the original link {@link #resolveLink() resolved},
+     * i.e. as an absolute link, if the link cannot be re-based.
      */
     public URI rebaseLink( final String newBase )
     {