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

javadoc search doesn't work #4358

Open
errael opened this issue Jul 18, 2023 · 0 comments
Open

javadoc search doesn't work #4358

errael opened this issue Jul 18, 2023 · 0 comments

Comments

@errael
Copy link

errael commented Jul 18, 2023

Javadoc search doesn't work

On the main page https://github.com/antlr/antlr4
in the README click Useful information > Java API and observe the javadoc at https://www.antlr.org/api/Java/index.html

In the javadoc's search box in the upper right enter "parser" and at the top of the list and observe org.antlr.v4.runtime.Parser enter return and observe https://www.antlr.org/api/Java/undefined/org/antlr/v4/runtime/Parser.html.
Note the undefined in the target URL along with 404: Page not found.

There is a workaround.

  • Download antlr4-runtime-4.13.0-javadoc.jar
  • Extract the files from the jar
  • on linux execute: ln -s . undefined
  • search works
  • do the search again
    Observe the search bar URL
    file:///.../javadoc-runtime/undefined/undefined/org/antlr/v4/runtime/Parser.html
    Note the undefined/undefined/. Get another undefined after every search.

(using a jar:file///.../xxx.jar!/index.html URL exhibit the same problem).

The workaround has problems

  • Have to extract the javadoc from the jar.
    Most jars can be accessed with firefox using jar:file///.../xxx.jar!/index.html
  • Can't see the file name in the URL bar after using it for a while, since the undefineds accumulate and shift the relevant bits off to the right.
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

No branches or pull requests

1 participant