camel-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Claus Ibsen (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (CAMEL-8334) EIP documentation maven plugin should aslo inject documentation to abstract/base types
Date Fri, 20 Feb 2015 09:40:11 GMT

    [ https://issues.apache.org/jira/browse/CAMEL-8334?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14328747#comment-14328747
] 

Claus Ibsen commented on CAMEL-8334:
------------------------------------

It would be great if we can get the documentation for the other bits, eg the bits that spring
/ blueprint have in addtion to the eips, such as <camelContext> and whatnot.

I logged at related ticket CAMEL-8380

> EIP documentation maven plugin should aslo inject documentation to abstract/base types
> --------------------------------------------------------------------------------------
>
>                 Key: CAMEL-8334
>                 URL: https://issues.apache.org/jira/browse/CAMEL-8334
>             Project: Camel
>          Issue Type: Improvement
>          Components: build system, camel-blueprint, camel-spring, tooling
>            Reporter: Nazarii Kukhar
>            Assignee: Claus Ibsen
>             Fix For: 2.15.0
>
>
> 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.
> {code:xml}
> <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>
> {code}
> But for it's abstract base type documentation does not injected:
> {code:xml}
> <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>
> {code}



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Mime
View raw message