[
https://issues.apache.org/jira/browse/MJAVADOC-783?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17796587#comment-17796587
]
ASF GitHub Bot commented on MJAVADOC-783:
-----------------------------------------
kriegaex commented on PR #255:
URL:
https://github.com/apache/maven-javadoc-plugin/pull/255#issuecomment-1855273892
> > I do think we need an integration test for this, or perhaps expanded
unit test coverage. Without that we don't know that taglet paths now work.
>
> You did not know before either. Like I said, feel free to write an IT. Do
not abuse contributors to catch up with work that was not done when it was due
for existing code.
@elharo, I forgot to mention a detail: When you start writing ITs and want
to keep the build running on both JDK 8 and JDK 9+ (CI builds currently run on
8 and 17), enjoy implementing all sample taglets twice, once for the old Doclet
API and again for the Doclet APi from JDK 9+, see [JEP
221](https://openjdk.org/jeps/221). You can have the same fun I had when
helping out a bit at Xalan-Java, creating [JDK-dependent Java
profiles](https://github.com/apache/xalan-java/blob/9d0fd070e88474a96713b1c74bdfefcf89e04674/pom.xml#L46-L74)
adding a [JDK 8 taglet
module](https://github.com/apache/xalan-java/tree/xalan-java-mvn-refactored/xalan2jtaglet)
for the old API and a [JDK 9+
one](https://github.com/apache/xalan-java/tree/xalan-java-mvn-refactored/xalan2jtaglet_jdk9)
for the new API. All of this only to have sample code for ITs.
Of course, this makes sense, but it is way off limits for this bugfix PR.
Before anyone creates such ITs, the Maven Javadoc team should maybe first
decide, if the small benefit of being able to still build (not run, only
build!) the plugin on JDK 8 is worth the more than duplicate (because of extra
profiles and distinction of cases) effort of creating and maintaining such ITs.
After that decision, work on ITs can start in a separate PR.
> 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)
