7
Vote

Synchronize exception documentation between interfaces and implementations

description

Manage dependencies between interfaces and its implementations so that the implementations throw exceptions declared on interface.

comments

StevenBone wrote Jul 9, 2015 at 2:15 PM

I'm not sure if I fully understand this issue/request, as the word 'synchronize' is throwing me off. What I would like to see is Exceptional not triggering a warning for undocumented exceptions in a method that implements an interface that properly documents the exception.

The value of Exceptional is, well, Exceptional, but having 'false' warnings in the scenario described above causes me to miss what should be real warnings about missing documentation. I'd totally want to contribute this change if I had a bit more time (I'd have to learn more about RS plugins to get up to speed).

A 'nice to have', when the exception is undocumented at the interface level, is to be able to document it on the interface instead of (or in addition to) the implementing method.