-
Notifications
You must be signed in to change notification settings - Fork 14
Open
Labels
Category: DocRequests, Issues and Changes targeting javadoc and module documentationRequests, Issues and Changes targeting javadoc and module documentationStatus: BlockedIs currently blocked by missing dependencies, pre-requisites, etc.Is currently blocked by missing dependencies, pre-requisites, etc.Topic: UI/UXRequests, Issues and Changes related to screens, artwork, sound and overall user experienceRequests, Issues and Changes related to screens, artwork, sound and overall user experienceType: ImprovementRequest for or addition/enhancement of a featureRequest for or addition/enhancement of a feature
Description
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
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
Category: DocRequests, Issues and Changes targeting javadoc and module documentationRequests, Issues and Changes targeting javadoc and module documentationStatus: BlockedIs currently blocked by missing dependencies, pre-requisites, etc.Is currently blocked by missing dependencies, pre-requisites, etc.Topic: UI/UXRequests, Issues and Changes related to screens, artwork, sound and overall user experienceRequests, Issues and Changes related to screens, artwork, sound and overall user experienceType: ImprovementRequest for or addition/enhancement of a featureRequest for or addition/enhancement of a feature