Package uk.ac.manchester.spinnaker.utils

Annotation Interface UsedInJavadocOnly

@Retention(SOURCE) @Target({TYPE,METHOD,CONSTRUCTOR,FIELD,PACKAGE}) public @interface UsedInJavadocOnly
Marks that the given class is used for Javadoc generation only, but needs to be referenced for Checkstyle. With this, the classes in question are genuinely used, but only at the source level; no runtime code is generated.
Author:
Donal Fellows

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    Class<?>[]
    value
    Class or classes just used by the annotated thing in Javadoc generation.

  • Element Details

    • value

      Class<?>[] value
      Class or classes just used by the annotated thing in Javadoc generation. Put in with this so Checkstyle doesn't think the class is unused.
      Returns:
      classes