Skip to content

Commit 9c7af61

Browse files
rnveachromani
rnveach
authored and
romani
committed
minor: fixes missed difference from previous commit
1 parent 58331b6 commit 9c7af61

File tree

2 files changed

+139
-139
lines changed

2 files changed

+139
-139
lines changed

‎docs/dtds/checkstyle-metadata_1_0.dtd‎

Lines changed: 108 additions & 108 deletions
Original file line numberDiff line numberDiff line change
@@ -7,145 +7,145 @@
77
"http://eclipse-cs.sourceforge.net/dtds/checkstyle-metadata_1_0.dtd">
88
-->
99

10-
<!--
11-
Root element for every metadata definition.
12-
-->
10+
<!--
11+
Root element for every metadata definition.
12+
-->
1313
<!ELEMENT checkstyle-metadata (rule-group-metadata+)>
1414

1515

16-
<!--
17-
Used to specify a group of rules.
18-
19-
The 'name' attribute is used as display name and is translatable.
20-
21-
The 'priority' influences the order in which groups appear in the configuration editor.
22-
23-
The 'hidden' attribut can be used to hide an entire group.
24-
-->
16+
<!--
17+
Used to specify a group of rules.
18+
19+
The 'name' attribute is used as display name and is translatable.
20+
21+
The 'priority' influences the order in which groups appear in the configuration editor.
22+
23+
The 'hidden' attribut can be used to hide an entire group.
24+
-->
2525
<!ELEMENT rule-group-metadata (description?,rule-metadata*)>
2626
<!ATTLIST rule-group-metadata
27-
name CDATA #REQUIRED
28-
priority CDATA #REQUIRED
29-
hidden (true|false) "false">
27+
name CDATA #REQUIRED
28+
priority CDATA #REQUIRED
29+
hidden (true|false) "false">
3030

