[
https://issues.apache.org/jira/browse/MJAVADOC-783?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17796348#comment-17796348
]
ASF GitHub Bot commented on MJAVADOC-783:
-----------------------------------------
kriegaex commented on code in PR #255:
URL:
https://github.com/apache/maven-javadoc-plugin/pull/255#discussion_r1425521122
##########
src/main/java/org/apache/maven/plugins/javadoc/JavadocUtil.java:
##########
@@ -118,32 +119,54 @@ public class JavadocUtil {
+ "environment variable using -Xms:<size> and
-Xmx:<size>.";
/**
- * Method that removes the invalid directories in the specified
directories. <b>Note</b>: All elements in
- * <code>dirs</code> could be an absolute or relative against the
project's base directory <code>String</code> path.
+ * Method that removes invalid classpath elements in the specified paths.
<b>Note</b>: All elements in
+ * <code>paths</code> could be absolute or relative against the project's
base directory <code>String</code> path.
+ * When pruning class paths, you can optionally include "*.jar" files in
the result, otherwise only directories are
+ * permitted.
*
* @param project the current Maven project not null
- * @param dirs the collection of <code>String</code> directories path that
will be validated.
- * @return a List of valid <code>String</code> directories absolute paths.
+ * @param paths the collection of <code>String</code> paths that will be
validated
+ * @param includeJars whether to include JAR files in the result
+ * @return a list of valid <code>String</code> directories and optionally
JAR files as absolute paths
Review Comment:
Look, I understand if you are very busy and do not have enough time to
triage bugs or review code. But if you cannot see the difference between a new
method and a renamed, slightly extended one to convey the more generic
behaviour, differentiating it by name from the original method the code was
factored out from, I really cannot help you. I can live without you consenting
to and merging these two bugfixes, if you want to coerce me to do your job to
refactor the existing documentation, after I already did your job of fixing two
old bugs. Merge it, fine. Refactor the docs after the merge, be my guest. Or
don't merge it, hurting yourself and your users, also fine. I am done here.
> Invalid path when using TagletArtifact and TagletPath
> -----------------------------------------------------
>
> Key: MJAVADOC-783
> URL: https://issues.apache.org/jira/browse/MJAVADOC-783
> Project: Maven Javadoc Plugin
> Issue Type: Bug
> Affects Versions: 3.6.3
> Reporter: Rob Gordon
> Priority: Major
>
> I’m trying to use the Javadoc plugin with both a tagletartifact and a
> tagletpath but I get an InvliadPathException from the Javadoc goal.
> I can see from the generated options file that there is no separator between
> the end of the artifact path and the taglet path.
> I think the problem is that getTagletPath method of AbstractJavadocMojo
> should check for an existing path before adding the tagletpath. Something
> like:
> {code:java}
> if (tagletpath != null && !tagletpath.isEmpty()) {
> if (path.length() > 0)
> { path.append(File.pathSeparator); }
> path.append(JavadocUtil.unifyPathSeparator(tagletpath));
> }
> {code}
> I looked at creating a pull request but I can’t work out how to create a
> suitable test. I found a taglet-test-plugin-config.xml, but not where it’s
> used.
> Could someone familiar with this codebase possibly take a look at this
> problem please?
> My configuration can be seen here:
> [https://github.com/robjg/oj-parent/blob/d3e2328ca285516f1a4f6ee2bce94b44ba89b748/pom.xml#L304]
> I attempted to report this problem via 'us...@maven.apache.org' however my
> mail did not make it.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
