Package org.infinispan.protostream.annotations

Annotation Type ProtoDoc

  • @Target({FIELD,METHOD,TYPE})
@Retention(RUNTIME)
@Documented
@Repeatable(ProtoDocs.class)
public @interface ProtoDoc
    Deprecated.
    For ProtoStream documentation comment annotations, annotate directly the ProtoFields with the annotations to add. For the general text case, there is no replacement.
    The documentation text of the generated message type, enum type or field. You can put here human readable text and also ProtoStream documentation comment annotations. This annotation can be repeated and all the text will be collected together in the order of appearance.
    Since:
    3.0
    Author:
    [email protected]

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      String value
      Deprecated.
      The documentation text (human readable and also ProtoStream documentation comment annotations).

    • Element Detail

      • value

        String value
        Deprecated.
        The documentation text (human readable and also ProtoStream documentation comment annotations).