3131
<!--
32-
Used to to provide a textual description for the element.
33-
The content might be translatable.
34-
-->
32+
Used to to provide a textual description for the element.
33+
The content might be translatable.
34+
-->
3535
<!ELEMENT description (#PCDATA)>
3636

3737

38-
<!--
39-
'rule-metadata' elements are used to define the metadata for a check (or filter) module.
40-
The 'name' attribute is used as display name and is translatable.
41-
42-
The 'internal-name' attribute defines the logical name of the module.
43-
44-
The 'parent' element defines if the module is a file set check (Checker as parent)
45-
or a regular 'TreeWalker' check.
46-
47-
The 'hasSeverity' attribute specifies if a module has a severity property that can be set.
48-
Some modules (like filters) have no severity property.
49-
50-
The 'hidden' attribute is used to hide a module, so it cannot be seen or
51-
configured in the configuration editor. This is only used for some special modules
52-
like FileContentsHolder. The attribut defaults to 'false'.
53-
54-
The 'deletable' attribute is used to specify if the module can be removed from the
55-
configuration via the configuration editor. This only makes sense for some
56-
special modules like Checker or TreeWalker, which must be present. Therefore
57-
this attribute default to 'false'.
58-
59-
The 'singleton' module is used to specify if the module should occur only once in
60-
a checkstyle configuration. This will be taken into account by the configuration editor.
61-
-->
38+
<!--
39+
'rule-metadata' elements are used to define the metadata for a check (or filter) module.
40+
The 'name' attribute is used as display name and is translatable.
41+
42+
The 'internal-name' attribute defines the logical name of the module.
43+
44+
The 'parent' element defines if the module is a file set check (Checker as parent)
45+
or a regular 'TreeWalker' check.
46+
47+
The 'hasSeverity' attribute specifies if a module has a severity property that can be set.
48+
Some modules (like filters) have no severity property.
49+
50+
The 'hidden' attribute is used to hide a module, so it cannot be seen or
51+
configured in the configuration editor. This is only used for some special modules
52+
like FileContentsHolder. The attribut defaults to 'false'.
53+
54+
The 'deletable' attribute is used to specify if the module can be removed from the
55+
configuration via the configuration editor. This only makes sense for some
56+
special modules like Checker or TreeWalker, which must be present. Therefore
57+
this attribute default to 'false'.
58+
59+
The 'singleton' module is used to specify if the module should occur only once in
60+
a checkstyle configuration. This will be taken into account by the configuration editor.
61+
-->
6262
<!ELEMENT rule-metadata (alternative-name+,description?,property-metadata*,quickfix*)>
6363
<!ATTLIST rule-metadata
64-
name CDATA #REQUIRED
65-
internal-name NMTOKEN #REQUIRED
66-
parent NMTOKEN #REQUIRED
67-
hasSeverity (true|false) "true"
68-
hidden (true|false) "false"
69-
deletable (true|false) "true"
70-
singleton (true|false) "false">
71-
72-
73-
<!--
74-
Every 'rule-metadata' element must have at least one 'alternative-name' child
75-
element, which describes under which name the module might occur in a configuration
76-
file as well. As you may know you can specify modules in a Checkstyle configuration
77-
file using the logical module name or the fully qualified class name.
78-
This means that this element is used to map the fully qualified module class name
79-
to this module.
80-
You are able to provide multiple alternative names, which might be useful if
81-
your package structure for your modules changed over time. In this case specify
82-
the old qualified class names for your module as 'alternative-name' element.
83-
The plugin is then able to load even Checkstyle configuration files where your old
84-
module names are used.
85-
-->
64+
name CDATA #REQUIRED
65+
internal-name NMTOKEN #REQUIRED
66+
parent NMTOKEN #REQUIRED
67+
hasSeverity (true|false) "true"
68+
hidden (true|false) "false"
69+
deletable (true|false) "true"
70+
singleton (true|false) "false">
71+
72+
73+
<!--
74+
Every 'rule-metadata' element must have at least one 'alternative-name' child
75+
element, which describes under which name the module might occur in a configuration
76+
file as well. As you may know you can specify modules in a Checkstyle configuration
77+
file using the logical module name or the fully qualified class name.
78+
This means that this element is used to map the fully qualified module class name
79+
to this module.
80+
You are able to provide multiple alternative names, which might be useful if
81+
your package structure for your modules changed over time. In this case specify
82+
the old qualified class names for your module as 'alternative-name' element.
83+
The plugin is then able to load even Checkstyle configuration files where your old
84+
module names are used.
85+
-->
8686
<!ELEMENT alternative-name EMPTY>
8787
<!ATTLIST alternative-name
88-
internal-name CDATA #REQUIRED>
88+
internal-name CDATA #REQUIRED>
8989

9090

9191
<!--
92-
'property-metadata' elements are used to describe the properties of a checkstyle
93-
module. Properties described this way can then be configured using the plugins
94-
configuration editor.
95-
96-
The 'name' attributes specifies the name of the property.
97-
98-
The 'datatype' attribute determines which kind of data the property contains.
99-
100-
The 'default-value' attribute is used to specify the default value of the property.
101-
102-
The 'override-default-value' attribute can be used to specify a default value that
103-
differs from the Checkstyle default. For instance this is used to provide different
104-
defaults for the logLoadError and suppressLoadError properties of the AbstractTypeAware checks.
105-
106-
Properties of data type 'MultiCheck' and 'SingleSelect' can (better must) be provided
107-
with an 'enumeration' child element which specifies the valid enumeration values for
108-
this property.
109-
-->
110-
<!ELEMENT property-metadata (description?,enumeration?)>
92+
'property-metadata' elements are used to describe the properties of a checkstyle
93+
module. Properties described this way can then be configured using the plugins
94+
configuration editor.
95+
96+
The 'name' attributes specifies the name of the property.
97+
98+
The 'datatype' attribute determines which kind of data the property contains.
99+
100+
The 'default-value' attribute is used to specify the default value of the property.
101+
102+
The 'override-default-value' attribute can be used to specify a default value that
103+
differs from the Checkstyle default. For instance this is used to provide different
104+
defaults for the logLoadError and suppressLoadError properties of the AbstractTypeAware checks.
105+
106+
Properties of data type 'MultiCheck' and 'SingleSelect' can (better must) be provided
107+
with an 'enumeration' child element which specifies the valid enumeration values for
108+
this property.
109+
-->
110+
<!ELEMENT property-metadata (description?,enumeration?)>
111111
<!ATTLIST property-metadata
112-
name NMTOKEN #REQUIRED
113-
datatype (Boolean|Integer|String|Regex|SingleSelect|MultiCheck|File|Hidden) #REQUIRED
114-
default-value CDATA #IMPLIED
115-
override-default-value CDATA #IMPLIED>
112+
name NMTOKEN #REQUIRED
113+
datatype (Boolean|Integer|String|Regex|SingleSelect|MultiCheck|File|Hidden) #REQUIRED
114+
default-value CDATA #IMPLIED
115+
override-default-value CDATA #IMPLIED>
116116

117117

118118
<!--
119-
The 'enumeration' element is used to provide valid enumeration values for 'MultiCheck'
120-
and 'SingleSelect' properties.
121-
Either the enumeration values are defined using 'property-value-option' child elements
122-
or by an option provider.
123-
An option provider is a java class that implements the interface
124-
'net.sf.eclipsecs.config.meta.IOptionProvider' and provides the
125-
enumeration values via implementation. This can be useful for providing large amounts
126-
of enumeration values (for instance all checkstyle tokens) or reoccurring sequences of
127-
enumeration values (for instance the java visibility values).
128-
The option provider and 'property-value-option' elements can be mixed together to build
129-
a single enumeration.
130-
-->
119+
The 'enumeration' element is used to provide valid enumeration values for 'MultiCheck'
120+
and 'SingleSelect' properties.
121+
Either the enumeration values are defined using 'property-value-option' child elements
122+
or by an option provider.
123+
An option provider is a java class that implements the interface
124+
'net.sf.eclipsecs.config.meta.IOptionProvider' and provides the
125+
enumeration values via implementation. This can be useful for providing large amounts
126+
of enumeration values (for instance all checkstyle tokens) or reoccurring sequences of
127+
enumeration values (for instance the java visibility values).
128+
The option provider and 'property-value-option' elements can be mixed together to build
129+
a single enumeration.
130+
-->
131131
<!ELEMENT enumeration (property-value-option*)>
132132
<!ATTLIST enumeration
133-
option-provider NMTOKEN #IMPLIED>
133+
option-provider NMTOKEN #IMPLIED>
134134

135135

136136
<!--
137-
Specifies a single enumeration value.
138-
-->
137+
Specifies a single enumeration value.
138+
-->
139139
<!ELEMENT property-value-option EMPTY>
140140
<!ATTLIST property-value-option
141-
value CDATA #REQUIRED>
142-
141+
value CDATA #REQUIRED>
142+
143143
<!--
144144
Defines a marker resolution (quickfix) for the module.
145-
Quickfixes are required to implement the
146-
net.sf.eclipsecs.quickfixes.ICheckstyleMarkerResolution
145+
Quickfixes are required to implement the
146+
net.sf.eclipsecs.quickfixes.ICheckstyleMarkerResolution
147147
interface.
148148
-->
149149
<!ELEMENT quickfix EMPTY>
150150
<!ATTLIST quickfix
151-
classname NMTOKEN #REQUIRED>
151+
classname NMTOKEN #REQUIRED>

‎docs/dtds/checkstyle-metadata_1_1.dtd‎

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,19 @@
77
"http://eclipse-cs.sourceforge.net/dtds/checkstyle-metadata_1_1.dtd">
88
-->
99

10-
<!--
10+
<!--
1111
Root element for every metadata definition.
1212
-->
1313
<!ELEMENT checkstyle-metadata (rule-group-metadata+)>
1414

1515

16-
<!--
16+
<!--
1717
Used to specify a group of rules.
1818
1919
The 'name' attribute is used as display name and is translatable.
20-
20+
2121
The 'priority' influences the order in which groups appear in the configuration editor.
22-
22+
2323
The 'hidden' attribut can be used to hide an entire group.
2424
-->
2525
<!ELEMENT rule-group-metadata (description?,rule-metadata*)>
@@ -35,24 +35,24 @@
3535
<!ELEMENT description (#PCDATA)>
3636

3737

38-
<!--
38+
<!--
3939
'rule-metadata' elements are used to define the metadata for a check (or filter) module.
4040
The 'name' attribute is used as display name and is translatable.
4141
4242
The 'internal-name' attribute defines the logical name of the module.
43-
43+
4444
The 'parent' element defines if the module is a file set check (Checker as parent)
4545
or a regular 'TreeWalker' check.
4646
4747
The 'hasSeverity' attribute specifies if a module has a severity property that can be set.
4848
Some modules (like filters) have no severity property.
4949
50-
The 'hidden' attribute is used to hide a module, so it cannot be seen or
50+
The 'hidden' attribute is used to hide a module, so it cannot be seen or
5151
configured in the configuration editor. This is only used for some special modules
5252
like FileContentsHolder. The attribut defaults to 'false'.
5353
54-
The 'deletable' attribute is used to specify if the module can be removed from the
55-
configuration via the configuration editor. This only makes sense for some
54+
The 'deletable' attribute is used to specify if the module can be removed from the
55+
configuration via the configuration editor. This only makes sense for some
5656
special modules like Checker or TreeWalker, which must be present. Therefore
5757
this attribute default to 'false'.
5858
@@ -70,22 +70,22 @@
7070
singleton (true|false) "false">
7171

7272

73-
<!--
74-
Every 'rule-metadata' element must have at least one 'alternative-name' child
73+
<!--
74+
Every 'rule-metadata' element must have at least one 'alternative-name' child
7575
element, which describes under which name the module might occur in a configuration
7676
file as well. As you may know you can specify modules in a Checkstyle configuration
7777
file using the logical module name or the fully qualified class name.
78-
This means that this element is used to map the fully qualified module class name
78+
This means that this element is used to map the fully qualified module class name
7979
to this module.
8080
You are able to provide multiple alternative names, which might be useful if
8181
your package structure for your modules changed over time. In this case specify
8282
the old qualified class names for your module as 'alternative-name' element.
8383
The plugin is then able to load even Checkstyle configuration files where your old
8484
module names are used.
85-
-->
85+
-->
8686
<!ELEMENT alternative-name EMPTY>
8787
<!ATTLIST alternative-name
88-
internal-name CDATA #REQUIRED>
88+
internal-name CDATA #REQUIRED>
8989

9090

9191
<!--
@@ -107,7 +107,7 @@
107107
with an 'enumeration' child element which specifies the valid enumeration values for
108108
this property.
109109
-->
110-
<!ELEMENT property-metadata (description?,enumeration?)>
110+
<!ELEMENT property-metadata (description?,enumeration?)>
111111
<!ATTLIST property-metadata
112112
name NMTOKEN #REQUIRED
113113
datatype (Boolean|Integer|String|Regex|SingleSelect|MultiCheck|File|Hidden) #REQUIRED
@@ -116,18 +116,18 @@
116116

117117

118118
<!--
119-
The 'enumeration' element is used to provide valid enumeration values for 'MultiCheck'
120-
and 'SingleSelect' properties.
121-
Either the enumeration values are defined using 'property-value-option' child elements
122-
or by an option provider.
123-
An option provider is a java class that implements the interface
124-
'net.sf.eclipsecs.config.meta.IOptionProvider' and provides the
125-
enumeration values via implementation. This can be useful for providing large amounts
126-
of enumeration values (for instance all checkstyle tokens) or reoccurring sequences of
127-
enumeration values (for instance the java visibility values).
128-
The option provider and 'property-value-option' elements can be mixed together to build
129-
a single enumeration.
130-
-->
119+
The 'enumeration' element is used to provide valid enumeration values for 'MultiCheck'
120+
and 'SingleSelect' properties.
121+
Either the enumeration values are defined using 'property-value-option' child elements
122+
or by an option provider.
123+
An option provider is a java class that implements the interface
124+
'net.sf.eclipsecs.config.meta.IOptionProvider' and provides the
125+
enumeration values via implementation. This can be useful for providing large amounts
126+
of enumeration values (for instance all checkstyle tokens) or reoccurring sequences of
127+
enumeration values (for instance the java visibility values).
128+
The option provider and 'property-value-option' elements can be mixed together to build
129+
a single enumeration.
130+
-->
131131
<!ELEMENT enumeration (property-value-option*)>
132132
<!ATTLIST enumeration
133133
option-provider NMTOKEN #IMPLIED>
@@ -142,8 +142,8 @@
142142

143143
<!--
144144
Defines a marker resolution (quickfix) for the module.
145-
Quickfixes are required to implement the
146-
net.sf.eclipsecs.quickfixes.ICheckstyleMarkerResolution
145+
Quickfixes are required to implement the
146+
net.sf.eclipsecs.quickfixes.ICheckstyleMarkerResolution
147147
interface.
148148
-->
149149
<!ELEMENT quickfix EMPTY>
@@ -154,5 +154,5 @@
154154
Defines the message keys used by this module.
155155
-->
156156
<!ELEMENT message-key EMPTY>
157-
<!ATTLIST message-key
158-
key NMTOKEN #REQUIRED>
157+
<!ATTLIST message-key
158+
key NMTOKEN #REQUIRED>

0 commit comments

Comments
 (0)