Skip to content

Issues with directories that have a comma in them #372

Open
@rdifrango

Description

@rdifrango

Affected version

3.11.2

Bug description

I noticed that if a directory name has a , in it when the options file is generated the -d is split thus causing a failure.

For example:

/my,directory/my-project/my-module

Results in an option file that looks like

-sourcepath
'/my,directory/my-project/my-module/target/generated-sources/annotations'
-author
-bottom
'Copyright © 2025. All rights reserved.'
-charset
'UTF-8'
-d
'/my,
directory/my-project/my-module/target/reports/apidocs'
-docencoding
'UTF-8'
-doctitle
'my-module 3.5.0-SNAPSHOT API'
-use
-version
-windowtitle
'my-module 3.5.0-SNAPSHOT API'

Thus it fails with:

[ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:3.11.2:jar (attach-javadocs) on project sample-domain-model: MavenReportException: Error while generating Javadoc: 
[ERROR] Exit code: 2
[ERROR] error: Illegal package name: ",directory/my-project/my-module/target/reports/apidocs"
[ERROR] 1 error
[ERROR] Command line was: javadoc -J-Duser.language= -J-Duser.country= @options @packages
[ERROR] 
[ERROR] Refer to the generated Javadoc files in '/my,directory/my-project/my-module/target/reports/apidocs' dir.
[ERROR] 
[ERROR] -> [Help 1]

My configuration is as follows:

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>${maven.javadoc.plugin.version}</version>
    <executions>
        <execution>
            <id>attach-javadocs</id>
            <goals>
                <goal>jar</goal>
            </goals>
        </execution>
    </executions>
</plugin>

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions