Skip to content

Consider whether to encapsulate javadoc access into a dedicated module #89

@ctrueden

Description

@ctrueden

We may want to encapsulate the therapi usages into a single scijava-javadoc package or similar, so that the API for accessing associated javadoc of classes & fields & methods is guaranteed to be stable over time. It's less of an issue if the therapi types never leak through into our API as arguments or return values. But as soon as they do, it could break things later if therapi changes or if we replace it with something else—e.g., suppose core Java adds support for compiling in javadoc to .class files? Or suppose, for non-therapi-enriched JAR files, we look for a corresponding -classes JAR and read the javadoc ourselves out of there using jdk.javadoc or similar.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions