Skip to content

JavaDoc Links in Module Docs #104

@jdrueckert

Description

@jdrueckert

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    Category: DocRequests, Issues and Changes targeting javadoc and module documentationStatus: BlockedIs currently blocked by missing dependencies, pre-requisites, etc.Topic: UI/UXRequests, Issues and Changes related to screens, artwork, sound and overall user experienceType: ImprovementRequest for or addition/enhancement of a feature

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions