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

Correct Javadoc errors when generating with Java 8 #128

Closed
jonahgraham opened this issue Mar 29, 2017 · 6 comments
Closed

Correct Javadoc errors when generating with Java 8 #128

jonahgraham opened this issue Mar 29, 2017 · 6 comments

Comments

@jonahgraham
Copy link
Contributor

(follow on from #125)

The current javadocs contain many HTML errors when generating with Java 8. e..g < in the javadoc. However as we are currently using Java 7 javadoc, these items are not errors.

The reason we see these errors in Java 8 is because of a new feature: JEP 172 DocLint

@jonahgraham
Copy link
Contributor Author

There is some useful info about this on http://jdpgrailsdev.github.io/blog/2014/04/03/maven_java8_javadoc.html

@jonahgraham
Copy link
Contributor Author

@PeterC-DLS I have published master apidocs (now done automatically) to http://download.eclipse.org/january/builds/january-master/latest/apidocs/

Can you have a check and see if they are OK.

Some features I added:

  • links to all types that we depend on (apache, log4j, oracle): links. So for example if you look at NullStorelessUnivariateStatistic#copy you'll see the return type links back to the correct version (3.5) of StorelessUnivariateStatistic at apache
  • generate API docs only for non-internal: excludePackageNames
  • source is generated for easier cross refencing: linksource

I have started the PRs (#127) for 2.0 branch, but I need to bump the versions still. If it looks OK we can do a 2.0.1 RC tomorrow.

@PeterC-DLS
Copy link
Contributor

@jonahkichwacoders The docs look very fine - even the maths in Comparisons.Monotonicity. Some of the packages need a bit more overview information (to be added in the future).

@PeterC-DLS
Copy link
Contributor

@jonahkichwacoders Cool features for those external links though I think that class should be a private one... Can I assume that being Java 8 compliant is backwardly compatible too?

@jonahgraham
Copy link
Contributor Author

Can I assume that being Java 8 compliant is backwardly compatible too?

Yes. What Java 8 added is a linter for javadocs. The linter can be tuned off or we can fix the lint issues. I have always been of two minds about javadocs as I spend 1/2 my time reading them in code and 1/2 in html. Sometimes to make them look nice in html lowers their value in the code.

@PeterC-DLS
Copy link
Contributor

Closing as all errors and warnings were fixed in #450

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

No branches or pull requests

2 participants