Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

"invalid reference" to flexible and surroud queryry parsers at QueryParser module javadoc #14086

Open
mkhludnev opened this issue Dec 23, 2024 · 3 comments

Comments

@mkhludnev
Copy link
Member

Description

see: https://lucene.apache.org/core/10_1_0/queryparser/index.html
lucene/queryparser/src/java/overview.html links flexible and surround parser packages, but these root packages are empty, and are not exported as empty (fwiw). Note: flexible/package-info contains valuable javadoc.
As a result, invalid reference labels are rendered at the linked page.

@mkhludnev
Copy link
Member Author

Screenshot from 2024-12-24 10-41-05

@pseudo-nymous
Copy link
Contributor

Since, these two package are empty (no classes present in root package), java doc doesn't run on it. This is an old bug which has not been resolved. More details: here

We can use a hacky solution to get around it by adding a placeholder class which can be removed once other classes are added to this package. What do you recommend?

@mkhludnev
Copy link
Member Author

Pardon. It's not my wheelhouse. Placeholder classes are going be madness. I'm afraid they will spill IDE's autocomplete popups.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants