openwire-annotations/src/main/java/org/apache/activemq/openwire/annotations/OpenWireDocumentation.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.apache.activemq.openwire.annotations;

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

/**
 * Used to add documentation notes to an OpenWire command or one its properties.
 */
@Retention(RetentionPolicy.RUNTIME)
public @interface OpenWireDocumentation {

    /**
     * @return a quick one sentence description of the element.
     */
    String shortDescription();

    /**
     * @return a longer more thorough description of the element.
     */
    String longDescription() default "";

}