1 package org.apache.maven.tools.plugin.javadoc; 2 3 /* 4 * Licensed to the Apache Software Foundation (ASF) under one 5 * or more contributor license agreements. See the NOTICE file 6 * distributed with this work for additional information 7 * regarding copyright ownership. The ASF licenses this file 8 * to you under the Apache License, Version 2.0 (the 9 * "License"); you may not use this file except in compliance 10 * with the License. You may obtain a copy of the License at 11 * 12 * http://www.apache.org/licenses/LICENSE-2.0 13 * 14 * Unless required by applicable law or agreed to in writing, 15 * software distributed under the License is distributed on an 16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 17 * KIND, either express or implied. See the License for the 18 * specific language governing permissions and limitations 19 * under the License. 20 */ 21 22 /** 23 * Abstract <code>Taglet</code> for annotations specified at the Mojo parameter level. 24 * 25 * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a> 26 * @version $Id: AbstractMojoFieldTaglet.html 1024032 2018-01-19 18:16:30Z hboutemy $ 27 */ 28 public abstract class AbstractMojoFieldTaglet 29 extends AbstractMojoTaglet 30 { 31 /** 32 * @return <code>false</code> since this annotation can <b>NOT</b> be used in constructor documentation. 33 * @see com.sun.tools.doclets.Taglet#inConstructor() 34 */ 35 public final boolean inConstructor() 36 { 37 return false; 38 } 39 40 /** 41 * @return <code>true</code> since this annotation can <b>NOT</b> be used in field documentation. 42 * @see com.sun.tools.doclets.Taglet#inField() 43 */ 44 public final boolean inField() 45 { 46 return true; 47 } 48 49 /** 50 * @return <code>false</code> since this annotation can <b>NOT</b> be used in method documentation. 51 * @see com.sun.tools.doclets.Taglet#inMethod() 52 */ 53 public final boolean inMethod() 54 { 55 return false; 56 } 57 58 /** 59 * @return <code>false</code> since this annotation can <b>NOT</b> be used in overview documentation. 60 * @see com.sun.tools.doclets.Taglet#inOverview() 61 */ 62 public final boolean inOverview() 63 { 64 return false; 65 } 66 67 /** 68 * @return <code>false</code> since this annotation can <b>NOT</b> be used in package documentation. 69 * @see com.sun.tools.doclets.Taglet#inPackage() 70 */ 71 public final boolean inPackage() 72 { 73 return false; 74 } 75 76 /** 77 * @return <code>false</code> since this annotation can be used in type documentation. 78 * @see com.sun.tools.doclets.Taglet#inType() 79 */ 80 public final boolean inType() 81 { 82 return false; 83 } 84 85 /** 86 * @return <code>false</code> since this annotation can <b>NOT</b> be used in inline tag. 87 * @see com.sun.tools.doclets.Taglet#isInlineTag() 88 */ 89 public final boolean isInlineTag() 90 { 91 return false; 92 } 93 }