arrow-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From w...@apache.org
Subject arrow git commit: ARROW-10: Fix mismatch of javadoc names and method parameters
Date Fri, 04 Mar 2016 00:16:03 GMT
Repository: arrow
Updated Branches:
  refs/heads/master 307977e39 -> 0c95d3cc6


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


Project: http://git-wip-us.apache.org/repos/asf/arrow/repo
Commit: http://git-wip-us.apache.org/repos/asf/arrow/commit/0c95d3cc
Tree: http://git-wip-us.apache.org/repos/asf/arrow/tree/0c95d3cc
Diff: http://git-wip-us.apache.org/repos/asf/arrow/diff/0c95d3cc

Branch: refs/heads/master
Commit: 0c95d3cc6d954128bf400598878ad9c4228ccbce
Parents: 307977e
Author: proflin <proflin.me@gmail.com>
Authored: Thu Mar 3 16:16:28 2016 -0800
Committer: Wes McKinney <wesm@apache.org>
Committed: Thu Mar 3 16:16:28 2016 -0800

----------------------------------------------------------------------
 .../main/java/org/apache/arrow/memory/AllocationManager.java    | 5 ++---
 .../java/org/apache/arrow/memory/AllocatorClosedException.java  | 5 +++--
 .../src/main/java/org/apache/arrow/memory/BufferManager.java    | 1 +
 .../src/main/java/org/apache/arrow/memory/ChildAllocator.java   | 5 +----
 .../main/java/org/apache/arrow/memory/util/HistoricalLog.java   | 2 +-
 .../src/main/java/org/apache/arrow/vector/AllocationHelper.java | 2 +-
 .../org/apache/arrow/vector/complex/ContainerVectorLike.java    | 2 +-
 7 files changed, 10 insertions(+), 12 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/arrow/blob/0c95d3cc/java/memory/src/main/java/org/apache/arrow/memory/AllocationManager.java
----------------------------------------------------------------------
diff --git a/java/memory/src/main/java/org/apache/arrow/memory/AllocationManager.java b/java/memory/src/main/java/org/apache/arrow/memory/AllocationManager.java
index 37d1d34..43ee9c1 100644
--- a/java/memory/src/main/java/org/apache/arrow/memory/AllocationManager.java
+++ b/java/memory/src/main/java/org/apache/arrow/memory/AllocationManager.java
@@ -328,7 +328,8 @@ public class AllocationManager {
      * 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 class AllocationManager {
      *          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) {

http://git-wip-us.apache.org/repos/asf/arrow/blob/0c95d3cc/java/memory/src/main/java/org/apache/arrow/memory/AllocatorClosedException.java
----------------------------------------------------------------------
diff --git a/java/memory/src/main/java/org/apache/arrow/memory/AllocatorClosedException.java
b/java/memory/src/main/java/org/apache/arrow/memory/AllocatorClosedException.java
index 5664579..3274642 100644
--- a/java/memory/src/main/java/org/apache/arrow/memory/AllocatorClosedException.java
+++ b/java/memory/src/main/java/org/apache/arrow/memory/AllocatorClosedException.java
@@ -20,11 +20,12 @@ package org.apache.arrow.memory;
 /**
  * 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);
   }

http://git-wip-us.apache.org/repos/asf/arrow/blob/0c95d3cc/java/memory/src/main/java/org/apache/arrow/memory/BufferManager.java
----------------------------------------------------------------------
diff --git a/java/memory/src/main/java/org/apache/arrow/memory/BufferManager.java b/java/memory/src/main/java/org/apache/arrow/memory/BufferManager.java
index d6470fa..8969434 100644
--- a/java/memory/src/main/java/org/apache/arrow/memory/BufferManager.java
+++ b/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);
 

http://git-wip-us.apache.org/repos/asf/arrow/blob/0c95d3cc/java/memory/src/main/java/org/apache/arrow/memory/ChildAllocator.java
----------------------------------------------------------------------
diff --git a/java/memory/src/main/java/org/apache/arrow/memory/ChildAllocator.java b/java/memory/src/main/java/org/apache/arrow/memory/ChildAllocator.java
index 6f120e5..11c9063 100644
--- a/java/memory/src/main/java/org/apache/arrow/memory/ChildAllocator.java
+++ b/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,

http://git-wip-us.apache.org/repos/asf/arrow/blob/0c95d3cc/java/memory/src/main/java/org/apache/arrow/memory/util/HistoricalLog.java
----------------------------------------------------------------------
diff --git a/java/memory/src/main/java/org/apache/arrow/memory/util/HistoricalLog.java b/java/memory/src/main/java/org/apache/arrow/memory/util/HistoricalLog.java
index 38cb779..c9b5c53 100644
--- a/java/memory/src/main/java/org/apache/arrow/memory/util/HistoricalLog.java
+++ b/java/memory/src/main/java/org/apache/arrow/memory/util/HistoricalLog.java
@@ -126,7 +126,7 @@ public class HistoricalLog {
   /**
    *
    * @param sb
-   * @param indexLevel
+   * @param indent
    * @param includeStackTrace
    */
   public synchronized void buildHistory(final StringBuilder sb, int indent, boolean includeStackTrace)
{

http://git-wip-us.apache.org/repos/asf/arrow/blob/0c95d3cc/java/vector/src/main/java/org/apache/arrow/vector/AllocationHelper.java
----------------------------------------------------------------------
diff --git a/java/vector/src/main/java/org/apache/arrow/vector/AllocationHelper.java b/java/vector/src/main/java/org/apache/arrow/vector/AllocationHelper.java
index 54c3cd7..15c3a02 100644
--- a/java/vector/src/main/java/org/apache/arrow/vector/AllocationHelper.java
+++ b/java/vector/src/main/java/org/apache/arrow/vector/AllocationHelper.java
@@ -49,7 +49,7 @@ public class AllocationHelper {
    * 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) {

http://git-wip-us.apache.org/repos/asf/arrow/blob/0c95d3cc/java/vector/src/main/java/org/apache/arrow/vector/complex/ContainerVectorLike.java
----------------------------------------------------------------------
diff --git a/java/vector/src/main/java/org/apache/arrow/vector/complex/ContainerVectorLike.java
b/java/vector/src/main/java/org/apache/arrow/vector/complex/ContainerVectorLike.java
index e50b0d0..655b55a 100644
--- a/java/vector/src/main/java/org/apache/arrow/vector/complex/ContainerVectorLike.java
+++ b/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);


Mime
View raw message