Hi Roger,

Thanks for the comments. It seems like we have agreement on using @apiNote 
instead of @implSpec.

Brian

On Mar 22, 2018, at 8:02 AM, Roger Riggs <roger.ri...@oracle.com> wrote:

> The use of the word 'equivalent' regardless of the context, only says the 
> behavior is the same
> it does not mandate the implementation except that it behaves the same.
> 
> Since the behavior of the method is already specified, adding the 
> 'equivalent' statement
> only makes it easier for the developer to understand the behavior so it would 
> be
> fine in an apiNote or just part of the description.  Either way, from a 
> conformance point of
> view, the statement should be ignored.
> 
> If it was in an @implSpec clause, then I'd expect to be able to write a test 
> that
> checks that the behavior is the same using only the API and not making any 
> assumption
> about that the API invokes.

Reply via email to