Skip to content

Commit

Permalink
Update rule S1176 description
Browse files Browse the repository at this point in the history
  • Loading branch information
Wohops committed Jun 27, 2017
1 parent cee7ba9 commit 8175eb6
Showing 1 changed file with 8 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,14 @@
<li> Method return values, using <code>@return</code>. </li>
<li> Generic types, using <code>@param &lt;T&gt;</code>. </li>
</ul>
<p>Furthermore the following guidelines should be followed:</p>
<ul>
<li> At least 1 line of description which should have more than one word. </li>
<li> All parameters documented with <code>@param</code>, and names should match. </li>
<li> All checked exceptions documented with <code>@throws</code> </li>
<li> <code>@return</code> present and documented when not <code>void</code>. </li>
<li> Placeholders like "TODO", "FIXME", "..." should be avoided. </li>
</ul>
<p>The following public methods and constructors are not taken into account by this rule:</p>
<ul>
<li> Getters and setters. </li>
Expand Down

0 comments on commit 8175eb6

Please sign in to comment.