uk.ac.starlink.ttools.build

Annotation Type HideDoc

@Documented
 @Retention(value=RUNTIME)
 @Target(value={TYPE,METHOD,FIELD})
public @interface HideDoc

Indicates that a class, method or field is to be excluded from the auto-documentation made available to application users.

This may be used, for instance, for methods that should be available for use, but which might clutter up the auto-documentation in an unhelpful way for some reason.