001/*
002 * #%L
003 * HAPI FHIR - Core Library
004 * %%
005 * Copyright (C) 2014 - 2025 Smile CDR, Inc.
006 * %%
007 * Licensed under the Apache License, Version 2.0 (the "License");
008 * you may not use this file except in compliance with the License.
009 * You may obtain a copy of the License at
010 *
011 *      http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing, software
014 * distributed under the License is distributed on an "AS IS" BASIS,
015 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
016 * See the License for the specific language governing permissions and
017 * limitations under the License.
018 * #L%
019 */
020package ca.uhn.fhir.model.api.annotation;
021
022import java.lang.annotation.ElementType;
023import java.lang.annotation.Retention;
024import java.lang.annotation.RetentionPolicy;
025import java.lang.annotation.Target;
026
027/**
028 * Annotation which may be placed on a resource/datatype definition, or a field, or
029 * a search parameter definition in order to provide documentation for that item.
030 */
031@Retention(RetentionPolicy.RUNTIME)
032@Target(value = {ElementType.FIELD, ElementType.TYPE, ElementType.PARAMETER, ElementType.METHOD})
033public @interface Description {
034
035        /**
036         * A description of this method or parameter
037         *
038         * @since 5.4.0
039         */
040        String value() default "";
041
042        /**
043         * Optional short name for this child
044         */
045        String shortDefinition() default "";
046
047        /**
048         * Optional formal definition for this child
049         *
050         * @deprecated Use {@link #value()} instead. Deprecated in 5.4.0.
051         */
052        @Deprecated
053        String formalDefinition() default "";
054
055        /**
056         * May be used to supply example values for this
057         *
058         * @since 5.4.0
059         */
060        String[] example() default {};
061}