checkstyle-suppressions.xml

<?xml version="1.0" encoding="UTF-8"?>
<!--
ao-encoding - High performance streaming character encoding.
Copyright (C) 2022, 2023, 2024  AO Industries, Inc.
    support@aoindustries.com
    7262 Bull Pen Cir
    Mobile, AL 36695

This file is part of ao-encoding.

ao-encoding is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

ao-encoding is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with ao-encoding.  If not, see <https://www.gnu.org/licenses/>.
-->
<!DOCTYPE suppressions PUBLIC
  "-//Checkstyle//DTD SuppressionFilter Configuration 1.2//EN"
  "https://checkstyle.org/dtds/suppressions_1_2.dtd">

<suppressions>

  <!-- TODO: Complete Javadocs -->
  <suppress checks="(MissingJavadocMethod|MissingJavadocType|SummaryJavadoc)" />

  <!-- Cannot find how to allow <p> inside @param and @return -->
  <suppress
    checks="JavadocParagraph"
    files="[/\\]com[/\\]aoapps[/\\]encoding[/\\]Encode\.java$"
  />
  <suppress
    checks="JavadocParagraph"
    files="[/\\]com[/\\]aoapps[/\\]encoding[/\\]Encoding\.java$"
  />

  <!-- TODO: Remove in 8.0.0 release -->
  <suppress
    checks="AbbreviationAsWordInName"
    files="[/\\]com[/\\]aoapps[/\\]encoding[/\\]Doctype\.java$"
    message="'supportsIRI'"
  />

  <!-- Using "Ex" for generic exceptions, since "E" is often "Element" -->
  <suppress
    checks="(InterfaceTypeParameterName|MethodTypeParameterName)"
    message="'Ex'"
  />

  <!-- Using Unicode escapes because easier to match RFC sources -->
  <suppress checks="AvoidEscapedUnicodeCharacters" />

  <!-- Consistency with standard "URLDecoder", "URLEncoder", and "URL" -->
  <suppress
    checks="AbbreviationAsWordInName"
    files="[/\\]com[/\\]aoapps[/\\]encoding[/\\]Doctype\.java$"
    message="'getSupportsIRI'"
  />
  <suppress
    checks="AbbreviationAsWordInName"
    files="[/\\]com[/\\]aoapps[/\\]encoding[/\\]EncodingContext\.java$"
    message="'encodeURL'"
  />

</suppressions>