View Javadoc
1   package ca.uhn.fhir.model.api.annotation;
2   
3   /*
4    * #%L
5    * HAPI FHIR - Core Library
6    * %%
7    * Copyright (C) 2014 - 2018 University Health Network
8    * %%
9    * Licensed under the Apache License, Version 2.0 (the "License");
10   * you may not use this file except in compliance with the License.
11   * You may obtain a copy of the License at
12   * 
13   *      http://www.apache.org/licenses/LICENSE-2.0
14   * 
15   * Unless required by applicable law or agreed to in writing, software
16   * distributed under the License is distributed on an "AS IS" BASIS,
17   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18   * See the License for the specific language governing permissions and
19   * limitations under the License.
20   * #L%
21   */
22  
23  import java.lang.annotation.ElementType;
24  import java.lang.annotation.Retention;
25  import java.lang.annotation.RetentionPolicy;
26  import java.lang.annotation.Target;
27  
28  /**
29   * Annotation which may be placed on a resource/datatype definition, or a field, or
30   * a search parameter definition in order to provide documentation for that item.
31   */
32  @Retention(RetentionPolicy.RUNTIME)
33  @Target(value= {ElementType.FIELD, ElementType.TYPE, ElementType.PARAMETER, ElementType.METHOD})
34  public @interface Description {
35  
36  	/**
37  	 * Optional short name for this child 
38  	 */
39  	String shortDefinition() default "";
40  	
41  	/**
42  	 * Optional formal definition for this child
43  	 */
44  	String formalDefinition() default "";
45  	
46  }