-
-
Notifications
You must be signed in to change notification settings - Fork 170
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
Javascript gets rid of code links in documentation #1364
Comments
we can't fix this, you need to log the issue with doxygen not actually sure it's supposed to work how you want it to work anyway? the code blocks look ugly with links in them IMHO |
The links don't necessarily have to be blue, it could just be white |
Actually, this doesn't look like a doxygen issue at all. The issue is with the syntax highlighting which gets rid of all the links. Unfortunately, I don't think there's an easy solution to this. I would prefer disabling the highlighting entirely and just relying on what doxygen produces, since being able to go to the relevant symbol documentation with a single click is such a useful feature (as are the side/top navigation bars which don't appear when javascript is disabled). |
i'd rather not use the syntax highlighting doxygen produces. It is far inferior, doesnt support line numbers, its highlighting is iffy, the syntax highlighting plugin we selected is far better as it supports far more language types, and much nicer theming than the one built into doxygen. |
Not having links is also quite a hinderance though, it means the user has to search through multiple menus to find the documentation for a certain symbol (which is quite a common occurrence because obviously the examples can't cover every overload/member and often can't effectively convey types) |
Git commit reference
Whatever commit dpp.dev is using when this issue was created
Describe the bug
For some reason, if javascript is enabled, links to dpp symbols found within code blocks will not work. Disabling javascript fixes this.
To Reproduce
Steps to reproduce the behavior:
Expected behavior
The symbol names should be clickable and open the relevant documentation
Screenshots
Javascript enabled: cursor (you can't see it but it is an "I-beam") hovering over dpp::cluster, nothing happens
Javascript disabled: cursor (pointing hand) hovering over dpp::cluster, link underline and link preview appear
System Details:
Additional context
Add any other context about the problem here.
The text was updated successfully, but these errors were encountered: