Merge pull request #179 from xiaoguichao/master

Correct some spelling mistakes (mainly in comments)
LMAX-Exchange · Nov 21, 2016 · 2314a27 · 2314a27
2 parents 946d62a + 60153be
commit 2314a27
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 12 deletions.
diff --git a/src/main/java/com/lmax/disruptor/RingBuffer.java b/src/main/java/com/lmax/disruptor/RingBuffer.java
@@ -433,7 +433,7 @@ public int getBufferSize()
      *
      * @param requiredCapacity The capacity to check for.
      * @return <tt>true</tt> If the specified <tt>requiredCapacity</tt> is available
-     * <tt>false</tt> if now.
+     * <tt>false</tt> if not.
      */
     public boolean hasAvailableCapacity(int requiredCapacity)
     {

diff --git a/src/main/java/com/lmax/disruptor/Sequencer.java b/src/main/java/com/lmax/disruptor/Sequencer.java
@@ -82,7 +82,7 @@ public interface Sequencer extends Cursored, Sequenced
      * in the Sequencer.  The scan will range from nextSequence to availableSequence.  If
      * there are no available values <code>&gt;= nextSequence</code> the return value will be
      * <code>nextSequence - 1</code>.  To work correctly a consumer should pass a value that
-     * it 1 higher than the last sequence that was successfully processed.
+     * is 1 higher than the last sequence that was successfully processed.
      *
      * @param nextSequence      The sequence to start scanning from.
      * @param availableSequence The sequence to scan to.

diff --git a/src/main/java/com/lmax/disruptor/dsl/EventProcessorInfo.java b/src/main/java/com/lmax/disruptor/dsl/EventProcessorInfo.java
@@ -27,7 +27,7 @@
  * <p>
  * <p>Tracks the event processor instance, the event handler instance, and sequence barrier which the stage is attached to.</p>
  *
- * @param T the type of the configured {@link EventHandler}
+ * @param <T> the type of the configured {@link EventHandler}
  */
 class EventProcessorInfo<T> implements ConsumerInfo
 {

diff --git a/src/perftest/java/com/lmax/disruptor/sequenced/ThreeToOneSequencedBatchThroughputTest.java b/src/perftest/java/com/lmax/disruptor/sequenced/ThreeToOneSequencedBatchThroughputTest.java
@@ -76,9 +76,7 @@
  * EP1 - EventProcessor 1
  *
  * </pre>
- */
-
-/**
+ *
  * @author mikeb01
  */
 public final class ThreeToOneSequencedBatchThroughputTest extends AbstractPerfTestDisruptor

diff --git a/src/test/java/com/lmax/disruptor/RingBufferTest.java b/src/test/java/com/lmax/disruptor/RingBufferTest.java
@@ -1240,13 +1240,13 @@ public void shouldAddAndRemoveSequences() throws Exception
     }
 
     @Test
-    public void shouldHandleResetToAndNotWrapUnecessarilySingleProducer() throws Exception
+    public void shouldHandleResetToAndNotWrapUnnecessarilySingleProducer() throws Exception
     {
         assertHandleResetAndNotWrap(RingBuffer.createSingleProducer(StubEvent.EVENT_FACTORY, 4));
     }
 
     @Test
-    public void shouldHandleResetToAndNotWrapUnecessarilyMultiProducer() throws Exception
+    public void shouldHandleResetToAndNotWrapUnnecessarilyMultiProducer() throws Exception
     {
         assertHandleResetAndNotWrap(RingBuffer.createMultiProducer(StubEvent.EVENT_FACTORY, 4));
     }

diff --git a/src/test/java/com/lmax/disruptor/RingBufferWithMocksTest.java b/src/test/java/com/lmax/disruptor/RingBufferWithMocksTest.java
@@ -35,7 +35,7 @@ public void setUp()
     }
 
     @Test
-    public void shouldDelgateNextAndPublish()
+    public void shouldDelegateNextAndPublish()
     {
         final org.jmock.Sequence sequence = mockery.sequence("publication sequence");
         mockery.checking(
@@ -55,7 +55,7 @@ public void shouldDelgateNextAndPublish()
     }
 
     @Test
-    public void shouldDelgateTryNextAndPublish() throws Exception
+    public void shouldDelegateTryNextAndPublish() throws Exception
     {
         final org.jmock.Sequence sequence = mockery.sequence("publication sequence");
         mockery.checking(
@@ -75,7 +75,7 @@ public void shouldDelgateTryNextAndPublish() throws Exception
     }
 
     @Test
-    public void shouldDelgateNextNAndPublish() throws Exception
+    public void shouldDelegateNextNAndPublish() throws Exception
     {
         final org.jmock.Sequence sequence = mockery.sequence("publication sequence");
         mockery.checking(
@@ -96,7 +96,7 @@ public void shouldDelgateNextNAndPublish() throws Exception
     }
 
     @Test
-    public void shouldDelgateTryNextNAndPublish() throws Exception
+    public void shouldDelegateTryNextNAndPublish() throws Exception
     {
         final org.jmock.Sequence sequence = mockery.sequence("publication sequence");
         mockery.checking(