Skip to content

Fix remaining Javadoc gaps that hide meaningful doclint warnings #47

Description

@philliplbryant

A number of public members in core/ have Javadoc comments with no summary and no @return tag, so #45's {@return ...} conversion doesn't apply to them. Javadoc uses the first sentence as the summary shown in the member tables, so these currently show up blank.

I want to add a short written summary to each of them. Many won't say much beyond the name, but filling them in means -Xdoclint can be turned back on for core and to expose warnings that actually matter.

I've already made the changes and plan to open a PR.

As before, please let me know if you don't want changes like these. I'll stop posting if you don't want them.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions