001package org.apache.maven.tools.plugin.javadoc;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *   http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022/**
023 * Abstract <code>Taglet</code> for annotations specified at the Mojo class level.
024 *
025 * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
026 * @version $Id: AbstractMojoTypeTaglet.html 1030109 2018-05-20 14:45:18Z hboutemy $
027 */
028public abstract class AbstractMojoTypeTaglet
029    extends AbstractMojoTaglet
030{
031    /**
032     * @return <code>false</code> since this annotation can <b>NOT</b> be used in constructor documentation.
033     * @see com.sun.tools.doclets.Taglet#inConstructor()
034     */
035    public final boolean inConstructor()
036    {
037        return false;
038    }
039
040    /**
041     * @return <code>false</code> since this annotation can <b>NOT</b> be used in field documentation.
042     * @see com.sun.tools.doclets.Taglet#inField()
043     */
044    public final boolean inField()
045    {
046        return false;
047    }
048
049    /**
050     * @return <code>false</code> since this annotation can <b>NOT</b> be used in method documentation.
051     * @see com.sun.tools.doclets.Taglet#inMethod()
052     */
053    public final boolean inMethod()
054    {
055        return false;
056    }
057
058    /**
059     * @return <code>false</code> since this annotation can <b>NOT</b> be used in overview documentation.
060     * @see com.sun.tools.doclets.Taglet#inOverview()
061     */
062    public final boolean inOverview()
063    {
064        return false;
065    }
066
067    /**
068     * @return <code>false</code> since this annotation can <b>NOT</b> be used in package documentation.
069     * @see com.sun.tools.doclets.Taglet#inPackage()
070     */
071    public final boolean inPackage()
072    {
073        return false;
074    }
075
076    /**
077     * @return <code>true</code> since this annotation can be used in type documentation.
078     * @see com.sun.tools.doclets.Taglet#inType()
079     */
080    public final boolean inType()
081    {
082        return true;
083    }
084
085    /**
086     * @return <code>false</code> since this annotation can <b>NOT</b> be used in inline tag.
087     * @see com.sun.tools.doclets.Taglet#isInlineTag()
088     */
089    public final boolean isInlineTag()
090    {
091        return false;
092    }
093}