Skip to content

Commit 2b87127

Browse files
authored
Add description child to part element (#374)
This PR is related to issue #373. Signed-off-by: Silvio Lucio OLIVA <[email protected]>
1 parent 7c24c43 commit 2b87127

File tree

4 files changed

+28
-11
lines changed

4 files changed

+28
-11
lines changed

doxygen/pack.dxy

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ PROJECT_NAME = "Open-CMSIS-Pack"
3838
# could be handy for archiving the generated documentation or if some version
3939
# control system is used.
4040

41-
PROJECT_NUMBER = "Version 1.7.54"
41+
PROJECT_NUMBER = "Version 1.7.55"
4242

4343
# Using the PROJECT_BRIEF tag one can provide an optional one line description
4444
# for a project that appears at the top of each page and should give viewer a

doxygen/src/General.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,12 @@ packs) and provides useful tips when creating a pack.
8080
<th>Version</th>
8181
<th>Description</th>
8282
</tr>
83+
<tr>
84+
<td>1.7.55</td>
85+
<td>
86+
- add 'description' child to \ref element_part "part" element
87+
</td>
88+
</tr>
8389
<tr>
8490
<td>1.7.54</td>
8591
<td>

doxygen/src/parts_schema.txt

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Optionally, a part may have a group (Hgroup=) and a sub-group (Hsub=) to add fur
1111
different cuts of the same part exists, and a variant (Hvariant=).
1212

1313
A part is therefore identified by a name and a class together with the vendor specified by the pack.
14-
A part vendor must ensure that the combination of name, revision, class, variant, group and sub-group is unique and not used by multiple parts.
14+
A part vendor must ensure that the combination of name, revision, variant, class, group and sub-group is unique and not used by multiple parts.
1515

1616
\b Example
1717
\code
@@ -21,7 +21,8 @@ A part vendor must ensure that the combination of name, revision, class, variant
2121
<parts>
2222

2323
<part Hvendor="STMicroelectronics" Hname="STSAFE-A110" Hvariant="STSAFA110DFSPL02" Hclass="Secure MCUs" Hgroup="Authentication">
24-
<feature type="Crypto" n="128.256" name="Authentication and security for peripherals and IoT devices from STMicroelectronics"/>
24+
<description>Authentication, state-of-the-art security for peripherals and IoT devices</description>
25+
<feature type="Crypto" n="128.256" name="Authentication and security"/>
2526
<book name="Images/STSAFA110DFSPL02_UM.pdf" title="User Manual" public="true"/>
2627
<book name="Images/STSAFA110DFSPL02_DS.pdf" title="Datasheet" public="true"/>
2728
<image top="Images/STSAFA110DFSPL02_image.jpg" public="true">
@@ -31,7 +32,8 @@ A part vendor must ensure that the combination of name, revision, class, variant
3132
</part>
3233

3334
<part Hvendor="STMicroelectronics" Hname="STSAFE-A110" Hvariant="STSAFA110S8SPL02" Hclass="Secure MCUs" Hgroup="Authentication">
34-
<feature type="Crypto" n="128.256" name="Authentication and security for peripherals and IoT devices from STMicroelectronics"/>
35+
<description>Authentication, state-of-the-art security for peripherals and IoT devices</description>
36+
<feature type="Crypto" n="128.256" name="Authentication and security"/>
3537
<book name="Images/STSAFA110S8SPL02_UM.pdf" title="User Manual" public="true"/>
3638
<book name="Images/STSAFA110S8SPL02_DS.pdf" title="Datasheet" public="true"/>
3739
<image top="Images/STSAFA110S8SPL02_image.jpg" public="true">
@@ -148,23 +150,29 @@ This element specifies a part. At least one part element must be specified per p
148150
<th>Type</th>
149151
<th>Occurrence</th>
150152
</tr>
153+
<tr>
154+
<td>description</td>
155+
<td>Brief summary of the part (maximum 256 characters, recommended 128 characters).</td>
156+
<td>BriefDescType</td>
157+
<td>0..1</td>
158+
</tr>
151159
<tr>
152160
<td>\ref element_part_feature "feature"</td>
153161
<td>Describes the features of the part.</td>
154162
<td>DeviceFeatureType</td>
155-
<td>0..* </td>
163+
<td>0..*</td>
156164
</tr>
157165
<tr>
158166
<td>\ref element_part_book "book"</td>
159167
<td>Specifies documents that are relevant for the part.</td>
160168
<td>BookType</td>
161-
<td>0..* </td>
169+
<td>0..*</td>
162170
</tr>
163171
<tr>
164172
<td>\ref element_part_image "image"</td>
165173
<td>Specifies the part pictures.</td>
166174
<td>ComplexType</td>
167-
<td>0..1 </td>
175+
<td>0..1</td>
168176
</tr>
169177
<tr>
170178
<td>\ref element_part_environment "environment"</td>

schema/PACK.xsd

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,15 @@
1818
limitations under the License.
1919
2020
21-
$Date: 05. Nov 2025
22-
$Revision: 1.7.54
21+
$Date: 07. Nov 2025
22+
$Revision: 1.7.55
2323
$Project: Schema File for Package Description File Format Specification
2424
2525
Package file name convention <vendor>.<name>.<version>.pack
26-
SchemaVersion=1.7.54
26+
SchemaVersion=1.7.55
2727
28+
07. Nov 2025: v1.7.55
29+
- add 'description' child to "part" element
2830
05. Nov 2025: v1.7.54
2931
- align documentation with XSD schema by adding 'Hrevision' description to the "part" element
3032
- add 'Hrevision' as an optional attribute of the "mountedPart" element
@@ -262,7 +264,7 @@
262264
263265
-->
264266

265-
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="qualified" version="1.7.54">
267+
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="qualified" version="1.7.55">
266268

267269
<!-- NonNegativeInteger specifies the format in which numbers are represented in hexadecimal or decimal format -->
268270
<xs:simpleType name="NonNegativeInteger">
@@ -1770,6 +1772,7 @@
17701772

17711773
<xs:complexType name="PartType">
17721774
<xs:sequence>
1775+
<xs:element name="description" type="BriefDescType" minOccurs="0" maxOccurs="1"/>
17731776
<xs:element name="feature" type="DeviceFeatureType" minOccurs="0" maxOccurs="unbounded" />
17741777
<xs:element name="book" type="BookType" minOccurs="0" maxOccurs="unbounded" />
17751778
<xs:element name="image" minOccurs="0" maxOccurs="1">

0 commit comments

Comments
 (0)