com.thegoate.info.Info Maven / Gradle / Ivy
/*
* Copyright (c) 2017. Eric Angeli
*
* Permission is hereby granted, free of charge,
* to any person obtaining a copy of this software
* and associated documentation files (the "Software"),
* to deal in the Software without restriction,
* including without limitation the rights to use, copy,
* modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit
* persons to whom the Software is furnished to do so,
* subject to the following conditions:
*
* The above copyright notice and this permission
* notice shall be included in all copies or substantial
* portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
* WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE
* AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*/
package com.thegoate.info;
import com.thegoate.annotations.GoateDescription;
import org.atteo.classindex.IndexAnnotated;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
/**
* Use on GoaTE annotations for auto building
* indexes/encyclopedia for reference and auto completion.
* Created by gtque on 11/1/2018.
*/
@Retention(RetentionPolicy.RUNTIME)
@GoateDescription(description = "Annotate GoaTE annotation with @Info to automatically pick it up in the encyclopedia.")
@Info(classifier = "classifier")
@IndexAnnotated
public @interface Info {
String classifier() default "";
String[] tags() default {};
}