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.

Sign up for GitHub

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

Jump to bottom

Use @link in docstrings #24

Open
PeterNaggschga opened this issue Apr 24, 2024 · 0 comments
Open

Use @link in docstrings #24

PeterNaggschga opened this issue Apr 24, 2024 · 0 comments
Assignees
@PeterNaggschga
Labels
documentation Improvements or additions to documentation

Comments

@PeterNaggschga
Copy link
Owner

Currently classes and their members are referenced using simple mentioning. While this works with the automatic linking of Doxygen, IntelliJ doesn't recognize those as links. Therefore every mention of members and classes should be annotated using the @link command.
@PeterNaggschga PeterNaggschga added the documentation Improvements or additions to documentation label Apr 24, 2024
@PeterNaggschga PeterNaggschga self-assigned this Apr 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@PeterNaggschga PeterNaggschga

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@PeterNaggschga