[
https://issues.apache.org/jira/browse/MJAVADOC-783?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17796267#comment-17796267
]
ASF GitHub Bot commented on MJAVADOC-783:
-----------------------------------------
kriegaex commented on PR #255:
URL:
https://github.com/apache/maven-javadoc-plugin/pull/255#issuecomment-1853879465
> Rewrite Javadoc to clarify
@elharo, if you did not notice by inspecting my PR: I just contributes
something valueable, fixing two bugs within 30 minutes of seeing this code for
the first time in my life. It is meant to be a minimally invasive change, not a
structural refactoring of either code or javadoc. Hence, I kept wording and
structure of the existing javadocs intact. Otherwise, I would have had to
rewrite the javadocs for the whole class and maybe also for the rest of the
module.
FYI, I also checked whom you can ask what this javadoc means and why it was
written that way: Vincent Siveton.
There is a software craftsmanship principle which is often forgotten: to
separate refactoring functional changes. This PR is about functional changes
and not supposed to restructure the code or its documentation more than
necessary to accomodate to the fact that I made one method more flexible by and
additional parameter and use that method from the previously existing one in to
avoid code duplication.
> 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)
