Author: rfscholte
Date: Thu May 17 11:18:35 2012
New Revision: 1339553
URL: http://svn.apache.org/viewvc?rev=1339553&view=rev
Log:
SCM-674: describe additional restrictions in javadoc
Modified:
maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm/ScmFile.java
Modified:
maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm/ScmFile.java
URL:
http://svn.apache.org/viewvc/maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm/ScmFile.java?rev=1339553&r1=1339552&r2=1339553&view=diff
==============================================================================
---
maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm/ScmFile.java
(original)
+++
maven/scm/trunk/maven-scm-api/src/main/java/org/apache/maven/scm/ScmFile.java
Thu May 17 11:18:35 2012
@@ -35,7 +35,7 @@ public class ScmFile
private ScmFileStatus status;
/**
- * @param path The file path
+ * @param path The relative path of the file, should <b>never</b> start
with any {@link java.io.File#separator}.
* @param status The file status
*/
public ScmFile( String path, ScmFileStatus status )
@@ -46,6 +46,8 @@ public class ScmFile
}
/**
+ * Returns the relative path of the file.
+ *
* @return the file path
*/
public String getPath()
