xref: /aosp_15_r20/prebuilts/checkstyle/default-javadoc-checks.xml (revision 387726c4b5c67c6b48512fa4a28a3b8997d21b0d)
1<?xml version="1.0" encoding="UTF-8"?>
2<!--
3  ~ Copyright (C) 2016 The Android Open Source Project
4  ~
5  ~ Licensed under the Apache License, Version 2.0 (the "License");
6  ~ you may not use this file except in compliance with the License.
7  ~ You may obtain a copy of the License at
8  ~
9  ~      http://www.apache.org/licenses/LICENSE-2.0
10  ~
11  ~ Unless required by applicable law or agreed to in writing, software
12  ~ distributed under the License is distributed on an "AS IS" BASIS,
13  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  ~ See the License for the specific language governing permissions and
15  ~ limitations under the License.
16-->
17<module name="JavadocType">
18  <property name="severity" value="warning"/>
19  <property name="tokens" value="INTERFACE_DEF, CLASS_DEF"/>
20  <property name="scope" value="public"/>
21  <property name="allowUnknownTags" value="true"/> <!-- Allows @hide tags in JavaDocs -->
22  <message key="javadoc.missing" value="Public classes and interfaces require JavaDoc comments."/>
23</module>
24<module name="JavadocMethod">
25  <property name="severity" value="error"/>
26  <property name="tokens" value="METHOD_DEF"/>
27  <property name="validateThrows" value="false"/>
28  <property name="allowMissingParamTags" value="true"/>
29  <property name="allowMissingReturnTag" value="true"/>
30</module>
31<module name="MissingJavadocMethod">
32  <property name="scope" value="public"/>
33  <property name="tokens" value="METHOD_DEF"/>
34  <property name="allowMissingPropertyJavadoc" value="true"/>
35  <property name="allowedAnnotations" value="Override,Test,Before,After,Parameterized.Parameters,BeforeClass,AfterClass"/>
36  <property name="ignoreMethodNamesRegex" value="^test.*$"/>
37</module>
38