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

EIP documentation maven plugin should aslo inject documentation to abstract/base types

    XMLWordPrintableJSON

    Details

    • Estimated Complexity:
      Unknown

      Description

      Currently maven plugin camel-eip-documentation-enricher-maven-plugin injects ducumentation to attributest of top level elements. It would be nice if it could also inject documentation to attributes of base/abstract elements.

      Example:
      It's a snippet on top level logDefinition type with injected documentation.

      <xs:complexType name="logDefinition">
          <xs:complexContent>
            <xs:extension base="tns:noOutputDefinition">
              <xs:sequence/>
              <xs:attribute name="message" type="xs:string" use="required">
                <xs:annotation>
                  <xs:documentation xml:lang="en">Sets the log message (uses simple language)</xs:documentation>
                </xs:annotation>
              </xs:attribute>
            ...
      </xs:complexType>
      

      But for it's abstract base type documentation does not injected:

      <xs:complexType abstract="true" name="processorDefinition">
          <xs:complexContent>
            <xs:extension base="tns:optionalIdentifiedDefinition">
              <xs:sequence/>
              <!-- Documentation should be injected for this attribute. -->
              <xs:attribute name="inheritErrorHandler" type="xs:boolean"/>
              <xs:anyAttribute namespace="##other" processContents="skip"/>
            </xs:extension>
          </xs:complexContent>
        </xs:complexType>
      

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                davsclaus Claus Ibsen
                Reporter:
                nkukhar Nazarii Kukhar
              • Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: