ARROW-10: Fix mismatch of javadoc names and method parameters

Author: proflin <proflin.me@gmail.com>
Author: Liwei Lin <proflin.me@gmail.com>

Closes #3 from proflin/ARROW-10--Fix-mismatch-of-javadoc-names-and-method-parameters and squashes the following commits:

99366ab [Liwei Lin] ARROW-10: Fix mismatch of javadoc names and method parameters
9186cb3 [proflin] ARROW-10: Fix mismatch of javadoc names and method parameters
2b1313e [proflin] Fix mismatch of javadoc names and method parameters

java/memory/src/main/java/org/apache/arrow/memory/AllocationManager.java

@@ -328,7 +328,8 @@ public int decrement(int decrement) {
  * destroyed before use.
  *
  * @param allocator
- * @return
+ * A BufferAllocator.
+ * @return The ledger associated with the BufferAllocator.
  */
  public BufferLedger getLedgerForAllocator(BufferAllocator allocator) {
  return associate((BaseAllocator) allocator);
@@ -356,8 +357,6 @@ public ArrowBuf newArrowBuf(int offset, int length) {
  * The length in bytes that this ArrowBuf will provide access to.
  * @param manager
  * An optional BufferManager argument that can be used to manage expansion of this ArrowBuf
- * @param retain
- * Whether or not the newly created buffer should get an additional reference count added to it.
  * @return A new ArrowBuf that shares references with all ArrowBufs associated with this BufferLedger
  */
  public ArrowBuf newArrowBuf(int offset, int length, BufferManager manager) {

java/memory/src/main/java/org/apache/arrow/memory/AllocatorClosedException.java

@@ -20,11 +20,12 @@
 /**
  * Exception thrown when a closed BufferAllocator is used. Note
  * this is an unchecked exception.
- *
- * @param message string associated with the cause
  */
 @SuppressWarnings("serial")
 public class AllocatorClosedException extends RuntimeException {
+ /**
+ * @param message string associated with the cause
+ */
  public AllocatorClosedException(String message) {
  super(message);
  }

java/memory/src/main/java/org/apache/arrow/memory/BufferManager.java

@@ -43,6 +43,7 @@ public interface BufferManager extends AutoCloseable {
  * @param newSize
  * Size of new replacement buffer.
  * @return
+ * A new version of the buffer.
  */
  public ArrowBuf replace(ArrowBuf old, int newSize);
 

java/memory/src/main/java/org/apache/arrow/memory/ChildAllocator.java

@@ -31,15 +31,12 @@ class ChildAllocator extends BaseAllocator {
  * Constructor.
  *
  * @param parentAllocator parent allocator -- the one creating this child
- * @param allocatorOwner a handle to the object making the request
- * @param allocationPolicy the allocation policy to use; the policy for all
- * allocators must match for each invocation of a drillbit
+ * @param name the name of this child allocator
  * @param initReservation initial amount of space to reserve (obtained from the parent)
  * @param maxAllocation maximum amount of space that can be obtained from this allocator;
  * note this includes direct allocations (via {@see BufferAllocator#buffer(int, int)}
  * et al) and requests from descendant allocators. Depending on the allocation policy in
  * force, even less memory may be available
- * @param flags one or more of BaseAllocator.F_* flags
  */
  ChildAllocator(
  BaseAllocator parentAllocator,

java/memory/src/main/java/org/apache/arrow/memory/util/HistoricalLog.java

@@ -126,7 +126,7 @@ public void buildHistory(final StringBuilder sb, boolean includeStackTrace) {
  /**
  *
  * @param sb
- * @param indexLevel
+ * @param indent
  * @param includeStackTrace
  */
  public synchronized void buildHistory(final StringBuilder sb, int indent, boolean includeStackTrace) {

java/vector/src/main/java/org/apache/arrow/vector/AllocationHelper.java

@@ -49,7 +49,7 @@ public static void allocate(ValueVector v, int valueCount, int bytesPerValue, in
  * Allocates the exact amount if v is fixed width, otherwise falls back to dynamic allocation
  * @param v value vector we are trying to allocate
  * @param valueCount size we are trying to allocate
- * @throws org.apache.drill.exec.memory.OutOfMemoryException if it can't allocate the memory
+ * @throws org.apache.arrow.memory.OutOfMemoryException if it can't allocate the memory
  */
  public static void allocateNew(ValueVector v, int valueCount) {
  if (v instanceof FixedWidthVector) {

java/vector/src/main/java/org/apache/arrow/vector/complex/ContainerVectorLike.java

@@ -31,7 +31,7 @@ public interface ContainerVectorLike {
  *
  * @param descriptor vector descriptor
  * @return result of operation wrapping vector corresponding to the given descriptor and whether it's newly created
- * @throws org.apache.drill.common.exceptions.DrillRuntimeException
+ * @throws org.apache.arrow.vector.util.SchemaChangeRuntimeException
  * if schema change is not permissible between the given and existing data vector types.
  */
  <T extends ValueVector> AddOrGetResult<T> addOrGetVector(VectorDescriptor descriptor);