maven-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From hbout...@apache.org
Subject git commit: javadoc formatting
Date Sat, 15 Dec 2012 09:56:18 GMT
Updated Branches:
  refs/heads/master 866f2c58b -> 38e3de00c


javadoc formatting

Project: http://git-wip-us.apache.org/repos/asf/maven/repo
Commit: http://git-wip-us.apache.org/repos/asf/maven/commit/38e3de00
Tree: http://git-wip-us.apache.org/repos/asf/maven/tree/38e3de00
Diff: http://git-wip-us.apache.org/repos/asf/maven/diff/38e3de00

Branch: refs/heads/master
Commit: 38e3de00cbbf9ed969d61e5a2fbefd8d24642711
Parents: 866f2c5
Author: Hervé Boutemy <hboutemy@apache.org>
Authored: Sat Dec 15 10:56:15 2012 +0100
Committer: Hervé Boutemy <hboutemy@apache.org>
Committed: Sat Dec 15 10:56:15 2012 +0100

----------------------------------------------------------------------
 .../inheritance/DefaultInheritanceAssembler.java   |   17 +++++++++-----
 1 files changed, 11 insertions(+), 6 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/maven/blob/38e3de00/maven-model-builder/src/main/java/org/apache/maven/model/inheritance/DefaultInheritanceAssembler.java
----------------------------------------------------------------------
diff --git a/maven-model-builder/src/main/java/org/apache/maven/model/inheritance/DefaultInheritanceAssembler.java
b/maven-model-builder/src/main/java/org/apache/maven/model/inheritance/DefaultInheritanceAssembler.java
index a66be04..92f4405 100644
--- a/maven-model-builder/src/main/java/org/apache/maven/model/inheritance/DefaultInheritanceAssembler.java
+++ b/maven-model-builder/src/main/java/org/apache/maven/model/inheritance/DefaultInheritanceAssembler.java
@@ -58,12 +58,17 @@ public class DefaultInheritanceAssembler
 
     /**
      * Calculates the relative path from the base directory of the parent to the parent directory
of the base directory
-     * of the child. The general idea is to adjust inherited URLs to match the project layout
(in SCM). This calculation
-     * is only a heuristic based on our conventions. In detail, the algo relies on the following
assumptions. The parent
-     * uses aggregation and refers to the child via the modules section. The module path
to the child is considered to
-     * point at the POM rather than its base directory if the path ends with ".xml" (ignoring
case). The name of the
-     * child's base directory matches the artifact id of the child. Note that for the sake
of independence from the user
-     * environment, the filesystem is intentionally not used for the calculation.
+     * of the child. The general idea is to adjust inherited URLs to match the project layout
(in SCM).
+     * 
+     * <p>This calculation is only a heuristic based on our conventions.
+     * In detail, the algo relies on the following assumptions: <ul>
+     * <li>The parent uses aggregation and refers to the child via the modules section</li>
+     * <li>The module path to the child is considered to
+     * point at the POM rather than its base directory if the path ends with ".xml" (ignoring
case)</li>
+     * <li>The name of the child's base directory matches the artifact id of the child.</li>
+     * </ul>
+     * Note that for the sake of independence from the user
+     * environment, the filesystem is intentionally not used for the calculation.</p>
      *
      * @param child The child model, must not be <code>null</code>.
      * @param parent The parent model, may be <code>null</code>.


Mime
View raw message