Skip to content

ORC-2128: Add since Javadoc tags to all public orc-core class/interface/enum - #2577

Closed
dongjoon-hyun wants to merge 1 commit into
apache:mainfrom
dongjoon-hyun:ORC-2128
Closed

ORC-2128: Add since Javadoc tags to all public orc-core class/interface/enum#2577
dongjoon-hyun wants to merge 1 commit into
apache:mainfrom
dongjoon-hyun:ORC-2128

Conversation

@dongjoon-hyun

@dongjoon-hyun dongjoon-hyun commented Mar 10, 2026

Copy link
Copy Markdown
Member

What changes were proposed in this pull request?

This PR adds since Javadoc tags to all public classes, interfaces, and enums in orc-core module. The version for each since tag was determined from git history by finding the earliest release tag (rel/release-*) containing the commit that first introduced each file.

  • Skipped third-party vendored code under org.threeten.extra.chrono
  • Skipped package-private classes

Why are the changes needed?

The since Javadoc tag is a standard practice for documenting API versioning in Java libraries. Currently, only 3 out of 162+ public types in orc-core have since tags. Adding these tags improves API documentation and helps users understand which version introduced each class.

How was this patch tested?

Pass the CIs and manual review.

Was this patch authored or co-authored using generative AI tooling?

Generated-by: Claude Code (Claude Opus 4.6)

@dongjoon-hyun dongjoon-hyun added this to the 2.3.1 milestone Mar 10, 2026
@dongjoon-hyun
dongjoon-hyun marked this pull request as draft March 10, 2026 04:42
@dongjoon-hyun
dongjoon-hyun force-pushed the ORC-2128 branch 2 times, most recently from 7c23d61 to 7619900 Compare March 10, 2026 05:07
@dongjoon-hyun
dongjoon-hyun marked this pull request as ready for review March 10, 2026 06:14
dongjoon-hyun added a commit that referenced this pull request Mar 10, 2026
…erface/enum

### What changes were proposed in this pull request?

This PR adds `since` Javadoc tags to all public classes, interfaces, and enums in `orc-core` module. The version for each `since` tag was determined from git history by finding the earliest release tag (`rel/release-*`) containing the commit that first introduced each file.

- Skipped third-party vendored code under `org.threeten.extra.chrono`
- Skipped package-private classes

### Why are the changes needed?

The `since` Javadoc tag is a standard practice for documenting API versioning in Java libraries. Currently, only 3 out of 162+ public types in `orc-core` have `since` tags. Adding these tags improves API documentation and helps users understand which version introduced each class.

### How was this patch tested?

Pass the CIs and manual review.

### Was this patch authored or co-authored using generative AI tooling?

Generated-by: Claude Code (Claude Opus 4.6)

Closes #2577 from dongjoon-hyun/ORC-2128.

Authored-by: Dongjoon Hyun <dongjoon@apache.org>
Signed-off-by: Dongjoon Hyun <dongjoon@apache.org>
(cherry picked from commit 3eaa9e6)
Signed-off-by: Dongjoon Hyun <dongjoon@apache.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant