camel-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF GitHub Bot (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (CAMEL-8381) XML XSD enriched documentation should maybe word wrap for easier read in raw format
Date Sun, 08 Mar 2015 10:14:38 GMT

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

ASF GitHub Bot commented on CAMEL-8381:
---------------------------------------

Github user nkukhar closed the pull request at:

    https://github.com/apache/camel/pull/427


> XML XSD enriched documentation should maybe word wrap for easier read in raw format
> -----------------------------------------------------------------------------------
>
>                 Key: CAMEL-8381
>                 URL: https://issues.apache.org/jira/browse/CAMEL-8381
>             Project: Camel
>          Issue Type: Improvement
>          Components: camel-blueprint, camel-spring, tooling
>    Affects Versions: 2.15.0
>            Reporter: Claus Ibsen
>            Assignee: Claus Ibsen
>            Priority: Minor
>             Fix For: 2.16.0
>
>
> If we look at the springframework schema, they word wrap their documentation and use
CDATA section
> {code}
> 		<xsd:attribute name="lazy-init" default="default" type="defaultable-boolean">
> 			<xsd:annotation>
> 				<xsd:documentation><![CDATA[
> 	Indicates whether or not this bean is to be lazily initialized.
> 	If false, it will be instantiated on startup by bean factories
> 	that perform eager initialization of singletons. The default is
> 	"false".
> 	Note: This attribute will not be inherited by child bean definitions.
> 	Hence, it needs to be specified per concrete bean definition.
> 				]]></xsd:documentation>
> 			</xsd:annotation>
> 		</xsd:attribute>
> {code}
> As our documentation is single line, then it can be very long. I wonder if we should
not word wrap as well, and format similar to spring so its easier to read directly from the
schema file.



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

Mime
View raw message