Package edu.wpi.grip.annotation.operation

Annotation Type Description

  • @Target(TYPE)
@Retention(RUNTIME)
public @interface Description
    Annotates an Operation subclass to describe it. This annotation gets transformed into a OperationDescription. All operation classes with this annotation will be automatically discovered and added to the palette at startup.

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.String name
      The name of the operation being described.
      java.lang.String summary
      A brief summary of the operation.

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String[] aliases
      All known aliases of the operation.
      OperationCategory category
      The category the operation belongs to.
      java.lang.String iconName
      The name of the icon to use to display the operation.

    • Element Detail

      • name

        java.lang.String name
        The name of the operation being described.
        Returns:
        the name of the operation

      • summary

        java.lang.String summary
        A brief summary of the operation. In-depth descriptions, usage guides, and examples should be on the wiki, not here.
        Returns:
        a summary of the operation

      • category

        OperationCategory category
        The category the operation belongs to. Defaults to MISCELLANEOUS.
        Returns:
        the category to which the operation belongs
        Default:
        edu.wpi.grip.annotation.operation.OperationCategory.MISCELLANEOUS

      • aliases

        java.lang.String[] aliases
        All known aliases of the operation. If the name of the operation changes, the previous name should be here. Defaults to an empty array.
        Returns:
        known aliases
        Default:
        {}

      • iconName

        java.lang.String iconName
        The name of the icon to use to display the operation. If empty (""), no icon will be shown. The icon should be located in /edu/wpi/grip/ui/icons/.
        Returns:
        the name of the icon
        Default:
        ""