apache / apache/lucene

@since tags missing from Javadocs [LUCENE-1952]

Open
#3,027 3 comments 0 reactions 0 assignees View on GitHub
legacy-jira-priority:Minor type:documentation type:enhancement
Dominant language
Java
Stars
3.6k
Forks
1.4k
Avg merge
2d 11h
Merged PRs (30d)
88

Description

It would be useful to be able to see at which version classes/methods have been added by adding the `@since` javadoc tag. I use quite an old version of Lucene that is integrated into the CMS I use, and often find that they features I need to use are not supported in the version I have.

---
Migrated from [LUCENE-1952](https://issues.apache.org/jira/browse/LUCENE-1952) by Chris Pilsworth (@cpilsworth), updated Nov 30 2013

Contributor guide

Open the contributing guide

Research direction

The issue does not identify files, classes, methods, or a release range to update. Start by surveying Lucene's public API Javadocs and existing @since usage, then establish the scope and version history needed before adding tags consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
backend, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.