Skip to content

Commit ab03c7d

Browse files
Bananeweizenlkoe
Bananeweizen
authored and
lkoe
committed
fix multiple extension declaration issues
* remove empty [...] sections, they are otherwise part of the generated documentation * replace link tags by code tags, since link tags lead to validation errors and are not rendered * use descriptive names for the extension points instead of repeating their IDs * fix the wrong occurrences of "filters" as extension point schema IDs. * typos None of these changes influences the extension point registry. All relevant IDs are still the same as before, so extenders continue to work without modification.
1 parent 4f8527d commit ab03c7d

File tree

10 files changed

+92
-315
lines changed

10 files changed

+92
-315
lines changed

‎net.sf.eclipsecs.core/plugin.xml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
schema="schema/checkstyleAddonProvider.exsd"/>
88

99
<!-- defines the extension point to contribute custom configuration type. -->
10-
<extension-point id="configurationtypes" name="Configuration types" schema="schema/configtypes.exsd"/>
10+
<extension-point id="configurationtypes" name="Checkstyle configuration types" schema="schema/configtypes.exsd"/>
1111

1212
<!-- defines the extension point to contribute default checkstyle configurations to the checkstyle plugin -->
1313
<extension-point id="configurations" name="Checkstyle configurations" schema="schema/configurations.exsd"/>
@@ -16,7 +16,7 @@
1616
<extension-point id="filters" name="Checkstyle filters" schema="schema/filters.exsd"/>
1717

1818
<!-- defines the extension point to contribute custom configuration save filters -->
19-
<extension-point id="saveFilters" name="Configuration save filters" schema="schema/saveFilters.exsd"/>
19+
<extension-point id="saveFilters" name="Checkstyle configuration save filters" schema="schema/saveFilters.exsd"/>
2020

2121
<extension id="CheckstyleBuilder" name="%CheckstyleBuilder.name" point="org.eclipse.core.resources.builders">
2222
<builder>

‎net.sf.eclipsecs.core/schema/checkstyleAddonProvider.exsd‎

Lines changed: 6 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,26 @@
11
<?xml version='1.0' encoding='UTF-8'?>
22
<!-- Schema file written by PDE -->
3-
<schema targetNamespace="net.sf.eclipsecs.core">
3+
<schema targetNamespace="net.sf.eclipsecs.core" xmlns="http://www.w3.org/2001/XMLSchema">
44
<annotation>
5-
<appInfo>
6-
<meta.schema plugin="net.sf.eclipsecs.core" id="checkstyleAddonProvider" name="checkstyleAddonProvider"/>
7-
</appInfo>
5+
<appinfo>
6+
<meta.schema plugin="net.sf.eclipsecs.core" id="checkstyleAddonProvider" name="Checkstyle Addon provider"/>
7+
</appinfo>
88
<documentation>
99
Use this extension point to declare a plugin providing Checkstyle addon modules (e.g. custom checks) and optionally appropriate metadata for the eclipse-cs plugin.
1010
</documentation>
1111
</annotation>
1212

1313
<annotation>
14-
<appInfo>
14+
<appinfo>
1515
<meta.section type="since"/>
16-
</appInfo>
16+
</appinfo>
1717
<documentation>
1818
5.6.0
1919
</documentation>
2020
</annotation>
2121

22-
<annotation>
23-
<appInfo>
24-
<meta.section type="examples"/>
25-
</appInfo>
26-
<documentation>
27-
[Enter extension point usage example here.]
28-
</documentation>
29-
</annotation>
3022

31-
<annotation>
32-
<appInfo>
33-
<meta.section type="apiInfo"/>
34-
</appInfo>
35-
<documentation>
36-
[Enter API information here.]
37-
</documentation>
38-
</annotation>
3923

40-
<annotation>
41-
<appInfo>
42-
<meta.section type="implementation"/>
43-
</appInfo>
44-
<documentation>
45-
[Enter information about supplied implementation of this extension point.]
46-
</documentation>
47-
</annotation>
4824

49-
<annotation>
50-
<appInfo>
51-
<meta.section type="copyright"/>
52-
</appInfo>
53-
<documentation>
54-
55-
</documentation>
56-
</annotation>
5725

5826
</schema>

‎net.sf.eclipsecs.core/schema/configtypes.exsd‎

Lines changed: 17 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,29 @@
11
<?xml version='1.0' encoding='UTF-8'?>
22
<!-- Schema file written by PDE -->
3-
<schema targetNamespace="net.sf.eclipsecs.core">
3+
<schema targetNamespace="net.sf.eclipsecs.core" xmlns="http://www.w3.org/2001/XMLSchema">
44
<annotation>
5-
<appInfo>
6-
<meta.schema plugin="net.sf.eclipsecs.core" id="configurationtypes" name="configurationtypes"/>
7-
</appInfo>
5+
<appinfo>
6+
<meta.schema plugin="net.sf.eclipsecs.core" id="configurationtypes" name="Checkstyle configuration types"/>
7+
</appinfo>
88
<documentation>
9-
This extension point can be used to provide custom confifuration types.
9+
This extension point can be used to provide custom configuration types.
1010
</documentation>
1111
</annotation>
1212

1313
<element name="extension">
14+
<annotation>
15+
<appinfo>
16+
<meta.element />
17+
</appinfo>
18+
</annotation>
1419
<complexType>
1520
<sequence>
1621
<element ref="configuration-type" minOccurs="1" maxOccurs="unbounded"/>
1722
</sequence>
1823
<attribute name="point" type="string" use="required">
1924
<annotation>
2025
<documentation>
21-
The extension point id this contribution shall apply to
26+
The extension point id this contribution shall apply to.
2227
</documentation>
2328
</annotation>
2429
</attribute>
@@ -51,18 +56,18 @@ The id is used to identify the specific filter set.
5156
<annotation>
5257
<documentation>
5358
The fully qualified class name of the configuration type implementation.
54-
The class must implement &lt;link&gt;net.sf.eclipsecs.core.config.configtypes.IConfigurationType&lt;/link&gt;.
59+
The class must implement &lt;code&gt;net.sf.eclipsecs.core.config.configtypes.IConfigurationType&lt;/code&gt;.
5560
</documentation>
5661
</annotation>
5762
</attribute>
5863
<attribute name="name" type="string" use="required">
5964
<annotation>
6065
<documentation>
61-
The human readable name of this name of this configuration type.
66+
The human readable name of this configuration type.
6267
</documentation>
63-
<appInfo>
68+
<appinfo>
6469
<meta.attribute translatable="true"/>
65-
</appInfo>
70+
</appinfo>
6671
</annotation>
6772
</attribute>
6873
<attribute name="internal-name" type="string" use="required">
@@ -104,48 +109,16 @@ The class must implement &lt;link&gt;net.sf.eclipsecs.core.config.configtypes.IC
104109
</element>
105110

106111
<annotation>
107-
<appInfo>
112+
<appinfo>
108113
<meta.section type="since"/>
109-
</appInfo>
114+
</appinfo>
110115
<documentation>
111116
4.0.0
112117
</documentation>
113118
</annotation>
114119

115-
<annotation>
116-
<appInfo>
117-
<meta.section type="examples"/>
118-
</appInfo>
119-
<documentation>
120-
[Enter extension point usage example here.]
121-
</documentation>
122-
</annotation>
123120

124-
<annotation>
125-
<appInfo>
126-
<meta.section type="apiInfo"/>
127-
</appInfo>
128-
<documentation>
129-
[Enter API information here.]
130-
</documentation>
131-
</annotation>
132121

133-
<annotation>
134-
<appInfo>
135-
<meta.section type="implementation"/>
136-
</appInfo>
137-
<documentation>
138-
[Enter information about supplied implementation of this extension point.]
139-
</documentation>
140-
</annotation>
141122

142-
<annotation>
143-
<appInfo>
144-
<meta.section type="copyright"/>
145-
</appInfo>
146-
<documentation>
147-
148-
</documentation>
149-
</annotation>
150123

151124
</schema>

‎net.sf.eclipsecs.core/schema/configurations.exsd‎

Lines changed: 11 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,19 @@
22
<!-- Schema file written by PDE -->
33
<schema targetNamespace="net.sf.eclipsecs.core" xmlns="http://www.w3.org/2001/XMLSchema">
44
<annotation>
5-
<appInfo>
6-
<meta.schema plugin="net.sf.eclipsecs.core" id="filters" name="filters"/>
7-
</appInfo>
5+
<appinfo>
6+
<meta.schema plugin="net.sf.eclipsecs.core" id="configurations" name="Checkstyle configurations"/>
7+
</appinfo>
88
<documentation>
99
This extension point can be used to provide specific filter sets.
1010
</documentation>
1111
</annotation>
1212

1313
<element name="extension">
1414
<annotation>
15-
<appInfo>
15+
<appinfo>
1616
<meta.element />
17-
</appInfo>
17+
</appinfo>
1818
</annotation>
1919
<complexType>
2020
<sequence>
@@ -23,7 +23,7 @@
2323
<attribute name="point" type="string" use="required">
2424
<annotation>
2525
<documentation>
26-
The extension point id this contribution shall apply to
26+
The extension point id this contribution shall apply to.
2727
</documentation>
2828
</annotation>
2929
</attribute>
@@ -67,9 +67,9 @@ The id is used to identify the specific filter set.
6767
<documentation>
6868
A description of the check configuration.
6969
</documentation>
70-
<appInfo>
70+
<appinfo>
7171
<meta.attribute translatable="true"/>
72-
</appInfo>
72+
</appinfo>
7373
</annotation>
7474
</attribute>
7575
<attribute name="location" type="string" use="required">
@@ -93,7 +93,7 @@ The all-time default configuration &quot;Sun Checks&quot; is defined with defaul
9393
<element name="property">
9494
<annotation>
9595
<documentation>
96-
Defines a resolvable property for the builtin-configuration. This is useful for having mutliple builtin configurations share a common checkstyle configuration file - with the exception of them having a few parametrizable differences (e.g. max line length 80 vs. 100).
96+
Defines a resolvable property for the builtin-configuration. This is useful for having multiple builtin configurations share a common checkstyle configuration file - with the exception of them having a few parametrizable differences (e.g. max line length 80 vs. 100).
9797
</documentation>
9898
</annotation>
9999
<complexType>
@@ -115,40 +115,16 @@ The all-time default configuration &quot;Sun Checks&quot; is defined with defaul
115115
</element>
116116

