Skip to content

Commit

Permalink
Removed JavadocInlineTagCheck as it caused more issues than caught (#…
Browse files Browse the repository at this point in the history
  • Loading branch information
alzimmermsft authored Feb 26, 2020
1 parent 1c8d0cb commit d425efd
Showing 1 changed file with 4 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -362,7 +362,10 @@ page at http://checkstyle.sourceforge.net/config.html -->
1) Use {@codesnippet ...} instead of '<code>', '<pre>', or '{@code ...}' if these tags span multiple lines.
Inline code sample are fine as-is.
2) No check on class-level Javadoc. -->
<module name="com.azure.tools.checkstyle.checks.JavadocInlineTagCheck"/>
<!-- This check was removed as it causes more noise than fixes. The purpose of this check was to move away from -->
<!-- using <code>, <pre>, and {@code} tags while we were on-boarding codesnippets. These tags have since been -->
<!-- removed and codesnippets are expected. -->
<!-- <module name="com.azure.tools.checkstyle.checks.JavadocInlineTagCheck"/> -->

<!-- CUSTOM CHECKS -->
<!-- {@codesnippet ...} description should match naming pattern requirement below:
Expand Down

0 comments on commit d425efd

Please sign in to comment.