Dedicated block tag for side effects

[Jonathan Gibbons]

To the best of my knowledge, this has never been raised as an issue.

I doubt that this rises to the level of general interest, but you could 
easily create user-defined tag to use in your own documentation if you 
wanted that kind of stylized documentation. I would expect that 
side-effects are better described in the main description of a method.

-- Jon

On 1/17/24 5:23 PM, Marcin Wiśnicki wrote:
>
> Apologies if this belongs to javadoc-next-dev but that list looks 
> dormant so I posted here.
>
> Was there ever a discussion about adding dedicated block tag for 
> documenting side effects, e.g. @effects?
>
> For example Thread.interrupted() could say:
>
>     @effects interrupted status of the thread is cleared
>
> While Thread.isInterrupted() could explicitly call out:
>
>     @effects none
>
> This would make it far easier to document and learn about side effects 
> (or lack of them where appropriate).
>
> I think this has massive value.
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://mail.openjdk.org/pipermail/javadoc-dev/attachments/20240206/57c10593/attachment.htm>