Files
android_development/tools/checkstyle/default-javadoc-checks.xml
Aurimas Liutikas 36824c93ee Split android-style.xml into modules for checkstyle.
This will allow teams to reuse parts of checkstyle without having
to worry about missing any checks when they change in the main configs.

Bug: None
Test: Tested locally and checkstyle still verifies the same rules using android-style.xml
Change-Id: I91ca11d3d7089db656bc640549bd7012284a8859
2016-11-18 15:55:15 -08:00

33 lines
1.4 KiB
XML

<?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="scope" value="public"/>
<property name="tokens" value="METHOD_DEF"/>
<property name="allowMissingParamTags" value="true"/>
<property name="allowMissingPropertyJavadoc" value="true"/>
<property name="allowMissingReturnTag" value="true"/>
<property name="allowMissingThrowsTags" value="true"/>
</module>