Skip to content

Commit 4927f2d

Browse files
authored
Merge pull request #236 from FIXTradingCommunity/Issue229
[#229] Extend recommended documentation purposes and define all purposes
2 parents aa85874 + a4ee542 commit 4927f2d

File tree

1 file changed

+38
-6
lines changed

1 file changed

+38
-6
lines changed

repository/src/main/resources/xsd/repositorytypes.xsd

Lines changed: 38 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -831,14 +831,46 @@
831831
<xs:documentation>Recommended annotation purposes</xs:documentation>
832832
</xs:annotation>
833833
<xs:restriction base="xs:string">
834-
<xs:enumeration value="SYNOPSIS"/>
835-
<xs:enumeration value="ELABORATION"/>
836-
<xs:enumeration value="EXAMPLE"/>
834+
<xs:enumeration value="SYNOPSIS">
835+
<xs:annotation>
836+
<xs:documentation>
837+
Brief summary of the element, typically highlighting its key function or purpose, restricted to one paragraph for conciseness.</xs:documentation>
838+
</xs:annotation>
839+
</xs:enumeration>
840+
<xs:enumeration value="ELABORATION">
841+
<xs:annotation>
842+
<xs:documentation>
843+
Detailed explanation of the element, clarifying its usage, functionality, or background.</xs:documentation>
844+
</xs:annotation>
845+
</xs:enumeration>
846+
<xs:enumeration value="EXAMPLE">
847+
<xs:annotation>
848+
<xs:documentation>
849+
Sample or illustration demonstrating how the element is used in practice.</xs:documentation>
850+
</xs:annotation>
851+
</xs:enumeration>
837852
<xs:enumeration value="DISPLAY">
838853
<xs:annotation>
839-
<xs:documentation>For UI when different from canonical name; may
840-
have multi-language displays
841-
</xs:documentation>
854+
<xs:documentation>
855+
For UI when different from canonical name; may have multi-language displays.</xs:documentation>
856+
</xs:annotation>
857+
</xs:enumeration>
858+
<xs:enumeration value="CAPTION">
859+
<xs:annotation>
860+
<xs:documentation>
861+
Descriptive label or title for the element, may be used for tables, figures, headings or brief annotations.</xs:documentation>
862+
</xs:annotation>
863+
</xs:enumeration>
864+
<xs:enumeration value="TOOLTIP">
865+
<xs:annotation>
866+
<xs:documentation>
867+
Short message or hint that appears when hovering over the element, usually explaining its function or use.</xs:documentation>
868+
</xs:annotation>
869+
</xs:enumeration>
870+
<xs:enumeration value="DEFINITION">
871+
<xs:annotation>
872+
<xs:documentation>
873+
Precise and formal explanation of the element, restricted to one sentence in length to ensure brevity.</xs:documentation>
842874
</xs:annotation>
843875
</xs:enumeration>
844876
</xs:restriction>

0 commit comments

Comments
 (0)