Add documentation annotation to enumeration in Schema view?

[Christian Roth]

How can I add documentation annotations to individual xs:enumeration elements to document the meaning of the respective attribute values in the Schema view of the XSD editor? (I can add them "manually" in the Text view, though.)

Anyway, that documentation does not show up in the generated HTML documentation for that schema anywhere (except for in the source component detail, of course). Is this an oversight, design decision or do I have just some documentation generation settings set wrongly?

Here's a short sample XSD to test. Mind the documentation annotations for the individual xs:enumeration values "auto" and "manual":

Code: Select all

<?xml version="1.0" encoding="UTF-8"?>

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">



  <xs:element name="sample">

    <xs:complexType>

      <xs:attribute ref="mode"/>

    </xs:complexType>

  </xs:element>



  <xs:attribute name="mode">

    <xs:simpleType>

      <xs:restriction base="xs:string">

        <xs:annotation>

          <xs:documentation>documentation for "auto"</xs:documentation>

        </xs:annotation>

        <xs:enumeration value="auto"/>

        <xs:annotation>

          <xs:documentation>documentation for "manual"</xs:documentation>

        </xs:annotation>

        <xs:enumeration value="manual"/>

      </xs:restriction>

    </xs:simpleType>

  </xs:attribute>

</xs:schema>

-Christian

[alex_jitianu]

Hello,

Currently, facets documentation cannot be edited in 'Schema' page and don't appear in the generated schema documentation. We added an issue on our internal bug tracking system to resolve these problems as soon as possible.

Best regards,
Alex

[iulian_velea]

Hello Christian,

We added the documentation of the schema components in the generated documentation and the facets documentation can now be edited in the diagram.
These features will be available in the next version.

Cheers,
Iulian