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. |
- Dedicated block tag for side effects Marcin Wiśnicki
- Re: Dedicated block tag for side effects Jonathan Gibbons
