org.codenarc.rule.comments.JavadocMissingThrowsDescriptionRule.groovy Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2019 the original author or authors.
 *
 * 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.
 */
package org.codenarc.rule.comments

/**
 * Checks for missing description within @throws javadoc tag
 *
 * @author Chris Mair
 */
class JavadocMissingThrowsDescriptionRule extends AbstractJavadocMissingDescriptionRule {

    String name = 'JavadocMissingThrowsDescription'

    @Override
    protected String getTag() {
        return '@throws'
    }
}