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

fix javadoc doclint errors #62

Open
hrldcpr opened this issue Mar 28, 2018 · 4 comments
Open

fix javadoc doclint errors #62

hrldcpr opened this issue Mar 28, 2018 · 4 comments

Comments

@hrldcpr
Copy link
Owner

hrldcpr commented Mar 28, 2018

We get doclint errors when running ./gradlew javadoc, if we don't enable Xdoclint:none in build.gradle

Mostly it's just @param fields with no description—simplest would be to just delete them entirely.

Once this is working, remove the Xdoclint:none in build.gradle

@ghost
Copy link

ghost commented Mar 29, 2018

Errors confirmed.
Just a quick question - is there any reason for Maven to be used as well for project build tasks when Gradle is used already? It is confusing to see pom.xml as well on the root of the project [the POM file can be generated by Gradle as a build step as far as I know].

@hrldcpr
Copy link
Owner Author

hrldcpr commented Mar 30, 2018

Yeah good question, there's no good reason, someone added Gradle at some point. I'm happy to switch to one or the other, as long as we can still do everything required for releasing (i.e. the instructions in CHANGING). Gradle certainly has less verbose config files. Made a new issue for this - #64

@blackdrag
Copy link
Collaborator

That was me I guess, since I am not a big fan of maven. I think I simply forgot to remove the maven parts completely.

@hrldcpr
Copy link
Owner Author

hrldcpr commented Mar 30, 2018

@blackdrag haha cool, yeah it seems better as far as I can tell, let's go all in!

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

No branches or pull requests

2 participants