Claus Ibsen created CAMEL-8381:
----------------------------------

             Summary: 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)

Reply via email to