com.igormaznitsa.meta.annotation.ImplementationNote Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jcp Show documentation

Powerful multi-pass preprocessor to process directives situated in C-styled commentaries

There is a newer version: 7.1.2

/*
 * Copyright 2015 Igor Maznitsa.
 *
 * 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 com.igormaznitsa.meta.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Allows to define some implementation note about marked entity. Like how to use that or sequence of calls.
 *
 * @since 1.0.2
 */
@Documented
@Target({ElementType.TYPE, ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER, ElementType.CONSTRUCTOR, ElementType.PACKAGE, ElementType.ANNOTATION_TYPE})
@Retention (RetentionPolicy.CLASS)
public @interface ImplementationNote {
  /**
   * Text description of the warning.
   * @return text description
   * @since 1.0.2
   */
  String value();
}