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

[docs] Exclude quickbuf files and proto/struct packages from doclint #6128

Merged
merged 6 commits into from
Jan 2, 2024
Merged

[docs] Exclude quickbuf files and proto/struct packages from doclint #6128

merged 6 commits into from
Jan 2, 2024

Conversation

Gold856
Copy link
Contributor

@Gold856 Gold856 commented Jan 1, 2024

Removes 111 159 warnings for #5808.
We already skip the quickbuf files for other styleguide things since we can't control them.
Are there any other packages we want to exclude?

@Gold856 Gold856 requested a review from a team as a code owner January 1, 2024 02:10
@Gold856 Gold856 changed the title Exclude quickbuf files from doclint [docs] Exclude quickbuf files from doclint Jan 1, 2024
@calcmogul
Copy link
Member

calcmogul commented Jan 1, 2024

Probably also edu/wpi/first/wpilibj/util/WPILibVersion.java since it's annoying to modify the version plugin.

There's some others like:

  • edu/wpi/first/math/geometry/proto
  • edu/wpi/first/math/geometry/struct
  • edu/wpi/first/math/kinematics/proto
  • edu/wpi/first/math/kinematics/struct

Would be good to comb the codebase for others.

@Gold856 Gold856 changed the title [docs] Exclude quickbuf files from doclint [docs] Exclude quickbuf files and proto/struct packages from doclint Jan 1, 2024
docs/build.gradle Outdated Show resolved Hide resolved
docs/build.gradle Outdated Show resolved Hide resolved
@PeterJohnson PeterJohnson merged commit 5579219 into wpilibsuite:main Jan 2, 2024
25 checks passed
@Gold856 Gold856 deleted the javadoc-warnings branch January 6, 2024 16:33
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.

5 participants