Uploaded image for project: 'Camel'
  1. Camel
  2. CAMEL-8381

XML XSD enriched documentation should maybe word wrap for easier read in raw format

    XMLWordPrintableJSON

    Details

    • Estimated Complexity:
      Unknown

      Description

      If we look at the springframework schema, they word wrap their documentation and use CDATA section

      		<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>
      

      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.

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                davsclaus Claus Ibsen
                Reporter:
                davsclaus Claus Ibsen
              • Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: