Skip to content

Comments

Update javadocs#1850

Open
kjswaruph wants to merge 6 commits intopulumi:mainfrom
kjswaruph:update-javadocs
Open

Update javadocs#1850
kjswaruph wants to merge 6 commits intopulumi:mainfrom
kjswaruph:update-javadocs

Conversation

@kjswaruph
Copy link

@kjswaruph kjswaruph commented Jun 29, 2025

Solves #1663

Changes:

  • Added package-info.java in all packages
  • Added descriptions and comments to classes and some methods
  • Added checkstyle plugin for linting purpose

@kjswaruph kjswaruph requested a review from a team as a code owner June 29, 2025 16:08
@justinvp
Copy link
Member

/run-acceptance-tests

@@ -0,0 +1,43 @@
<?xml version="1.0"?>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can this be run in CI?

Copy link
Author

@kjswaruph kjswaruph Aug 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the review , present configuration is only for local development it is not set for CI but i will make changes for CI.

Copy link
Member

@justinvp justinvp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @kjswaruph! Here's some additional suggestions.

- removed @see tag and added @link as StackOptions's description was previously not visible in docs.
- Added class level description and method level descriptions to improve Javadoc coverage
- Added new files package-info.java for package descriptions
- Specified in descriptions if a package is not meant for external use
- add the checkstyle plugin in sdk/java/pulumi/build.gradle
- Add checkstyle configurations checkstyle.xml and suppressions.xml ins sdk/java/config/checkstyle/
@kjswaruph
Copy link
Author

kjswaruph commented Aug 19, 2025

Hello, I need help regarding this issue. If I try to build after adding checkstyle plugin, the checkstyle triggers the task :pulumi:compilePubJava, which fails due to missing dependencies and generated sources. I checked if this task is present in main branch it didnt perform the task. To work around this, I disabled the compilePubJava task with
tasks.named("compilePubJava").configure { enabled = false }
This makes the build pass, but I want to confirm if this is the right approach or if there’s a better way.

Here's the output I get when i try to build with checkstyle plugin: https://pastebin.com/z5G6WjTF

@kjswaruph
Copy link
Author

@justinvp @tgummerer please help

Hello, I need help regarding this issue. If I try to build after adding checkstyle plugin, the checkstyle triggers the task :pulumi:compilePubJava, which fails due to missing dependencies and generated sources. I checked if this task is present in main branch it didnt perform the task. To work around this, I disabled the compilePubJava task with tasks.named("compilePubJava").configure { enabled = false } This makes the build pass, but I want to confirm if this is the right approach or if there’s a better way.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants