sba1 / ontologizer

Ontologizer is a tool for identifying enriched Gene Ontology terms in lists of names of genes or gene products.
http://ontologizer.de
8 stars 8 forks source link

Fix javadocs to work with java8 #4

Closed cmungall closed 8 years ago

cmungall commented 8 years ago

java8 is stricter when it comes to javadocs. Trying to build @drseb's branch with mvn:

ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:2.10.3:jar (generate-javadoc-jar) on project ontologizer: MavenReportException: Error while generating Javadoc:
[ERROR] Exit code: 1 - /Users/cjm/repos/drseb/ontologizer/ontologizer/src/ontologizer/AbstractStudySetResult.java:40: warning: no description for @param
[ERROR] * @param goTermID

This seems to be one possible workaround: http://www.locked.de/2015/04/05/how-to-ignore-maven-javadoc-errors-in-java-8/

But doesn't seem to work for me

sba1 commented 8 years ago

PR #3 deals with the problem, but not 100% satisfactory. Temporary solution that might work: Add -Dmaven.javadoc.skip=true to the mvn command (works only if you don't need Javadoc). But yes, the proper solution is to fix Javadocs. Contributions are welcome :)

sba1 commented 8 years ago

I fixed all errors, there are still warnings but the build passes according to Travis. Thanks for the report.