Prevent @lucene.internal annotated classes from being in Javadocs [LUCENE-7129]
Open
legacy-jira-priority:Minor
type:documentation
type:task
- Dominant language
- Java
- Stars
- 3.6k
- Forks
- 1.4k
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 88
Description
It would be cool if we could prevent ``@lucene`.internal` classes from appearing in Javadocs we publish. This would further discourage use of internal Lucene/Solr classes that are public not for public consumption but only public so that the code can be accessed across Lucene/Solr's packages.
---
Migrated from [LUCENE-7129](https://issues.apache.org/jira/browse/LUCENE-7129) by David Smiley (@dsmiley)
Contributor guide
Research direction
No files, tests, or entry points are named. Start by locating the Javadoc publishing configuration and the definition or processing of the @lucene.internal annotation. Done means published Javadocs omit classes marked internal while retaining intended public classes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100