Open-CMSIS-Pack / Open-CMSIS-Pack-Spec

Common Microcontroller Software Interface Standard - Pack(age) based distribution system
https://open-cmsis-pack.github.io/Open-CMSIS-Pack-Spec/
Apache License 2.0
50 stars 20 forks source link

`<environment>` element is not reported in the documentation among the child elements of the `subFamily` #219

Closed silviooliva closed 1 year ago

silviooliva commented 1 year ago

As can be inferred from the PACK.xsd schema, among the child elements of the /package/devices/family/subFamily there is also the <environment> element.

Indeed, the <subFamily> is defined as:

<!-- Sub Family Level begin-->
<xs:element name="subFamily" minOccurs="0" maxOccurs="unbounded">
    <xs:complexType>
        <xs:sequence>
            <xs:group ref="DevicePropertiesGroup" />
            <!-- Device Level begin-->
            <xs:element name="device" type="DeviceType" maxOccurs="unbounded" />
            <!-- Device Level end -->
        </xs:sequence>
        <xs:attribute name="DsubFamily" type="xs:string" use="required" />
    </xs:complexType>
</xs:element>

with the DevicePropertiesGroup that includes the environment element:

<!-- Default Device Properties Group -->
<xs:group name="DefaultDevicePropertiesGroup">
    <!-- multi-core devices have unique Pname attribute. One entry per processor and level -->
    <xs:choice>
        <xs:element name="compile" type="CompileType" />
        <xs:element name="memory" type="MemoryType" />
        <xs:element name="algorithm" type="AlgorithmType" />
        <xs:element name="book" type="BookType" />
        <xs:element name="description" type="DescriptionType" />
        <xs:element name="feature" type="DeviceFeatureType" />
        <xs:element name="environment" type="EnvironmentType" />
        <xs:element name="debugport" type="DebugPortType" />
        <xs:element name="accessportV1" type="AccessPortV1Type" />
        <xs:element name="accessportV2" type="AccessPortV2Type" />
        <xs:element name="debug" type="DebugType" />
        <xs:element name="trace" type="TraceType" />
        <xs:element name="debugvars" type="DebugVarsType" />
        <xs:element name="sequences" type="SequencesType" />
        <xs:element name="flashinfo"   type="FlashInfoType"   />
    </xs:choice>
</xs:group>

But in the html documentation, the environment element is not reported among the child elements of the subFamily.

To improve the documentation overall quality, this should be fixed.