Uploaded image for project: 'Camel'
  1. Camel
  2. CAMEL-13725

Endpoint DSL - Add to javadoc if an option is required

    XMLWordPrintableJSON

    Details

    • Type: Improvement
    • Status: Resolved
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 3.0.0.M4, 3.0.0
    • Component/s: camel-core
    • Labels:
      None
    • Estimated Complexity:
      Unknown

      Description

      When an option has required=true in the metadata we should add that to the endpoint DSL javadoc, eg

              /**
               * Whether the topic is persistent or non-persistent.
               * The option is a <code>java.lang.String</code> type.
               * @group common
               */
              default PulsarEndpointConsumerBuilder persistence(String persistence) {
                  setProperty("persistence", persistence);
                  return this;
              }
      

      This option is required. Also not sure if @group is a valid javadoc syntax

        Attachments

          Activity

            People

            • Assignee:
              davsclaus Claus Ibsen
              Reporter:
              davsclaus Claus Ibsen
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: