From 8d698c53a5fd3213f69ea4b26eca0998aa387dec Mon Sep 17 00:00:00 2001 From: Sebastian Sdorra Date: Wed, 15 Apr 2020 08:35:50 +0200 Subject: [PATCH] Added javadoc for Requires annotation --- .../src/main/java/sonia/scm/plugin/Requires.java | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/scm-annotations/src/main/java/sonia/scm/plugin/Requires.java b/scm-annotations/src/main/java/sonia/scm/plugin/Requires.java index 2ac8914b9c..e70bf582b1 100644 --- a/scm-annotations/src/main/java/sonia/scm/plugin/Requires.java +++ b/scm-annotations/src/main/java/sonia/scm/plugin/Requires.java @@ -30,15 +30,21 @@ import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; +/** + * The {@link Requires} annotation can be used to bind classes (e.g. Extensions, Rest Resources, etc.) only if certain + * plugins is installed. This is very useful in combination with optional plugin dependencies. + * + * @since 2.0.0 + */ @Documented @Target({ ElementType.TYPE }) @Retention(RetentionPolicy.RUNTIME) public @interface Requires { + /** * The annotated class is loaded only if all of the specified plugins are installed. * The value has to be an array of string with the plugin names the class should depend on. * - * @since 2.0.0 * @return list of required plugins to load this class */ String[] value();