Skip to content

Commit

Permalink
Remove <tt> tags from javadoc.
Browse files Browse the repository at this point in the history
  • Loading branch information
mikeb01 committed Jan 9, 2019
1 parent 74f4107 commit 6d90284
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 10 deletions.
14 changes: 7 additions & 7 deletions src/main/java/com/lmax/disruptor/RingBuffer.java
Expand Up @@ -147,7 +147,7 @@ public static <E> RingBuffer<E> createMultiProducer(
* @param factory used to create the events within the ring buffer.
* @param bufferSize number of elements to create within the ring buffer.
* @return a constructed ring buffer.
* @throws IllegalArgumentException if <tt>bufferSize</tt> is less than 1 or not a power of 2
* @throws IllegalArgumentException if <code>bufferSize</code> is less than 1 or not a power of 2
* @see MultiProducerSequencer
*/
public static <E> RingBuffer<E> createMultiProducer(EventFactory<E> factory, int bufferSize)
Expand Down Expand Up @@ -183,7 +183,7 @@ public static <E> RingBuffer<E> createSingleProducer(
* @param factory used to create the events within the ring buffer.
* @param bufferSize number of elements to create within the ring buffer.
* @return a constructed ring buffer.
* @throws IllegalArgumentException if <tt>bufferSize</tt> is less than 1 or not a power of 2
* @throws IllegalArgumentException if <code>bufferSize</code> is less than 1 or not a power of 2
* @see MultiProducerSequencer
*/
public static <E> RingBuffer<E> createSingleProducer(EventFactory<E> factory, int bufferSize)
Expand Down Expand Up @@ -388,7 +388,7 @@ public long getMinimumGatingSequence()
* Remove the specified sequence from this ringBuffer.
*
* @param sequence to be removed.
* @return <tt>true</tt> if this sequence was found, <tt>false</tt> otherwise.
* @return <code>true</code> if this sequence was found, <code>false</code> otherwise.
*/
public boolean removeGatingSequence(Sequence sequence)
{
Expand Down Expand Up @@ -441,14 +441,14 @@ public int getBufferSize()
}

/**
* Given specified <tt>requiredCapacity</tt> determines if that amount of space
* is available. Note, you can not assume that if this method returns <tt>true</tt>
* Given specified <code>requiredCapacity</code> determines if that amount of space
* is available. Note, you can not assume that if this method returns <code>true</code>
* that a call to {@link RingBuffer#next()} will not block. Especially true if this
* ring buffer is set up to handle multiple producers.
*
* @param requiredCapacity The capacity to check for.
* @return <tt>true</tt> If the specified <tt>requiredCapacity</tt> is available
* <tt>false</tt> if not.
* @return <code>true</code> If the specified <code>requiredCapacity</code> is available
* <code>false</code> if not.
*/
public boolean hasAvailableCapacity(int requiredCapacity)
{
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/lmax/disruptor/Sequencer.java
Expand Up @@ -53,7 +53,7 @@ public interface Sequencer extends Cursored, Sequenced
* Remove the specified sequence from this sequencer.
*
* @param sequence to be removed.
* @return <tt>true</tt> if this sequence was found, <tt>false</tt> otherwise.
* @return <code>true</code> if this sequence was found, <code>false</code> otherwise.
*/
boolean removeGatingSequence(Sequence sequence);

Expand Down
4 changes: 2 additions & 2 deletions src/main/java/com/lmax/disruptor/dsl/EventHandlerGroup.java
Expand Up @@ -45,7 +45,7 @@ public class EventHandlerGroup<T>
}

/**
* Create a new event handler group that combines the consumers in this group with <tt>otherHandlerGroup</tt>.
* Create a new event handler group that combines the consumers in this group with <code>otherHandlerGroup</code>.
*
* @param otherHandlerGroup the event handler group to combine.
* @return a new EventHandlerGroup combining the existing and new consumers into a single dependency group.
Expand All @@ -61,7 +61,7 @@ public EventHandlerGroup<T> and(final EventHandlerGroup<T> otherHandlerGroup)
}

/**
* Create a new event handler group that combines the handlers in this group with <tt>processors</tt>.
* Create a new event handler group that combines the handlers in this group with <code>processors</code>.
*
* @param processors the processors to combine.
* @return a new EventHandlerGroup combining the existing and new processors into a single dependency group.
Expand Down

0 comments on commit 6d90284

Please sign in to comment.