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

Published API docs for 1.6 are incomplete #686

Closed
mojavelinux opened this issue Oct 3, 2018 · 3 comments
Closed

Published API docs for 1.6 are incomplete #686

mojavelinux opened this issue Oct 3, 2018 · 3 comments

Comments

@mojavelinux
Copy link
Member

The API docs for 1.6 that get published to http://www.javadoc.io/doc/org.asciidoctor/asciidoctorj/1.6.0-alpha.7 are incomplete. In particular, most of the classes in the ast package are missing (see http://static.javadoc.io/org.asciidoctor/asciidoctorj/1.6.0-alpha.7/org/asciidoctor/ast/package-summary.html). It seems like the API docs from one of the jars (perhaps the API jar) is not getting picked up.

Given that the best APIs are in 1.6, this omission makes it tough to promote the new APIs.

@mojavelinux mojavelinux changed the title API docs for 1.6 are incomplete Published API docs for 1.6 are incomplete Oct 3, 2018
@robertpanzer
Copy link
Member

Thanks for the pointer! I’ll check that. I can imagine we lost that while moving the AST classes to the -api module.

@robertpanzer
Copy link
Member

OK, now I see.
We moved big parts of the API to the module asciidoctorj-api, therefore these Javadocs also went to http://www.javadoc.io/doc/org.asciidoctor/asciidoctorj-api/1.6.0-alpha.7
For this use case I think it makes sense to include the sources of asciidoctorj-api when generating the Javadocs for the asciidoctorj module.

@mojavelinux
Copy link
Member Author

I agree I think the API docs should be combined.

robertpanzer added a commit that referenced this issue Oct 11, 2018
Fixes #686. Add sources of asciidoctorj-api to javadocs of asciidoctorj
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