Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enable Javadoc checks for src/test directories #871

Merged
merged 5 commits into from
Aug 21, 2024

Conversation

Ao-senXiong
Copy link
Member

See discussion in #827 (comment)

@Ao-senXiong Ao-senXiong changed the title Enable Javadoc for framework/src/test/java/ Enable Javadoc check for framework/src/test/java/ Aug 20, 2024
@@ -633,6 +633,7 @@ task allJavadoc(type: Javadoc, group: 'Documentation') {
project(':checker-qual').sourceSets.main.allJava,
project(':checker').sourceSets.main.allJava,
project(':framework').sourceSets.main.allJava,
project(':framework').sourceSets.test.allJava,
Copy link
Member

Choose a reason for hiding this comment

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

This is great and reveals 14 errors in javadoc!
Should the same be done for :checker?

Copy link
Member Author

Choose a reason for hiding this comment

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

Sounds good to me! I will udpate the gradle file.

Copy link
Member

Choose a reason for hiding this comment

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

There is also dataflow/src/test, checker/src/testannotations, and checker-util/src/test.
Please also fix the javadoc errors revealed by the new check.

Copy link
Member Author

Choose a reason for hiding this comment

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

Okay, sounds good.

Copy link
Member Author

Choose a reason for hiding this comment

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

Maybe framework-test/src/test as well?

Copy link
Member Author

Choose a reason for hiding this comment

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

I will leave do checker/src/testannotations later in a new PR. Looks like we need to define the source set for testannotations folder.

@Ao-senXiong Ao-senXiong changed the title Enable Javadoc check for framework/src/test/java/ Enable Javadoc check for src/test Aug 21, 2024
@Ao-senXiong Ao-senXiong requested a review from wmdietl August 21, 2024 20:40
@Ao-senXiong Ao-senXiong assigned wmdietl and unassigned Ao-senXiong Aug 21, 2024
Copy link
Member

@wmdietl wmdietl left a comment

Choose a reason for hiding this comment

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

Thanks for all the cleanups!

@wmdietl wmdietl changed the title Enable Javadoc check for src/test Enable Javadoc checks for src/test directories Aug 21, 2024
@wmdietl wmdietl merged commit 19e6f2c into eisop:master Aug 21, 2024
74 checks passed
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.

2 participants