117117
<annotation>
118-
<appInfo>
118+
<appinfo>
119119
<meta.section type="since"/>
120-
</appInfo>
120+
</appinfo>
121121
<documentation>
122122
4.0.0
123123
</documentation>
124124
</annotation>
125125

126-
<annotation>
127-
<appInfo>
128-
<meta.section type="examples"/>
129-
</appInfo>
130-
<documentation>
131-
[Enter extension point usage example here.]
132-
</documentation>
133-
</annotation>
134126

135-
<annotation>
136-
<appInfo>
137-
<meta.section type="apiInfo"/>
138-
</appInfo>
139-
<documentation>
140-
[Enter API information here.]
141-
</documentation>
142-
</annotation>
143127

144-
<annotation>
145-
<appInfo>
146-
<meta.section type="implementation"/>
147-
</appInfo>
148-
<documentation>
149-
[Enter information about supplied implementation of this extension point.]
150-
</documentation>
151-
</annotation>
152128

153129

154130
</schema>

‎net.sf.eclipsecs.core/schema/filters.exsd‎

Lines changed: 12 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,21 @@
11
<?xml version='1.0' encoding='UTF-8'?>
22
<!-- Schema file written by PDE -->
3-
<schema targetNamespace="net.sf.eclipsecs.core">
3+
<schema targetNamespace="net.sf.eclipsecs.core" xmlns="http://www.w3.org/2001/XMLSchema">
44
<annotation>
5-
<appInfo>
6-
<meta.schema plugin="net.sf.eclipsecs.core" id="filters" name="filters"/>
7-
</appInfo>
5+
<appinfo>
6+
<meta.schema plugin="net.sf.eclipsecs.core" id="filters" name="Checkstyle filters"/>
7+
</appinfo>
88
<documentation>
99
This extension point can be used to provide specific filter sets.
1010
</documentation>
1111
</annotation>
1212

1313
<element name="extension">
14+
<annotation>
15+
<appinfo>
16+
<meta.element />
17+
</appinfo>
18+
</annotation>
1419
<complexType>
1520
<sequence>
1621
<element ref="filter" minOccurs="1" maxOccurs="unbounded"/>
@@ -54,7 +59,7 @@ The id is used to identify the specific filter set.
5459
<annotation>
5560
<documentation>
5661
The fully qualified class name of the filter implementation.
57-
The filter class must implement &lt;link&gt;net.sf.eclipsecs.core.filters.IFilter&lt;/link&gt;.
62+
The filter class must implement &lt;code&gt;net.sf.eclipsecs.core.filters.IFilter&lt;/code&gt;.
5863
</documentation>
5964
</annotation>
6065
</attribute>
@@ -116,48 +121,16 @@ The filter class must implement &lt;link&gt;net.sf.eclipsecs.core.filters.IFilte
116121
</element>
117122

118123
<annotation>
119-
<appInfo>
124+
<appinfo>
120125
<meta.section type="since"/>
121-
</appInfo>
126+
</appinfo>
122127
<documentation>
123128
4.0.0
124129
</documentation>
125130
</annotation>
126131

127-
<annotation>
128-
<appInfo>
129-
<meta.section type="examples"/>
130-
</appInfo>
131-
<documentation>
132-
[Enter extension point usage example here.]
133-
</documentation>
134-
</annotation>
135132

136-
<annotation>
137-
<appInfo>
138-
<meta.section type="apiInfo"/>
139-
</appInfo>
140-
<documentation>
141-
[Enter API information here.]
142-
</documentation>
143-
</annotation>
144133

145-
<annotation>
146-
<appInfo>
147-
<meta.section type="implementation"/>
148-
</appInfo>
149-
<documentation>
150-
[Enter information about supplied implementation of this extension point.]
151-
</documentation>
152-
</annotation>
153134

154-
<annotation>
155-
<appInfo>
156-
<meta.section type="copyright"/>
157-
</appInfo>
158-
<documentation>
159-
160-
</documentation>
161-
</annotation>
162135

163136
</schema>

0 commit comments

Comments
 (0)