observability icon indicating copy to clipboard operation
observability copied to clipboard

Remove unnecessary `inheritDoc`s from plugin

Open Swiddis opened this issue 1 year ago • 0 comments

Is your feature request related to a problem? The Kotlin KDoc Spec does not recognize the {@inheritDoc} annotation. Instead it automatically inherits documentation from one layer up. There are currently many methods throughout the Observability plugin that use this annotation and it produces broken documentation, simply removing it fixes the behavior.

What solution would you like? Remove unused {@inheritDoc} from the codebase.

What alternatives have you considered? N/A

Do you have any additional context? Before: documentation with inherit doc

After: documentation without inherit doc

Swiddis avatar Apr 04 '23 20:04 Swiddis