svn commit: r786837 - in /maven/components/trunk/maven-model-builder/src/main/java/org/apache/maven/model: ModelSource.java path/PathTranslator.java

[be...@apache.org]

Author: bentmann
Date: Sat Jun 20 14:51:45 2009
New Revision: 786837

URL: http://svn.apache.org/viewvc?rev=786837&view=rev
Log:
o Polished documentation

Modified:
    maven/components/trunk/maven-model-builder/src/main/java/org/apache/maven/model/ModelSource.java
    maven/components/trunk/maven-model-builder/src/main/java/org/apache/maven/model/path/PathTranslator.java

Modified: maven/components/trunk/maven-model-builder/src/main/java/org/apache/maven/model/ModelSource.java
URL: http://svn.apache.org/viewvc/maven/components/trunk/maven-model-builder/src/main/java/org/apache/maven/model/ModelSource.java?rev=786837&r1=786836&r2=786837&view=diff
==============================================================================
--- maven/components/trunk/maven-model-builder/src/main/java/org/apache/maven/model/ModelSource.java (original)
+++ maven/components/trunk/maven-model-builder/src/main/java/org/apache/maven/model/ModelSource.java Sat Jun 20 14:51:45 2009
@@ -39,10 +39,10 @@
         throws IOException;
 
     /**
-     * Provides a human-readable hint about the location of the POM. This could be a local file path, a URI or just an
+     * Provides a user-friendly hint about the location of the POM. This could be a local file path, a URI or just an
      * empty string. The intention is to assist users during error reporting.
      * 
-     * @return A human-readable hint about the location of the POM, never {@code null}.
+     * @return A user-friendly hint about the location of the POM, never {@code null}.
      */
     String getLocation();
 

Modified: maven/components/trunk/maven-model-builder/src/main/java/org/apache/maven/model/path/PathTranslator.java
URL: http://svn.apache.org/viewvc/maven/components/trunk/maven-model-builder/src/main/java/org/apache/maven/model/path/PathTranslator.java?rev=786837&r1=786836&r2=786837&view=diff
==============================================================================
--- maven/components/trunk/maven-model-builder/src/main/java/org/apache/maven/model/path/PathTranslator.java (original)
+++ maven/components/trunk/maven-model-builder/src/main/java/org/apache/maven/model/path/PathTranslator.java Sat Jun 20 14:51:45 2009
@@ -31,7 +31,8 @@
 
     /**
      * Resolves the specified path against the given base directory. The resolved path will be absolute and uses the
-     * platform-specific file separator.
+     * platform-specific file separator if a base directory is given. Otherwise, the input path will be returned
+     * unaltered.
      * 
      * @param path The path to resolve, may be {@code null}.
      * @param basedir The base directory to resolve relative paths against, may be {@code null}.