apache / apache/arrow-java

[Java][Doc] Add JavaDoc to TransferPair interface

未关闭
#247 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
Component: Documentation Type: enhancement
主要语言
Java
星标
94
派生
152
平均合并
3 天 16 小时
30 天内合并 PR
11

描述

The TransferPair interface is important to the Java vector module's memory management, but there is only a single line class comment, and no comments for the methods. The implementations of those methods have subtitles that are hidden in the method names. For example, the method transferTo() clears the memory in the original vector and resets the rowCount to 0, but splitAndTransferTo() only copies the values into new memory and the original is unchanged.  

**Reporter**: [Larry White](https://issues.apache.org/jira/browse/ARROW-17570) / @lwhite1

**Note**: *This issue was originally created as [ARROW-17570](https://issues.apache.org/jira/browse/ARROW-17570). Please see the [migration documentation](https://github.com/apache/arrow/issues/14542) for further details.*

贡献指南

打开贡献指南

调研方向

Locate the Java vector module's TransferPair interface and read its method declarations alongside their implementations. Add JavaDoc describing the distinct memory and row-count behavior of transferTo() and splitAndTransferTo(), and ensure all interface methods are documented.

由索引模型根据 Issue 内容生成。

评估

技术栈
java
领域
backend
Issue 类型
文档
难度
2/5
预计耗时
1-3 小时
活跃度
停滞
描述清晰度
基本清楚
新手友好度
45/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。