Skip to content

Commit b4ea92c

Browse files
mapleFUfacebook-github-bot
authored andcommitted
Fix docstring in DwrfReader and BaseVector.h (facebookincubator#10601)
Summary: Pull Request resolved: facebookincubator#10601 Reviewed By: pedroerp Differential Revision: D60527127 Pulled By: kagamiori fbshipit-source-id: ef2fabb8a7173c0f9774c7a77bbcc7fa56de643e
1 parent 97ad9ad commit b4ea92c

File tree

4 files changed

+8
-11
lines changed

4 files changed

+8
-11
lines changed

velox/dwio/common/SelectiveColumnReader.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ class SelectiveColumnReader {
151151
/**
152152
* Read the next group of values into a RowVector.
153153
* @param numValues the number of values to read
154-
* @param vector to read into
154+
* @param result vector to read into
155155
*/
156156
virtual void
157157
next(uint64_t /*numValues*/, VectorPtr& /*result*/, const Mutation*) {

velox/dwio/dwrf/reader/DwrfReader.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ class DwrfRowReader : public StrideIndexProvider,
4848
public:
4949
/**
5050
* Constructor that lets the user specify additional options.
51-
* @param contents of the file
51+
* @param reader contents of the file
5252
* @param options options for reading
5353
*/
5454
DwrfRowReader(
@@ -328,7 +328,7 @@ class DwrfReader : public dwio::common::Reader {
328328

329329
/**
330330
* Create a reader to the for the dwrf file.
331-
* @param stream the stream to read
331+
* @param input the stream to read
332332
* @param options the options for reading the file
333333
*/
334334
static std::unique_ptr<DwrfReader> create(

velox/row/UnsafeRowDeserializers.h

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -287,8 +287,6 @@ struct ArrayBatchIterator : UnsafeRowDataBatchIterator {
287287
/**
288288
* Constructor for UnsafeRowArray.
289289
* @param data A batch of unsafe row array representation data.
290-
* @param isFixedLength whether the elements in the array is fixed length
291-
* @param fixedDataWidth the data width if the element is fixed length
292290
*/
293291
ArrayBatchIterator(
294292
const std::vector<std::optional<std::string_view>>& data,
@@ -556,7 +554,7 @@ struct UnsafeRowPrimitiveBatchDeserializer {
556554
struct UnsafeRowDeserializer {
557555
/**
558556
* Allocate and populate the metadata Vectors in ArrayVector or MapVector.
559-
* @param dataIterators iterator that points to whole column batch of data.
557+
* @param dataIterator iterator that points to whole column batch of data.
560558
* process.
561559
* @param pool
562560
* @param size
@@ -613,7 +611,7 @@ struct UnsafeRowDeserializer {
613611

614612
/**
615613
* Converts a list of MapBatchIterators to Vectors.
616-
* @param dataIterators iterator that points to whole column batch of data.
614+
* @param dataIterator iterator that points to whole column batch of data.
617615
* @param pool
618616
* @return a MapVectorPtr
619617
*/
@@ -789,10 +787,9 @@ struct UnsafeRowDeserializer {
789787

790788
/**
791789
* Calls createFlatVector with the correct template argument.
792-
* @param dataIterators iterator that points to the first dataIterator to
790+
* @param dataIterator iterator that points to the first dataIterator to
793791
* process.
794792
* @param pool
795-
* @param numIteratorsToProcess
796793
* @return A FlatVector
797794
*/
798795
static VectorPtr convertPrimitiveIteratorsToVectors(

velox/vector/BaseVector.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -931,7 +931,7 @@ class BaseVector {
931931
};
932932

933933
/// Loops over rows in 'ranges' and invokes 'func' for each row.
934-
/// @param TFunc A void function taking two arguments: targetIndex and
934+
/// @param func A void function taking two arguments: targetIndex and
935935
/// sourceIndex.
936936
template <typename TFunc>
937937
void applyToEachRow(
@@ -945,7 +945,7 @@ void applyToEachRow(
945945
}
946946

947947
/// Loops over 'ranges' and invokes 'func' for each range.
948-
/// @param TFunc A void function taking 3 arguments: targetIndex, sourceIndex
948+
/// @param func A void function taking 3 arguments: targetIndex, sourceIndex
949949
/// and count.
950950
template <typename TFunc>
951951
void applyToEachRange(

0 commit comments

Comments
 (0)