Javadoc creates build issues

bdeetz commented 9 years ago

When I run "./gradlew build" I get build errors in the javadoc section. Obviously this doesn't affect much, but it would be nice if the entire build process worked.

I am compiling on Ubuntu 14.04.1 LTS with the Oracle Java 8 JDK (not openjdk). I've been out of the loop with Java for about 4 years, so I suspect this is a situation of PEBCAK.

===========gradlew output================= :libraft-core:compileJava UP-TO-DATE :libraft-core:processResources UP-TO-DATE :libraft-core:classes UP-TO-DATE :libraft-core:jar UP-TO-DATE :libraft-agent:compileJava UP-TO-DATE :libraft-agent:processResources UP-TO-DATE :libraft-agent:classes UP-TO-DATE :libraft-agent:jar UP-TO-DATE :libraft-core:javadoc /home/bdeetz/libraft/libraft-core/src/main/java/io/libraft/algorithm/Log.java:51: error: bad use of '>' * @param index index >= 0 of the {@code LogEntry} to get ^ /home/bdeetz/libraft/libraft-core/src/main/java/io/libraft/algorithm/Log.java:54: warning: no @throws for io.libraft.algorithm.StorageException @Nullable LogEntry get(long index) throws StorageException; ... ... ... 75 errors 21 warnings :libraft-core:javadoc FAILED

FAILURE: Build failed with an exception.

What went wrong: Execution failed for task ':libraft-core:javadoc'.

Javadoc generation failed.
Try: Run with --stacktrace option to get the stack trace. Run with --info or --debug option to get more log output.

BUILD FAILED

Total time: 11.978 secs

allengeorge commented 9 years ago

Ah no - the PEBCAK is on my end. Looks like I didn't use character sequences for < and > throughout the documentation. I'll fix it over the next few days.

zhuguangxiang commented 8 years ago

i like libraft, but there is no more development, it's petty. I will help you maintain and continue to develop lib raft.

allengeorge commented 8 years ago

I'm happy to take a PR...

Terminal Musings: http://www.allengeorge.com/ Raft in Java: https://github.com/allengeorge/libraft/ Twitter: https://twitter.com/allenageorge/

On Fri, Sep 2, 2016 at 11:44 PM, zhuguangxiang notifications@github.com wrote:

i like libraft, but there is no more development, it's petty. I will help you maintain and continue to develop lib raft.

— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/allengeorge/libraft/issues/48#issuecomment-244524430, or mute the thread https://github.com/notifications/unsubscribe-auth/AAEO9FLQdvfeC6aRLmsvm6UzLqFOQI_8ks5qmO0KgaJpZM4DFMQe .

allengeorge / libraft

Javadoc creates build issues #48