io.quarkus.runtime.annotations.ConfigDocPrefix Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of quarkus-core Show documentation

Quarkus core components

There is a newer version: 3.17.5

package io.quarkus.runtime.annotations;

import static java.lang.annotation.RetentionPolicy.RUNTIME;

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

/**
 * This annotation can be used when you want to override the top level prefix from the ConfigRoot/ConfigMapping for doc
 * generation.
 * 
 * This is for instance useful for {@code ConfigConfig}, which is an odd beast.
 * 
 * Should be considered very last resort.
 */
@Documented
@Retention(RUNTIME)
@Target({ ElementType.TYPE })
public @interface ConfigDocPrefix {

    String value();
}