<!DOCTYPE html><html><head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  </head>
  <body>
    <p>To the best of my knowledge, this has never been raised as an
      issue.</p>
    <p>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.</p>
    <p>-- Jon<br>
    </p>
    <div class="moz-cite-prefix">On 1/17/24 5:23 PM, Marcin Wiśnicki
      wrote:<br>
    </div>
    <blockquote type="cite" cite="mid:7AAD95D2-6653-4F33-B555-22032F341B40@hxcore.ol">
      
      <meta name="Generator" content="Microsoft Word 15 (filtered medium)">
      <style>@font-face
        {font-family:"Cambria Math";
        panose-1:2 4 5 3 5 4 6 3 2 4;}@font-face
        {font-family:Calibri;
        panose-1:2 15 5 2 2 2 4 3 2 4;}p.MsoNormal, li.MsoNormal, div.MsoNormal
        {margin:0cm;
        font-size:11.0pt;
        font-family:"Calibri",sans-serif;}.MsoChpDefault
        {mso-style-type:export-only;}div.WordSection1
        {page:WordSection1;}</style>
      <div class="WordSection1">
        <p class="MsoNormal">Apologies if this belongs to
          javadoc-next-dev but that list looks dormant so I posted here.</p>
        <p class="MsoNormal"><o:p> </o:p></p>
        <p class="MsoNormal">Was there ever a discussion about adding
          dedicated block tag for documenting side effects, e.g.
          @effects?</p>
        <p class="MsoNormal"><o:p> </o:p></p>
        <p class="MsoNormal">For example Thread.interrupted() could say:</p>
        <p class="MsoNormal"><o:p> </o:p></p>
        <p class="MsoNormal">    @effects interrupted status of the
          thread is cleared</p>
        <p class="MsoNormal"><o:p> </o:p></p>
        <p class="MsoNormal">While Thread.isInterrupted() could
          explicitly call out:</p>
        <p class="MsoNormal"><o:p> </o:p></p>
        <p class="MsoNormal">    @effects none</p>
        <p class="MsoNormal"><o:p> </o:p></p>
        <p class="MsoNormal">This would make it far easier to document
          and learn about side effects (or lack of them where
          appropriate).</p>
        <p class="MsoNormal">I think this has massive value. </p>
      </div>
    </blockquote>
  </body>
</html>