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

New tool for API Docs #4013

Open
sebkur opened this issue Sep 11, 2020 · 4 comments
Open

New tool for API Docs #4013

sebkur opened this issue Sep 11, 2020 · 4 comments
Labels
P4 no SLO type=other Miscellaneous activities not covered by other type= labels

Comments

@sebkur
Copy link
Contributor

sebkur commented Sep 11, 2020

We've been prototyping a new toolchain for generating API Docs for Java libraries and it would be really interesting to know if you as the maintainers of the Guava library are completely happy with the way javadoc works and the output it produces or if you're generally interested in exploring alternatives. We've used Guava as a showcase anyway so the demo for the latest JRE-version is online here: https://javadocng.mobanisto.com/guava-29.0/

We could also imagine making a version of the API Diff doclet using our toolchain. So it would also be interesting to know if you're happy with that or if there would also be room for improvement in that area.

Thank you for any feedback!

@sebkur
Copy link
Contributor Author

sebkur commented Sep 11, 2020

This is a work in progress and just a prototype, so quite a few things are still broken and not working as expected

@nick-someone nick-someone added P4 no SLO type=other Miscellaneous activities not covered by other type= labels labels Sep 16, 2020
@rohitkrishna094
Copy link

rohitkrishna094 commented Oct 18, 2020

Search feature looks awesome. Not sure if we can search in regular javadocs(I don't see a search button on normal javadocs). Is javadocng open source? and is it on github?

@sebkur
Copy link
Contributor Author

sebkur commented Oct 18, 2020

It is open source: https://github.com/sebkur/javadoc-ng

@sebkur
Copy link
Contributor Author

sebkur commented Oct 18, 2020

Although, actually that repository currently only contains that article. I haven't gotten to publish the project itself freely yet.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P4 no SLO type=other Miscellaneous activities not covered by other type= labels
Projects
None yet
Development

No branches or pull requests

3 participants