Description.java

// Copyright 2014 The Apache Software Foundation
//
// Licensed 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.tapestry5.ioc.annotations;

import java.lang.annotation.Documented;
import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.ElementType.PACKAGE;
import java.lang.annotation.Retention;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
import java.lang.annotation.Target;

import static org.apache.tapestry5.ioc.annotations.AnnotationUseContext.*;

/**
 * Annotation used by Tapestry to describe the annotated class or package in runtime, 
 * specially in the T5Dashboard page.
 */
@Target({TYPE, PACKAGE})
@Retention(RUNTIME)
@Documented
@UseWith({COMPONENT,MIXIN,PAGE,SERVICE})
public @interface Description
{
    /**
     * A textual description of this class.
     */
    String text();
    
    /**
     * Tags used to describe this class. Use just lowercase letters, numbers and dashes.
     */
    String[] tags() default {};
    
}