io.vertx.docgen.Source Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of vertx-docgen Show documentation

The newest version!

package io.vertx.docgen;

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

/**
 * Define a scope for source code inclusion: any link ref in this scope should include the content instead
 * of linking to it.
 *
 * @author Julien Viet
 */
@Target({ElementType.TYPE, ElementType.PACKAGE, ElementType.METHOD})
@Retention(RetentionPolicy.CLASS)
public @interface Source {

  /**
   * Enables or disables the translation of the annotated example.
   * When set to `false`, it also enable the inclusion of Java file (entire file) in the documentation
   */
  boolean translate() default true;
}