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

JavaDoc Links in Module Docs #104

Open
jdrueckert opened this issue Apr 30, 2023 · 1 comment
Open

JavaDoc Links in Module Docs #104

jdrueckert opened this issue Apr 30, 2023 · 1 comment
Labels
Category: Doc Requests, Issues and Changes targeting javadoc and module documentation Status: Blocked Is currently blocked by missing dependencies, pre-requisites, etc. Topic: UI/UX Requests, Issues and Changes related to screens, artwork, sound and overall user experience Type: Improvement Request for or addition/enhancement of a feature

Comments

@jdrueckert
Copy link
Member

jdrueckert commented Apr 30, 2023 •
edited
Loading

Problem

Module docs contain references to Java implementation details, such as specific components, systems, events, or methods. Somebody reading the docs and wanting to learn more about these components, systems, events, or methods would need to search for them in the JavaDocs (provided the link works again in the first place, see #101 ), which can be tedious depending on the module size.

Suggestion

Link all component, system, event, and method references to their respective JavaDoc.

Depends on #101
@jdrueckert jdrueckert added Type: Improvement Request for or addition/enhancement of a feature Category: Doc Requests, Issues and Changes targeting javadoc and module documentation Status: Blocked Is currently blocked by missing dependencies, pre-requisites, etc. Topic: UI/UX Requests, Issues and Changes related to screens, artwork, sound and overall user experience labels Apr 30, 2023
@jdrueckert jdrueckert mentioned this issue Apr 30, 2023
Merged
@jdrueckert
Copy link
Member Author

Currently blocked by #101

@jdrueckert jdrueckert mentioned this issue Apr 30, 2023
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Category: Doc Requests, Issues and Changes targeting javadoc and module documentation Status: Blocked Is currently blocked by missing dependencies, pre-requisites, etc. Topic: UI/UX Requests, Issues and Changes related to screens, artwork, sound and overall user experience Type: Improvement Request for or addition/enhancement of a feature
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@jdrueckert