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

lexakai javadoc can't be built #83

Open
jonathanl-telenav opened this issue Nov 1, 2022 · 0 comments
Open

lexakai javadoc can't be built #83

jonathanl-telenav opened this issue Nov 1, 2022 · 0 comments
Assignees
Labels

Comments

@jonathanl-telenav
Copy link
Contributor

javadoc can't handle two jars having the same package in them so it fails. ideally we could build only the javadoc for lexakai the library and not build any javadoc for the standalone app. in the meantime, the build is going to simply omit javadoc entirely for lexakai so we can get things out the door.

Tim Boudreau: Yup, the aggregated javadoc is what we grab and copy into assets. So it needs to emit something.

Setting <failOnError>false</failOnError> will let the build succeed, but it will copy an empty directory of javadc for lexakai and lexakai.standalone both.

Tim Boudreau: Grabbing the source code to maven-javadoc-plugin to see if there's some undocumented way to get past this.

Basically - we can't skip javadoc generation for lexakai-standalone, or Nexus will block us from publishing it. But we can't generate documentation for it either, or javadoc aggregation will fail. We can set <failOnError>false</code> as a workaround and the release won't abort when aggregation fails, but we'll publish an empty folder for the javadoc for lexakai into lexakai-assets.

If there's no other way, we can go with that last option for now - at least for that, we can manually build the documentation for just lexakai-the-library and copy it there, so it's not a showstopper, while aborting the release or Nexus not letting us publish is.

It might be an option to generate javadoc and aggregate it using source-level 8 - I think that's how we worked around this before.

Jonathan Locke (Shibo): is this all because of the standalone project?

Tim Boudreau: Yeah. Because two jars contain the same package, and the JDK's javadoc tool looks in both of them, sees the same package, is trying to generate modular javadoc, and bails out.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants