Fix docstring in DwrfReader and BaseVector.h (#10601)

Summary: Pull Request resolved: #10601 Reviewed By: pedroerp Differential Revision: D60527127 Pulled By: kagamiori fbshipit-source-id: ef2fabb8a7173c0f9774c7a77bbcc7fa56de643e
facebookincubator · Aug 1, 2024 · b4ea92c · b4ea92c
1 parent 97ad9ad
commit b4ea92c
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 11 deletions.
diff --git a/velox/dwio/common/SelectiveColumnReader.h b/velox/dwio/common/SelectiveColumnReader.h
@@ -151,7 +151,7 @@ class SelectiveColumnReader {
   /**
    * Read the next group of values into a RowVector.
    * @param numValues the number of values to read
-   * @param vector to read into
+   * @param result vector to read into
    */
   virtual void
   next(uint64_t /*numValues*/, VectorPtr& /*result*/, const Mutation*) {

diff --git a/velox/dwio/dwrf/reader/DwrfReader.h b/velox/dwio/dwrf/reader/DwrfReader.h
@@ -48,7 +48,7 @@ class DwrfRowReader : public StrideIndexProvider,
  public:
   /**
    * Constructor that lets the user specify additional options.
-   * @param contents of the file
+   * @param reader contents of the file
    * @param options options for reading
    */
   DwrfRowReader(
@@ -328,7 +328,7 @@ class DwrfReader : public dwio::common::Reader {
 
   /**
    * Create a reader to the for the dwrf file.
-   * @param stream the stream to read
+   * @param input the stream to read
    * @param options the options for reading the file
    */
   static std::unique_ptr<DwrfReader> create(

diff --git a/velox/row/UnsafeRowDeserializers.h b/velox/row/UnsafeRowDeserializers.h
@@ -287,8 +287,6 @@ struct ArrayBatchIterator : UnsafeRowDataBatchIterator {
   /**
    * Constructor for UnsafeRowArray.
    * @param data A batch of unsafe row array representation data.
-   * @param isFixedLength whether the elements in the array is fixed length
-   * @param fixedDataWidth the data width if the element is fixed length
    */
   ArrayBatchIterator(
       const std::vector<std::optional<std::string_view>>& data,
@@ -556,7 +554,7 @@ struct UnsafeRowPrimitiveBatchDeserializer {
 struct UnsafeRowDeserializer {
   /**
    * Allocate and populate the metadata Vectors in ArrayVector or MapVector.
-   * @param dataIterators iterator that points to whole column batch of data.
+   * @param dataIterator iterator that points to whole column batch of data.
    * process.
    * @param pool
    * @param size
@@ -613,7 +611,7 @@ struct UnsafeRowDeserializer {
 
   /**
    * Converts a list of MapBatchIterators to Vectors.
-   * @param dataIterators iterator that points to whole column batch of data.
+   * @param dataIterator iterator that points to whole column batch of data.
    * @param pool
    * @return a MapVectorPtr
    */
@@ -789,10 +787,9 @@ struct UnsafeRowDeserializer {
 
   /**
    * Calls createFlatVector with the correct template argument.
-   * @param dataIterators iterator that points to the first dataIterator to
+   * @param dataIterator iterator that points to the first dataIterator to
    * process.
    * @param pool
-   * @param numIteratorsToProcess
    * @return A FlatVector
    */
   static VectorPtr convertPrimitiveIteratorsToVectors(

diff --git a/velox/vector/BaseVector.h b/velox/vector/BaseVector.h
@@ -931,7 +931,7 @@ class BaseVector {
 };
 
 /// Loops over rows in 'ranges' and invokes 'func' for each row.
-/// @param TFunc A void function taking two arguments: targetIndex and
+/// @param func A void function taking two arguments: targetIndex and
 /// sourceIndex.
 template <typename TFunc>
 void applyToEachRow(
@@ -945,7 +945,7 @@ void applyToEachRow(
 }
 
 /// Loops over 'ranges' and invokes 'func' for each range.
-/// @param TFunc A void function taking 3 arguments: targetIndex, sourceIndex
+/// @param func A void function taking 3 arguments: targetIndex, sourceIndex
 /// and count.
 template <typename TFunc>
 void applyToEachRange(