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.

Sign up for GitHub

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

Jump to bottom

Javadoc builder is more strict than the javadoc tests #3757

Closed
2 tasks
chingor13 opened this issue Oct 2, 2018 · 1 comment
Closed
2 tasks

Javadoc builder is more strict than the javadoc tests #3757

chingor13 opened this issue Oct 2, 2018 · 1 comment
Assignees
@chingor13
Labels
status: in progress There is an open PR type: cleanup An internal cleanup or hygiene concern. type: docs Improvement to the documentation for an API.

Comments

@chingor13
Copy link
Contributor

chingor13 commented Oct 2, 2018 •
edited
Loading

  • f6b93fa fixed some documentation errors that were not caught by the javadoc tests. The tests should ensure that the full documentation site can build and not block a release
  • Update to maven-javadoc-plugin 3.0+ and set doclint configuration option
@chingor13 chingor13 added type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns. priority: p2 Moderately-important priority. Fix may not be included in next release. labels Oct 2, 2018
@chingor13 chingor13 self-assigned this Oct 9, 2018
@sduskis sduskis added type: cleanup An internal cleanup or hygiene concern. type: process A process-related concern. May include testing, release, or the like. and removed priority: p2 Moderately-important priority. Fix may not be included in next release. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns. type: process A process-related concern. May include testing, release, or the like. labels Oct 23, 2018
@chingor13 chingor13 mentioned this issue Nov 8, 2018
Closed
@chingor13
Copy link
Contributor Author

It turns out we were running the javadoc tests in Java 7 which was allowing javadoc to build with stuff caught in Java 8. We build our docs with Java 8 so it was failing at doc building time.

@chingor13 chingor13 added the type: docs Improvement to the documentation for an API. label Dec 3, 2018
@chingor13 chingor13 mentioned this issue Dec 3, 2018
Merged
@chingor13 chingor13 added the status: in progress There is an open PR label Dec 3, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@chingor13 chingor13

Labels
status: in progress There is an open PR type: cleanup An internal cleanup or hygiene concern. type: docs Improvement to the documentation for an API.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@chingor13 @sduskis