parquet-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From b...@apache.org
Subject parquet-mr git commit: PARQUET-421: Fix mismatch of javadoc names and method parameters in m...
Date Tue, 12 Jan 2016 22:21:42 GMT
Repository: parquet-mr
Updated Branches:
  refs/heads/master 37f72dc07 -> 84b2b7417


PARQUET-421: Fix mismatch of javadoc names and method parameters in m...

…odule encoding, column, and hadoop

Codes change now and then, but some corresponding doc comments are left out.

This PR fixes only the doc comments that should have been changed. It should be OK, since
none codes are touched.

@rdblue could you take a look please? Cheers.

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

Closes #307 from proflin/Minor--Fix-the-mismatch-of-the-parameters-and-their-doc-comments-in-module-encoding,-column,-and-hadoop
and squashes the following commits:

34c7b01 [proflin] Minor: Fix the mismatch of the parameters and their doc comments in module
encoding, column, and hadoop


Project: http://git-wip-us.apache.org/repos/asf/parquet-mr/repo
Commit: http://git-wip-us.apache.org/repos/asf/parquet-mr/commit/84b2b741
Tree: http://git-wip-us.apache.org/repos/asf/parquet-mr/tree/84b2b741
Diff: http://git-wip-us.apache.org/repos/asf/parquet-mr/diff/84b2b741

Branch: refs/heads/master
Commit: 84b2b74179da8e279e2fafdafd031748c285e1b7
Parents: 37f72dc
Author: proflin <proflin.me@gmail.com>
Authored: Tue Jan 12 14:21:32 2016 -0800
Committer: Ryan Blue <blue@apache.org>
Committed: Tue Jan 12 14:21:32 2016 -0800

----------------------------------------------------------------------
 .../org/apache/parquet/column/page/DataPageV1.java    |  4 ++--
 .../apache/parquet/column/values/ValuesWriter.java    | 14 +++++++-------
 .../column/values/plain/BooleanPlainValuesReader.java |  4 ++--
 .../java/org/apache/parquet/schema/TypeConverter.java |  2 +-
 .../parquet/column/values/bitpacking/BitPacking.java  |  2 +-
 .../parquet/hadoop/example/ExampleOutputFormat.java   |  6 +++---
 .../parquet/hadoop/metadata/ParquetMetadata.java      |  1 -
 7 files changed, 16 insertions(+), 17 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/parquet-mr/blob/84b2b741/parquet-column/src/main/java/org/apache/parquet/column/page/DataPageV1.java
----------------------------------------------------------------------
diff --git a/parquet-column/src/main/java/org/apache/parquet/column/page/DataPageV1.java b/parquet-column/src/main/java/org/apache/parquet/column/page/DataPageV1.java
old mode 100644
new mode 100755
index 2206517..6fbfe0c
--- a/parquet-column/src/main/java/org/apache/parquet/column/page/DataPageV1.java
+++ b/parquet-column/src/main/java/org/apache/parquet/column/page/DataPageV1.java
@@ -41,10 +41,10 @@ public class DataPageV1 extends DataPage {
    * @param valuesEncoding the values encoding for this page
    * @param dlEncoding
    */
-  public DataPageV1(BytesInput bytes, int valueCount, int uncompressedSize, Statistics<?>
stats, Encoding rlEncoding, Encoding dlEncoding, Encoding valuesEncoding) {
+  public DataPageV1(BytesInput bytes, int valueCount, int uncompressedSize, Statistics<?>
statistics, Encoding rlEncoding, Encoding dlEncoding, Encoding valuesEncoding) {
     super(Ints.checkedCast(bytes.size()), uncompressedSize, valueCount);
     this.bytes = bytes;
-    this.statistics = stats;
+    this.statistics = statistics;
     this.rlEncoding = rlEncoding;
     this.dlEncoding = dlEncoding;
     this.valuesEncoding = valuesEncoding;

http://git-wip-us.apache.org/repos/asf/parquet-mr/blob/84b2b741/parquet-column/src/main/java/org/apache/parquet/column/values/ValuesWriter.java
----------------------------------------------------------------------
diff --git a/parquet-column/src/main/java/org/apache/parquet/column/values/ValuesWriter.java
b/parquet-column/src/main/java/org/apache/parquet/column/values/ValuesWriter.java
old mode 100644
new mode 100755
index e5cf8e9..3862b02
--- a/parquet-column/src/main/java/org/apache/parquet/column/values/ValuesWriter.java
+++ b/parquet-column/src/main/java/org/apache/parquet/column/values/ValuesWriter.java
@@ -80,7 +80,7 @@ public abstract class ValuesWriter {
   }
 
   /**
-   * ( > {@link #getBufferedMemorySize} )
+   * ( > {@link #getBufferedSize} )
    * @return the allocated size of the buffer
    */
   abstract public long getAllocatedSize();
@@ -93,42 +93,42 @@ public abstract class ValuesWriter {
   }
 
   /**
-   * @param value the value to encode
+   * @param v the value to encode
    */
   public void writeBoolean(boolean v) {
     throw new UnsupportedOperationException(getClass().getName());
   }
 
   /**
-   * @param value the value to encode
+   * @param v the value to encode
    */
   public void writeBytes(Binary v) {
     throw new UnsupportedOperationException(getClass().getName());
   }
 
   /**
-   * @param value the value to encode
+   * @param v the value to encode
    */
   public void writeInteger(int v) {
     throw new UnsupportedOperationException(getClass().getName());
   }
 
   /**
-   * @param value the value to encode
+   * @param v the value to encode
    */
   public void writeLong(long v) {
     throw new UnsupportedOperationException(getClass().getName());
   }
 
   /**
-   * @param value the value to encode
+   * @param v the value to encode
    */
   public void writeDouble(double v) {
     throw new UnsupportedOperationException(getClass().getName());
   }
 
   /**
-   * @param value the value to encode
+   * @param v the value to encode
    */
   public void writeFloat(float v) {
     throw new UnsupportedOperationException(getClass().getName());

http://git-wip-us.apache.org/repos/asf/parquet-mr/blob/84b2b741/parquet-column/src/main/java/org/apache/parquet/column/values/plain/BooleanPlainValuesReader.java
----------------------------------------------------------------------
diff --git a/parquet-column/src/main/java/org/apache/parquet/column/values/plain/BooleanPlainValuesReader.java
b/parquet-column/src/main/java/org/apache/parquet/column/values/plain/BooleanPlainValuesReader.java
old mode 100644
new mode 100755
index c330490..a279938
--- a/parquet-column/src/main/java/org/apache/parquet/column/values/plain/BooleanPlainValuesReader.java
+++ b/parquet-column/src/main/java/org/apache/parquet/column/values/plain/BooleanPlainValuesReader.java
@@ -51,7 +51,7 @@ public class BooleanPlainValuesReader extends ValuesReader {
 
   /**
    * {@inheritDoc}
-   * @see org.apache.parquet.column.values.ValuesReader#skipBoolean()
+   * @see org.apache.parquet.column.values.ValuesReader#skip()
    */
   @Override
   public void skip() {
@@ -60,7 +60,7 @@ public class BooleanPlainValuesReader extends ValuesReader {
 
   /**
    * {@inheritDoc}
-   * @see org.apache.parquet.column.values.ValuesReader#initFromPage(byte[], int)
+   * @see org.apache.parquet.column.values.ValuesReader#initFromPage(int valueCount, ByteBuffer
page, int offset)
    */
   @Override
   public void initFromPage(int valueCount, ByteBuffer in, int offset) throws IOException
{

http://git-wip-us.apache.org/repos/asf/parquet-mr/blob/84b2b741/parquet-column/src/main/java/org/apache/parquet/schema/TypeConverter.java
----------------------------------------------------------------------
diff --git a/parquet-column/src/main/java/org/apache/parquet/schema/TypeConverter.java b/parquet-column/src/main/java/org/apache/parquet/schema/TypeConverter.java
old mode 100644
new mode 100755
index c22a877..8be896f
--- a/parquet-column/src/main/java/org/apache/parquet/schema/TypeConverter.java
+++ b/parquet-column/src/main/java/org/apache/parquet/schema/TypeConverter.java
@@ -22,7 +22,7 @@ import java.util.List;
 
 /**
  * to convert a MessageType tree
- * @see Type#convert(TypeConverter)
+ * @see Type#convert(List, TypeConverter)
  *
  * @author Julien Le Dem
  *

http://git-wip-us.apache.org/repos/asf/parquet-mr/blob/84b2b741/parquet-encoding/src/main/java/org/apache/parquet/column/values/bitpacking/BitPacking.java
----------------------------------------------------------------------
diff --git a/parquet-encoding/src/main/java/org/apache/parquet/column/values/bitpacking/BitPacking.java
b/parquet-encoding/src/main/java/org/apache/parquet/column/values/bitpacking/BitPacking.java
old mode 100644
new mode 100755
index c0acd11..7b557c7
--- a/parquet-encoding/src/main/java/org/apache/parquet/column/values/bitpacking/BitPacking.java
+++ b/parquet-encoding/src/main/java/org/apache/parquet/column/values/bitpacking/BitPacking.java
@@ -109,7 +109,7 @@ public class BitPacking {
   /**
    *
    * @param bitLength the width in bits of the integers to read
-   * @param inthe stream to read the bytes from
+   * @param in the stream to read the bytes from
    * @return the correct implementation for the width
    */
   public static BitPackingReader createBitPackingReader(int bitLength, InputStream in, long
valueCount) {

http://git-wip-us.apache.org/repos/asf/parquet-mr/blob/84b2b741/parquet-hadoop/src/main/java/org/apache/parquet/hadoop/example/ExampleOutputFormat.java
----------------------------------------------------------------------
diff --git a/parquet-hadoop/src/main/java/org/apache/parquet/hadoop/example/ExampleOutputFormat.java
b/parquet-hadoop/src/main/java/org/apache/parquet/hadoop/example/ExampleOutputFormat.java
old mode 100644
new mode 100755
index 08184da..d503e0d
--- a/parquet-hadoop/src/main/java/org/apache/parquet/hadoop/example/ExampleOutputFormat.java
+++ b/parquet-hadoop/src/main/java/org/apache/parquet/hadoop/example/ExampleOutputFormat.java
@@ -30,7 +30,7 @@ import org.apache.parquet.schema.MessageType;
  * An example output format
  *
  * must be provided the schema up front
- * @see ExampleOutputFormat#setSchema(Configuration, MessageType)
+ * @see ExampleOutputFormat#setSchema(Job, MessageType)
  * @see GroupWriteSupport#PARQUET_EXAMPLE_SCHEMA
  *
  * @author Julien Le Dem
@@ -40,8 +40,8 @@ public class ExampleOutputFormat extends ParquetOutputFormat<Group>
{
 
   /**
    * set the schema being written to the job conf
+   * @param job
    * @param schema the schema of the data
-   * @param configuration the job configuration
    */
   public static void setSchema(Job job, MessageType schema) {
     GroupWriteSupport.setSchema(schema, ContextUtil.getConfiguration(job));
@@ -49,7 +49,7 @@ public class ExampleOutputFormat extends ParquetOutputFormat<Group>
{
 
   /**
    * retrieve the schema from the conf
-   * @param configuration the job conf
+   * @param job
    * @return the schema
    */
   public static MessageType getSchema(Job job) {

http://git-wip-us.apache.org/repos/asf/parquet-mr/blob/84b2b741/parquet-hadoop/src/main/java/org/apache/parquet/hadoop/metadata/ParquetMetadata.java
----------------------------------------------------------------------
diff --git a/parquet-hadoop/src/main/java/org/apache/parquet/hadoop/metadata/ParquetMetadata.java
b/parquet-hadoop/src/main/java/org/apache/parquet/hadoop/metadata/ParquetMetadata.java
old mode 100644
new mode 100755
index a645117..cb6af54
--- a/parquet-hadoop/src/main/java/org/apache/parquet/hadoop/metadata/ParquetMetadata.java
+++ b/parquet-hadoop/src/main/java/org/apache/parquet/hadoop/metadata/ParquetMetadata.java
@@ -101,7 +101,6 @@ public class ParquetMetadata {
    *
    * @param fileMetaData file level metadata
    * @param blocks block level metadata
-   * @param keyValueMetaData
    */
   public ParquetMetadata(FileMetaData fileMetaData, List<BlockMetaData> blocks) {
     this.fileMetaData = fileMetaData;


Mime
View raw message