Package dev.dsf.bpe.v1.documentation

Annotation Interface ProcessDocumentation

@Retention(RUNTIME) @Target(FIELD) public @interface ProcessDocumentation
Annotation for documenting DSF process plugin properties. Add this annotation in addition to Value to fields of your spring Configuration class in order to take advantage of the "dsf-tools-documentation-generator" maven plugin to generate a markdown file.

Example: 

 @ProcessDocumentation(description = "Set to `true` to enable a special function", processNames = "testorg_process")
 @Value("${org.test.process.special:false}")
 private boolean specialFunction;
See Also:

  • Element Details

    • required

      boolean required
      Returns:
      true if this property is required for processes listed in processNames()
      Default:
      false

    • processNames

      String[] processNames
      Returns:
      an empty array if all processes use this property or an array of length >= 1 containing only specific processes that use this property, but not all
      Default:
      {}

    • description

      String description
      Returns:
      description helping to configure this property

    • example

      String example
      Returns:
      example value helping to configure this property
      Default:
      ""

    • recommendation

      String recommendation
      Returns:
      recommendation helping to configure this property
      Default:
      ""