Fix incorrect JavaDocs for PathFileObjectAssert.java

Signed-off-by: Ashley <[email protected]>

java-compiler-testing/src/main/java/io/github/ascopes/jct/assertions/PathFileObjectAssert.java

@@ -43,7 +43,10 @@ public PathFileObjectAssert(@Nullable PathFileObject actual) {
   }
 
   /**
-   * Perform an assertion on the file object's full path.
+   * Perform an assertion on the file object's relative path.
+   *
+   * <p>The path is relative to the base directory holding all the
+   * sources relative to their package names.
    *
    * @return the assertions for the path.
    * @throws AssertionError if the file object is null.
@@ -57,6 +60,8 @@ public AbstractPathAssert<?> relativePath() {
   /**
    * Perform an assertion on the file object's absolute path.
    *
+   * <p>You generally should prefer using {@link #relativePath}.
+   *
    * @return the assertions for the path.
    * @throws AssertionError if the file object is null.
    */