001// Copyright 2014 The Apache Software Foundation
002//
003// Licensed under the Apache License, Version 2.0 (the "License");
004// you may not use this file except in compliance with the License.
005// You may obtain a copy of the License at
006//
007//     http://www.apache.org/licenses/LICENSE-2.0
008//
009// Unless required by applicable law or agreed to in writing, software
010// distributed under the License is distributed on an "AS IS" BASIS,
011// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
012// See the License for the specific language governing permissions and
013// limitations under the License.
014
015package org.apache.tapestry5.ioc.annotations;
016
017import java.lang.annotation.Documented;
018import static java.lang.annotation.ElementType.TYPE;
019import static java.lang.annotation.ElementType.PACKAGE;
020import java.lang.annotation.Retention;
021import static java.lang.annotation.RetentionPolicy.RUNTIME;
022import java.lang.annotation.Target;
023
024import static org.apache.tapestry5.ioc.annotations.AnnotationUseContext.*;
025
026/**
027 * Annotation used by Tapestry to describe the annotated class or package in runtime, 
028 * specially in the T5Dashboard page.
029 */
030@Target({TYPE, PACKAGE})
031@Retention(RUNTIME)
032@Documented
033@UseWith({COMPONENT,MIXIN,PAGE,SERVICE})
034public @interface Description
035{
036    /**
037     * A textual description of this class.
038     */
039    String text();
040    
041    /**
042     * Tags used to describe this class. Use just lowercase letters, numbers and dashes.
043     */
044    String[] tags() default {};
045    
046}