xref: /aosp_15_r20/prebuilts/checkstyle/default-javadoc-checks.xml (revision 387726c4b5c67c6b48512fa4a28a3b8997d21b0d)

<?xml version="1.0" encoding="UTF-8"?>
<!--
  ~ Copyright (C) 2016 The Android Open Source Project
  ~
  ~ Licensed under the Apache License, Version 2.0 (the "License");
  ~ you may not use this file except in compliance with the License.
  ~ You may obtain a copy of the License at
  ~
  ~      http://www.apache.org/licenses/LICENSE-2.0
  ~
  ~ Unless required by applicable law or agreed to in writing, software
  ~ distributed under the License is distributed on an "AS IS" BASIS,
  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  ~ See the License for the specific language governing permissions and
  ~ limitations under the License.
-->
<module name="JavadocType">
  <property name="severity" value="warning"/>
  <property name="tokens" value="INTERFACE_DEF, CLASS_DEF"/>
  <property name="scope" value="public"/>
  <property name="allowUnknownTags" value="true"/> <!-- Allows @hide tags in JavaDocs -->
  <message key="javadoc.missing" value="Public classes and interfaces require JavaDoc comments."/>
</module>
<module name="JavadocMethod">
  <property name="severity" value="error"/>
  <property name="tokens" value="METHOD_DEF"/>
  <property name="validateThrows" value="false"/>
  <property name="allowMissingParamTags" value="true"/>
  <property name="allowMissingReturnTag" value="true"/>
</module>
<module name="MissingJavadocMethod">
  <property name="scope" value="public"/>
  <property name="tokens" value="METHOD_DEF"/>
  <property name="allowMissingPropertyJavadoc" value="true"/>
  <property name="allowedAnnotations" value="Override,Test,Before,After,Parameterized.Parameters,BeforeClass,AfterClass"/>
  <property name="ignoreMethodNamesRegex" value="^test.*$"/>
</module>