Skip to content

Method descriptions for getters rely on implementation details #1251

@elharo

Description

@elharo

Affected version

3.11

Bug description

javadoc:fix goals produces method descriptions that look like this:

* <p>Getter for the field <code>project</code>.</p>

This is unhelpful and arguably bad. The field is an implementation detail that can change and shouldn't be exposed to clients. I'm int sure there is anything meaningful we can deduce without an LLM, but it certainly shouldn't be a field name. Just maybe we could say a property based on the getter name.

Should likely also drop the p tags here too.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions