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

use mvn site to generate javadoc jar #460

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

jodygarnett
Copy link
Contributor

Move javadoc to phase site:

  • mvn clean install - just builds jar and source jar
  • mvn site - builds javadoc jar

Note the javadoc generation has warnings and errors at present...

Signed-off-by: Jody Garnett <jody.garnett@gmail.com>
Signed-off-by: Jody Garnett <jody.garnett@gmail.com>
@jodygarnett
Copy link
Contributor Author

@jnh5y this PR is "functional", not sure if we want it? I believe we addressed the javadoc warning issues discussed above.

@jnh5y
Copy link
Contributor

jnh5y commented Aug 18, 2020

@jodygarnett why do you want to leave the generation of the javadocs to mvn site? I'm confused.

@jodygarnett
Copy link
Contributor Author

I think this is left over from when we first migrated to maven. There are two options for where to hook in javadocs...

  • We could set it up as a "report" so it would show up in mvn site build
  • We could bind it to a stage (so for example it would show up in a full mvn install build)

Or we could do nothing and depend on mvn javadoc:javadoc like we do now?

I recommend we close this pull request, unless you are used to (or like the sound of) the mvn site approach?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants