Skip to content

Add @see tags to methods to point back to the original member #100

@Nava2

Description

@Nava2

It'd be helpful if generated methods included an @see to the member the value was generated from.

Example

Given

class Foo {
  public int getBar() {
    return 0;
  }
}

Actual

  /**
   * Verifies that the actual Foo's bar is equal to the given one.
   * @param bar the given bar to compare the actual Foo's bar to.
   * @return this assertion object.
   * @throws AssertionError - if the actual Foo's bar is not equal to the given one.
   */
  public FooAssert hasBar(int bar) {
    // ... cut for brevity ...
    return this;
  }

Expected

  /**
   * Verifies that the actual Foo's bar is equal to the given one.
   * @param bar the given bar to compare the actual Foo's bar to.
   * @return this assertion object.
   * @throws AssertionError - if the actual Foo's bar is not equal to the given one.
   * @see Foo#getBar() Member under test.
   */
  public FooAssert hasBar(int bar) {
    // ... cut for brevity ...
    return this;
  }

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions