Skip to content

Remove local Javadoc repository #434

@frankgiordano

Description

@frankgiordano

Change maven build process to generate javadoc (and stored in target directory for deployment) instead of a manual process where it is generated and saved in directory under the project.

With this configuration:

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

Here’s what happens:

Generates Javadoc on the fly

Maven will automatically generate Javadoc from your source code during the build.

Packages it as a JAR

The jar goal produces a *-javadoc.jar file (e.g., zowe-client-java-sdk-x.x.x-javadoc.jar) in the target directory.

No need for local javadoc/ folder

You don’t need to store Javadoc HTML files in source control; Maven generates them dynamically every build.

Integrates with deploy and publishing

When you deploy to a Maven repository (like Sonatype OSSRH), the Javadoc JAR is automatically included alongside your main JAR and sources JAR.

This is the standard way most projects manage Javadoc now—keeps your repo clean and ensures the docs are always up-to-date with the code.

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions