Annotation Type DocStringType


  • @Retention(RUNTIME)
    @Target(METHOD)
    @API(status=STABLE)
    public @interface DocStringType
    Register doc string type.

    The name of the method is used as the content type of the DocStringType.

    The method must have this signature:

    • String -> Author
    NOTE: Author is an example of the type of the parameter type.
    See Also:
    DocStringType
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      String contentType
      Name of the content type.
    • Element Detail

      • contentType

        String contentType
        Name of the content type.

        When not provided this will default to the name of the annotated method.

        Returns:
        content type
        Default:
        ""