Skip to content

Files

Latest commit

 

History

History
36 lines (27 loc) · 727 Bytes

avoid_renaming_method_parameters.md

File metadata and controls

36 lines (27 loc) · 727 Bytes

Pattern: Renaming overridden method parameter

Issue: -

Description

Methods that override another method, but do not have their own documentation comment, will inherit the overridden method's comment when dartdoc produces documentation. If the inherited method contains the name of the parameter (in square brackets), then dartdoc cannot link it correctly.

Example of incorrect code:

abstract class A {
 m(a);
}

abstract class B extends A {
 m(b);
}

Example of correct code:

abstract class A {
 m(a);
}

abstract class B extends A {
 m(a);
}

Further Reading