Interface Documentable

All Known Subinterfaces:
DefaultFunction<T>
All Known Implementing Classes:
Feature, JavaFunction, SimpleJavaFunction
public interface Documentable
Represents any object that can be documented using methods.

  • Method Details

    • name

      @NotNull @NotNull String name()
      Returns:
      The name.

    • description

      @NotNull @Unmodifiable @NotNull List<String> description()
      Returns:
      The unmodifiable description.

    • since

      @NotNull @Unmodifiable @NotNull List<String> since()
      Returns:
      The unmodifiable version history.

    • examples

      @NotNull @Unmodifiable @NotNull List<String> examples()
      Returns:
      The unmodifiable examples.

    • keywords

      @NotNull @Unmodifiable @NotNull List<String> keywords()
      Returns:
      The unmodifiable keywords.

    • requires

      @NotNull @Unmodifiable @NotNull List<String> requires()
      Returns:
      The unmodifiable requirements.