[CAMEL-8334] EIP documentation maven plugin should aslo inject documentation to abstract/base types

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 2.15.0
• Component/s: build system, camel-blueprint, camel-spring, tooling
• Estimated Complexity: Unknown
• Assignee: Claus Ibsen
• Reporter: Nazarii Kukhar
• Created: 11/Feb/15 07:18
• Updated: 20/Feb/15 16:31
• Resolved: 20/Feb/15 09:34

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>

Issue Links

• is related to: CAMEL-7999 Camel Toolbox - Easy information about all Camel components and the release for tooling
• is related to: CAMEL-8381 XML XSD enriched documentation should maybe word wrap for easier read in raw format
• relates to: CAMEL-8380 Add documentation for spring/blueprint only types that are in the generated xml dsl