[
https://issues.apache.org/jira/browse/CAMEL-8381?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14351867#comment-14351867
]
ASF GitHub Bot commented on CAMEL-8381:
---------------------------------------
GitHub user nkukhar opened a pull request:
https://github.com/apache/camel/pull/427
[CAMEL-8381] XML XSD enriched documentation word wrap documentation text
for easier read in raw file
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/nkukhar/camel camel-8381-new
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/camel/pull/427.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #427
----
commit beee84db672f254b4a3d7cd9582303ef71437497
Author: nkukhar <[email protected]>
Date: 2015-03-08T02:08:15Z
[CAMEL-8381] Wraps documentation for easier read in raw file.
commit b2cdc4a27a981d6c04a0a86b957d4a566d6dbeaa
Author: nkukhar <[email protected]>
Date: 2015-03-08T02:11:48Z
Moving dependencies to class level attributes to reduce number of
parameters in methods.
----
> 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
> Priority: Minor
>
> 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)
