Lionel Cons created ARTEMIS-1909:
------------------------------------
Summary: artemis-configuration.xsd should not contain dummy
documentation
Key: ARTEMIS-1909
URL: https://issues.apache.org/jira/browse/ARTEMIS-1909
Project: ActiveMQ Artemis
Issue Type: Improvement
Reporter: Lionel Cons
{{artemis-configuration.xsd}} is a very useful source of information and most
of the elements are properly documented. This is great.
There are only very few exceptions with dummy "XXX" documentation:
{code}
$ grep -n -C 3 XXX artemis-configuration.xsd
216- <xsd:element name="log-delegate-factory-class-name"
type="xsd:string" maxOccurs="1" minOccurs="0">
217- <xsd:annotation>
218- <xsd:documentation>
219: XXX
220- </xsd:documentation>
221- </xsd:annotation>
222- </xsd:element>
--
1750- <xsd:attribute name="discovery-group-name"
type="xsd:IDREF" use="required">
1751- <xsd:annotation>
1752- <xsd:documentation>
1753: XXX -- this is a duplicate...
1754- </xsd:documentation>
1755- </xsd:annotation>
1756- </xsd:attribute>
--
2990- <xsd:attribute name="match" type="xsd:string" use="required">
2991- <xsd:annotation>
2992- <xsd:documentation>
2993: XXX
2994- </xsd:documentation>
2995- </xsd:annotation>
2996- </xsd:attribute>
{code}
It would be nice to have these three documented too.
FWIW, there are also two "XXX" comments:
{code}
1103- <xsd:element name="broadcast-group">
1104- <xsd:complexType>
1105- <xsd:sequence>
1106: <!-- XXX these 2 local-* here...-->
1107- <xsd:element ref="local-bind-address" maxOccurs="1"
minOccurs="0"/>
1108- <xsd:element ref="local-bind-port" maxOccurs="1"
minOccurs="0"/>
1109- <xsd:element name="group-address" type="xsd:string"
maxOccurs="1" minOccurs="0">
--
1163- <xsd:element name="discovery-group">
1164- <xsd:complexType>
1165- <xsd:all>
1166: <!-- XXX -->
1167- <xsd:element name="group-address" type="xsd:string"
maxOccurs="1" minOccurs="0">
1168- <xsd:annotation>
1169- <xsd:documentation>
{code}
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
