o Polished documentation

git-svn-id: https://svn.apache.org/repos/asf/maven/components/trunk@786837 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Benjamin Bentmann 2009-06-20 14:51:45 +00:00
parent 1c0a588c90
commit fed83d80b8
2 changed files with 4 additions and 3 deletions

View File

@ -39,10 +39,10 @@ public interface ModelSource
throws IOException; 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. * 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(); String getLocation();

View File

@ -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 * 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 path The path to resolve, may be {@code null}.
* @param basedir The base directory to resolve relative paths against, may be {@code null}. * @param basedir The base directory to resolve relative paths against, may be {@code null}.