(maven-javadoc-plugin) branch master updated: deprecate toRelative (#379)

[elharo]

This is an automated email from the ASF dual-hosted git repository.

elharo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-javadoc-plugin.git


The following commit(s) were added to refs/heads/master by this push:
     new c60edbcc deprecate toRelative (#379)
c60edbcc is described below

commit c60edbccecec98d488a5e95e55fca13b9b30c559
Author: Elliotte Rusty Harold <elh...@users.noreply.github.com>
AuthorDate: Fri May 30 17:42:16 2025 +0000

    deprecate toRelative (#379)
---
 src/main/java/org/apache/maven/plugins/javadoc/JavadocUtil.java | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/src/main/java/org/apache/maven/plugins/javadoc/JavadocUtil.java 
b/src/main/java/org/apache/maven/plugins/javadoc/JavadocUtil.java
index 8da760f1..4b2e0ae7 100644
--- a/src/main/java/org/apache/maven/plugins/javadoc/JavadocUtil.java
+++ b/src/main/java/org/apache/maven/plugins/javadoc/JavadocUtil.java
@@ -363,7 +363,7 @@ public class JavadocUtil {
      *
      * @param sourceDirectory the directory where the source files are located
      * @param excludePackagenames package names to be excluded in the javadoc
-     * @return a List of the packagenames to be excluded
+     * @return the package names to be excluded
      */
     protected static Collection<String> getExcludedPackages(
             final Path sourceDirectory, Collection<String> 
excludePackagenames) {
@@ -1262,7 +1262,10 @@ public class JavadocUtil {
         return result;
     }
 
-    // TODO: deprecate in favor of Path.relativize
+    /**
+     * @deprecated use {@link Path#relativize(Path)} () instead
+     */
+    @Deprecated
     public static String toRelative(File basedir, String absolutePath) {
         String relative;