From fed83d80b8112c32a9aaea87122b04a2ee9cdd3d Mon Sep 17 00:00:00 2001 From: Benjamin Bentmann Date: Sat, 20 Jun 2009 14:51:45 +0000 Subject: [PATCH] o Polished documentation git-svn-id: https://svn.apache.org/repos/asf/maven/components/trunk@786837 13f79535-47bb-0310-9956-ffa450edef68 --- .../src/main/java/org/apache/maven/model/ModelSource.java | 4 ++-- .../main/java/org/apache/maven/model/path/PathTranslator.java | 3 ++- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/maven-model-builder/src/main/java/org/apache/maven/model/ModelSource.java b/maven-model-builder/src/main/java/org/apache/maven/model/ModelSource.java index ca6ef87b0a..6b3a99d874 100644 --- a/maven-model-builder/src/main/java/org/apache/maven/model/ModelSource.java +++ b/maven-model-builder/src/main/java/org/apache/maven/model/ModelSource.java @@ -39,10 +39,10 @@ public interface ModelSource 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(); diff --git a/maven-model-builder/src/main/java/org/apache/maven/model/path/PathTranslator.java b/maven-model-builder/src/main/java/org/apache/maven/model/path/PathTranslator.java index 349711d50c..3613af8244 100644 --- a/maven-model-builder/src/main/java/org/apache/maven/model/path/PathTranslator.java +++ b/maven-model-builder/src/main/java/org/apache/maven/model/path/PathTranslator.java @@ -31,7 +31,8 @@ public interface PathTranslator /** * 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}.