svn commit: r1480249 - /maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/AbstractDeployMojo.java

[hb...@apache.org]

Author: hboutemy
Date: Wed May  8 12:29:46 2013
New Revision: 1480249

URL: http://svn.apache.org/r1480249
Log:
improved getRootSite() javadoc

Modified:
    maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/AbstractDeployMojo.java

Modified: maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/AbstractDeployMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/AbstractDeployMojo.java?rev=1480249&r1=1480248&r2=1480249&view=diff
==============================================================================
--- maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/AbstractDeployMojo.java (original)
+++ maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/AbstractDeployMojo.java Wed May  8 12:29:46 2013
@@ -805,12 +805,14 @@ public abstract class AbstractDeployMojo
     /**
      * Extract the distributionManagement site of the top level parent of the given MavenProject.
      * This climbs up the project hierarchy and returns the site of the last project
-     * for which {@link #getSite(org.apache.maven.project.MavenProject)} returns a site.
+     * for which {@link #getSite(org.apache.maven.project.MavenProject)} returns a site lives in the
+     * same site.
      *
-     * @param project the MavenProject. Not null.
-     * @return the top level site. Not null.
-     *         Also site.getUrl() and site.getId() are guaranteed to be not null.
+     * @param project the MavenProject. Not <code>null</code>.
+     * @return the top level site. Not <code>null</code>.
+     *         Also site.getUrl() and site.getId() are guaranteed to be not <code>null</code>.
      * @throws MojoExecutionException if no site info is found in the tree.
+     * @see URIPathDescriptor#sameSite(java.net.URI)
      */
     protected Site getRootSite( MavenProject project )
         throws MojoExecutionException