Missing Javadoc

[Palmr]

I was looking at tightening the Checkstyle rules but had to comment out rules checking for Javadoc on publicly scoped types, methods and variables.

The following is a list of currently missing Javadoc which we should get cleaned up for a 4.0 release:

[ant:checkstyle] [ERROR] /home/nick/git-projects/disruptor/src/main/java/com/lmax/disruptor/BatchStartAware.java:8:5: Missing a Javadoc comment. [JavadocMethod]
[ant:checkstyle] [ERROR] /home/nick/git-projects/disruptor/src/main/java/com/lmax/disruptor/DataProvider.java:18: Missing a Javadoc comment. [JavadocType]
[ant:checkstyle] [ERROR] /home/nick/git-projects/disruptor/src/main/java/com/lmax/disruptor/DataProvider.java:20:5: Missing a Javadoc comment. [JavadocMethod]
[ant:checkstyle] [ERROR] /home/nick/git-projects/disruptor/src/main/java/com/lmax/disruptor/EventPoller.java:15: Missing a Javadoc comment. [JavadocType]
[ant:checkstyle] [ERROR] /home/nick/git-projects/disruptor/src/main/java/com/lmax/disruptor/EventPoller.java:17:9: Missing a Javadoc comment. [JavadocMethod]
[ant:checkstyle] [ERROR] /home/nick/git-projects/disruptor/src/main/java/com/lmax/disruptor/EventPoller.java:20: Missing a Javadoc comment. [JavadocType]
[ant:checkstyle] [ERROR] /home/nick/git-projects/disruptor/src/main/java/com/lmax/disruptor/EventPoller.java:22:9: Missing a Javadoc comment. [JavadocVariable]
[ant:checkstyle] [ERROR] /home/nick/git-projects/disruptor/src/main/java/com/lmax/disruptor/EventPoller.java:22:21: Missing a Javadoc comment. [JavadocVariable]
[ant:checkstyle] [ERROR] /home/nick/git-projects/disruptor/src/main/java/com/lmax/disruptor/EventPoller.java:22:29: Missing a Javadoc comment. [JavadocVariable]
[ant:checkstyle] [ERROR] /home/nick/git-projects/disruptor/src/main/java/com/lmax/disruptor/EventPoller.java:25:5: Missing a Javadoc comment. [JavadocMethod]
[ant:checkstyle] [ERROR] /home/nick/git-projects/disruptor/src/main/java/com/lmax/disruptor/EventPoller.java:37:5: Missing a Javadoc comment. [JavadocMethod]
[ant:checkstyle] [ERROR] /home/nick/git-projects/disruptor/src/main/java/com/lmax/disruptor/EventPoller.java:77:5: Missing a Javadoc comment. [JavadocMethod]
[ant:checkstyle] [ERROR] /home/nick/git-projects/disruptor/src/main/java/com/lmax/disruptor/EventPoller.java:101:5: Missing a Javadoc comment. [JavadocMethod]
[ant:checkstyle] [ERROR] /home/nick/git-projects/disruptor/src/main/java/com/lmax/disruptor/EventProcessor.java:41:5: Missing a Javadoc comment. [JavadocMethod]
[ant:checkstyle] [ERROR] /home/nick/git-projects/disruptor/src/main/java/com/lmax/disruptor/EventSequencer.java:3: Missing a Javadoc comment. [JavadocType]
[ant:checkstyle] [ERROR] /home/nick/git-projects/disruptor/src/main/java/com/lmax/disruptor/EventSink.java:3: Missing a Javadoc comment. [JavadocType]
[ant:checkstyle] [ERROR] /home/nick/git-projects/disruptor/src/main/java/com/lmax/disruptor/InsufficientCapacityException.java:28:5: Missing a Javadoc comment. [JavadocVariable]
[ant:checkstyle] [ERROR] /home/nick/git-projects/disruptor/src/main/java/com/lmax/disruptor/LiteTimeoutBlockingWaitStrategy.java:18:5: Missing a Javadoc comment. [JavadocMethod]
[ant:checkstyle] [ERROR] /home/nick/git-projects/disruptor/src/main/java/com/lmax/disruptor/PhasedBackoffWaitStrategy.java:33:5: Missing a Javadoc comment. [JavadocMethod]
[ant:checkstyle] [ERROR] /home/nick/git-projects/disruptor/src/main/java/com/lmax/disruptor/RingBuffer.java:118:5: Missing a Javadoc comment. [JavadocVariable]
[ant:checkstyle] [ERROR] /home/nick/git-projects/disruptor/src/main/java/com/lmax/disruptor/Sequenced.java:3: Missing a Javadoc comment. [JavadocType]
[ant:checkstyle] [ERROR] /home/nick/git-projects/disruptor/src/main/java/com/lmax/disruptor/Sequencer.java:93:5: Missing a Javadoc comment. [JavadocMethod]
[ant:checkstyle] [ERROR] /home/nick/git-projects/disruptor/src/main/java/com/lmax/disruptor/SleepingWaitStrategy.java:40:5: Missing a Javadoc comment. [JavadocMethod]
[ant:checkstyle] [ERROR] /home/nick/git-projects/disruptor/src/main/java/com/lmax/disruptor/SleepingWaitStrategy.java:45:5: Missing a Javadoc comment. [JavadocMethod]
[ant:checkstyle] [ERROR] /home/nick/git-projects/disruptor/src/main/java/com/lmax/disruptor/SleepingWaitStrategy.java:50:5: Missing a Javadoc comment. [JavadocMethod]
[ant:checkstyle] [ERROR] /home/nick/git-projects/disruptor/src/main/java/com/lmax/disruptor/TimeoutBlockingWaitStrategy.java:20:5: Missing a Javadoc comment. [JavadocMethod]
[ant:checkstyle] [ERROR] /home/nick/git-projects/disruptor/src/main/java/com/lmax/disruptor/TimeoutException.java:3: Missing a Javadoc comment. [JavadocType]
[ant:checkstyle] [ERROR] /home/nick/git-projects/disruptor/src/main/java/com/lmax/disruptor/TimeoutException.java:6:5: Missing a Javadoc comment. [JavadocVariable]
[ant:checkstyle] [ERROR] /home/nick/git-projects/disruptor/src/main/java/com/lmax/disruptor/TimeoutHandler.java:3: Missing a Javadoc comment. [JavadocType]
[ant:checkstyle] [ERROR] /home/nick/git-projects/disruptor/src/main/java/com/lmax/disruptor/TimeoutHandler.java:5:5: Missing a Javadoc comment. [JavadocMethod]
[ant:checkstyle] [ERROR] /home/nick/git-projects/disruptor/src/main/java/com/lmax/disruptor/dsl/ExceptionHandlerWrapper.java:6: Missing a Javadoc comment. [JavadocType]
[ant:checkstyle] [ERROR] /home/nick/git-projects/disruptor/src/main/java/com/lmax/disruptor/dsl/ExceptionHandlerWrapper.java:10:5: Missing a Javadoc comment. [JavadocMethod]
[ant:checkstyle] [ERROR] /home/nick/git-projects/disruptor/src/main/java/com/lmax/disruptor/util/DaemonThreadFactory.java:25:5: Missing a Javadoc comment. [JavadocVariable]
[ant:checkstyle] [ERROR] /home/nick/git-projects/disruptor/src/main/java/com/lmax/disruptor/util/Util.java:145:5: Missing a Javadoc comment. [JavadocMethod]