Skip to content

Commit b5763fe

Browse files
committed
Consistent attribute documentation/formatting in spring-context and spring-mvc schemas
1 parent 662d8aa commit b5763fe

File tree

6 files changed

+218
-231
lines changed

6 files changed

+218
-231
lines changed

spring-context/src/main/resources/org/springframework/context/config/spring-context-3.2.xsd

Lines changed: 28 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -25,64 +25,62 @@
2525
<xsd:documentation><![CDATA[
2626
The location of the properties file to resolve placeholders against, as a Spring
2727
resource location: a URL, a "classpath:" pseudo URL, or a relative file path.
28-
Multiple locations may be specified, separated by commas. If neither location nor properties-ref is
29-
specified, placeholders will be resolved against system properties.
28+
Multiple locations may be specified, separated by commas. If neither location nor
29+
properties-ref is specified, placeholders will be resolved against system properties.
3030
]]></xsd:documentation>
3131
</xsd:annotation>
3232
</xsd:attribute>
3333
<xsd:attribute name="properties-ref" type="xsd:string">
3434
<xsd:annotation>
3535
<xsd:documentation source="java:java.util.Properties"><![CDATA[
36-
The bean name of a Java Properties object that will be used for property substitution.
37-
If neither location nor properties-ref is specified, placeholders will be resolved against system properties.
36+
The bean name of a Properties object that will be used for property substitution.
37+
If neither location nor properties-ref is specified, placeholders will be resolved
38+
against system properties.
3839
]]></xsd:documentation>
3940
</xsd:annotation>
4041
</xsd:attribute>
4142
<xsd:attribute name="file-encoding" type="xsd:string">
4243
<xsd:annotation>
4344
<xsd:documentation><![CDATA[
44-
Specifies the encoding to use for parsing properties files. Default is none,
45-
using the java.util.Properties default encoding. Only applies to classic
45+
Specifies the encoding to use for parsing properties files. Default is none,
46+
using the java.util.Properties default encoding. Only applies to classic
4647
properties files, not to XML files.
4748
]]></xsd:documentation>
4849
</xsd:annotation>
4950
</xsd:attribute>
5051
<xsd:attribute name="order" type="xsd:integer">
5152
<xsd:annotation>
5253
<xsd:documentation><![CDATA[
53-
Specifies the order for this placeholder configurer. If more than one is present in a context
54-
the order can be important since the first one to be match a placeholder will win. Often used
55-
in conjunction with
54+
Specifies the order for this placeholder configurer. If more than one is present
55+
in a context, the order can be important since the first one to be match a
56+
placeholder will win.
5657
]]></xsd:documentation>
5758
</xsd:annotation>
5859
</xsd:attribute>
59-
<xsd:attribute name="ignore-resource-not-found" type="xsd:boolean"
60-
default="false">
60+
<xsd:attribute name="ignore-resource-not-found" type="xsd:boolean" default="false">
6161
<xsd:annotation>
6262
<xsd:documentation><![CDATA[
63-
Specifies if failure to find the property resource location should be ignored. Default
64-
is "false", meaning that if there is no file in the location specified an exception will
65-
be raised at runtime.
63+
Specifies if failure to find the property resource location should be ignored.
64+
Default is "false", meaning that if there is no file in the location specified
65+
an exception will be raised at runtime.
6666
]]></xsd:documentation>
6767
</xsd:annotation>
6868
</xsd:attribute>
69-
<xsd:attribute name="ignore-unresolvable" type="xsd:boolean"
70-
default="false">
69+
<xsd:attribute name="ignore-unresolvable" type="xsd:boolean" default="false">
7170
<xsd:annotation>
7271
<xsd:documentation><![CDATA[
73-
Specifies if failure to find the property value to replace a key should be ignored. Default
74-
is "false", meaning that this placeholder configurer will raise an exception if it cannot resolve
75-
a key. Set to "true" to allow the configurer to pass on the key to any others in
76-
the context that have not yet visited the key in question.
72+
Specifies if failure to find the property value to replace a key should be ignored.
73+
Default is "false", meaning that this placeholder configurer will raise an exception
74+
if it cannot resolve a key. Set to "true" to allow the configurer to pass on the key
75+
to any others in the context that have not yet visited the key in question.
7776
]]></xsd:documentation>
7877
</xsd:annotation>
7978
</xsd:attribute>
80-
<xsd:attribute name="local-override" type="xsd:boolean"
81-
default="false">
79+
<xsd:attribute name="local-override" type="xsd:boolean" default="false">
8280
<xsd:annotation>
8381
<xsd:documentation><![CDATA[
84-
Specifies whether local properties override properties from files. Default
85-
is "false": Properties from files override local defaults.
82+
Specifies whether local properties override properties from files.
83+
Default is "false": Properties from files override local defaults.
8684
]]></xsd:documentation>
8785
</xsd:annotation>
8886
</xsd:attribute>
@@ -104,12 +102,11 @@
104102
traditional PropertyPlaceholderConfigurer component will be registered instead of the
105103
new PropertySourcesPlaceholderConfigurer.
106104
107-
See ConfigurableEnvironment Javadoc for more information on using.
105+
See ConfigurableEnvironment javadoc for more information on using.
108106
]]></xsd:documentation>
109107
<xsd:appinfo>
110108
<tool:annotation>
111-
<tool:exports
112-
type="org.springframework.context.support.PropertySourcesPlaceholderConfigurer"/>
109+
<tool:exports type="org.springframework.context.support.PropertySourcesPlaceholderConfigurer"/>
113110
</tool:annotation>
114111
</xsd:appinfo>
115112
</xsd:annotation>
@@ -130,7 +127,7 @@
130127
newer PropertySourcesPlaceholderConfigurer variant. In this case, the Spring Environment
131128
and its property sources are not interrogated when resolving placeholders. Users are
132129
encouraged to consider this attribute deprecated, and to take advantage of
133-
Environment/PropertySource mechanisms. See ConfigurableEnvironment Javadoc for examples.
130+
Environment/PropertySource mechanisms. See ConfigurableEnvironment javadoc for examples.
134131
135132
"ENVIRONMENT" indicates placeholders should be resolved against the current Environment and against any local properties;
136133
"NEVER" indicates placeholders should be resolved only against local properties and never against system properties;
@@ -184,7 +181,7 @@
184181
@TransactionAttribute annotation. Consider the use of the <tx:annotation-driven>
185182
tag for that purpose.
186183
187-
See Javadoc for org.springframework.context.annotation.AnnotationConfigApplicationContext
184+
See javadoc for org.springframework.context.annotation.AnnotationConfigApplicationContext
188185
for information on code-based alternatives to bootstrapping annotation-driven support.
189186
from XML.
190187
]]></xsd:documentation>
@@ -211,7 +208,7 @@
211208
definitions just like to regular bean definitions, but it won't apply to the component
212209
scan settings themselves.
213210
214-
See Javadoc for org.springframework.context.annotation.ComponentScan for information
211+
See javadoc for org.springframework.context.annotation.ComponentScan for information
215212
on code-based alternatives to bootstrapping component-scanning.
216213
]]></xsd:documentation>
217214
</xsd:annotation>
@@ -336,7 +333,7 @@
336333
This will only happen if the AnnotationBeanConfigurerAspect is on the classpath
337334
(i.e. spring-aspects.jar), effectively activating "spring-configured" by default.
338335
339-
See Javadoc for org.springframework.context.annotation.EnableLoadTimeWeaving
336+
See javadoc for org.springframework.context.annotation.EnableLoadTimeWeaving
340337
for information on code-based alternatives to bootstrapping load-time weaving support.
341338
]]></xsd:documentation>
342339
<xsd:appinfo>

spring-context/src/main/resources/org/springframework/context/config/spring-context-4.0.xsd

Lines changed: 28 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -25,64 +25,62 @@
2525
<xsd:documentation><![CDATA[
2626
The location of the properties file to resolve placeholders against, as a Spring
2727
resource location: a URL, a "classpath:" pseudo URL, or a relative file path.
28-
Multiple locations may be specified, separated by commas. If neither location nor properties-ref is
29-
specified, placeholders will be resolved against system properties.
28+
Multiple locations may be specified, separated by commas. If neither location nor
29+
properties-ref is specified, placeholders will be resolved against system properties.
3030
]]></xsd:documentation>
3131
</xsd:annotation>
3232
</xsd:attribute>
3333
<xsd:attribute name="properties-ref" type="xsd:string">
3434
<xsd:annotation>
3535
<xsd:documentation source="java:java.util.Properties"><![CDATA[
36-
The bean name of a Java Properties object that will be used for property substitution.
37-
If neither location nor properties-ref is specified, placeholders will be resolved against system properties.
36+
The bean name of a Properties object that will be used for property substitution.
37+
If neither location nor properties-ref is specified, placeholders will be resolved
38+
against system properties.
3839
]]></xsd:documentation>
3940
</xsd:annotation>
4041
</xsd:attribute>
4142
<xsd:attribute name="file-encoding" type="xsd:string">
4243
<xsd:annotation>
4344
<xsd:documentation><![CDATA[
44-
Specifies the encoding to use for parsing properties files. Default is none,
45-
using the java.util.Properties default encoding. Only applies to classic
45+
Specifies the encoding to use for parsing properties files. Default is none,
46+
using the java.util.Properties default encoding. Only applies to classic
4647
properties files, not to XML files.
4748
]]></xsd:documentation>
4849
</xsd:annotation>
4950
</xsd:attribute>
5051
<xsd:attribute name="order" type="xsd:token">
5152
<xsd:annotation>
5253
<xsd:documentation><![CDATA[
53-
Specifies the order for this placeholder configurer. If more than one is present in a context
54-
the order can be important since the first one to be match a placeholder will win. Often used
55-
in conjunction with
54+
Specifies the order for this placeholder configurer. If more than one is present
55+
in a context, the order can be important since the first one to be match a
56+
placeholder will win.
5657
]]></xsd:documentation>
5758
</xsd:annotation>
5859
</xsd:attribute>
59-
<xsd:attribute name="ignore-resource-not-found" type="xsd:boolean"
60-
default="false">
60+
<xsd:attribute name="ignore-resource-not-found" type="xsd:boolean" default="false">
6161
<xsd:annotation>
6262
<xsd:documentation><![CDATA[
63-
Specifies if failure to find the property resource location should be ignored. Default
64-
is "false", meaning that if there is no file in the location specified an exception will
65-
be raised at runtime.
63+
Specifies if failure to find the property resource location should be ignored.
64+
Default is "false", meaning that if there is no file in the location specified
65+
an exception will be raised at runtime.
6666
]]></xsd:documentation>
6767
</xsd:annotation>
6868
</xsd:attribute>
69-
<xsd:attribute name="ignore-unresolvable" type="xsd:boolean"
70-
default="false">
69+
<xsd:attribute name="ignore-unresolvable" type="xsd:boolean" default="false">
7170
<xsd:annotation>
7271
<xsd:documentation><![CDATA[
73-
Specifies if failure to find the property value to replace a key should be ignored. Default
74-
is "false", meaning that this placeholder configurer will raise an exception if it cannot resolve
75-
a key. Set to "true" to allow the configurer to pass on the key to any others in
76-
the context that have not yet visited the key in question.
72+
Specifies if failure to find the property value to replace a key should be ignored.
73+
Default is "false", meaning that this placeholder configurer will raise an exception
74+
if it cannot resolve a key. Set to "true" to allow the configurer to pass on the key
75+
to any others in the context that have not yet visited the key in question.
7776
]]></xsd:documentation>
7877
</xsd:annotation>
7978
</xsd:attribute>
80-
<xsd:attribute name="local-override" type="xsd:boolean"
81-
default="false">
79+
<xsd:attribute name="local-override" type="xsd:boolean" default="false">
8280
<xsd:annotation>
8381
<xsd:documentation><![CDATA[
84-
Specifies whether local properties override properties from files. Default
85-
is "false": Properties from files override local defaults.
82+
Specifies whether local properties override properties from files.
83+
Default is "false": Properties from files override local defaults.
8684
]]></xsd:documentation>
8785
</xsd:annotation>
8886
</xsd:attribute>
@@ -104,12 +102,11 @@
104102
traditional PropertyPlaceholderConfigurer component will be registered instead of the
105103
new PropertySourcesPlaceholderConfigurer.
106104
107-
See ConfigurableEnvironment Javadoc for more information on using.
105+
See ConfigurableEnvironment javadoc for more information on using.
108106
]]></xsd:documentation>
109107
<xsd:appinfo>
110108
<tool:annotation>
111-
<tool:exports
112-
type="org.springframework.context.support.PropertySourcesPlaceholderConfigurer"/>
109+
<tool:exports type="org.springframework.context.support.PropertySourcesPlaceholderConfigurer"/>
113110
</tool:annotation>
114111
</xsd:appinfo>
115112
</xsd:annotation>
@@ -130,7 +127,7 @@
130127
newer PropertySourcesPlaceholderConfigurer variant. In this case, the Spring Environment
131128
and its property sources are not interrogated when resolving placeholders. Users are
132129
encouraged to consider this attribute deprecated, and to take advantage of
133-
Environment/PropertySource mechanisms. See ConfigurableEnvironment Javadoc for examples.
130+
Environment/PropertySource mechanisms. See ConfigurableEnvironment javadoc for examples.
134131
135132
"ENVIRONMENT" indicates placeholders should be resolved against the current Environment and against any local properties;
136133
"NEVER" indicates placeholders should be resolved only against local properties and never against system properties;
@@ -184,7 +181,7 @@
184181
@TransactionAttribute annotation. Consider the use of the <tx:annotation-driven>
185182
tag for that purpose.
186183
187-
See Javadoc for org.springframework.context.annotation.AnnotationConfigApplicationContext
184+
See javadoc for org.springframework.context.annotation.AnnotationConfigApplicationContext
188185
for information on code-based alternatives to bootstrapping annotation-driven support.
189186
from XML.
190187
]]></xsd:documentation>
@@ -211,7 +208,7 @@
211208
definitions just like to regular bean definitions, but it won't apply to the component
212209
scan settings themselves.
213210
214-
See Javadoc for org.springframework.context.annotation.ComponentScan for information
211+
See javadoc for org.springframework.context.annotation.ComponentScan for information
215212
on code-based alternatives to bootstrapping component-scanning.
216213
]]></xsd:documentation>
217214
</xsd:annotation>
@@ -334,7 +331,7 @@
334331
This will only happen if the AnnotationBeanConfigurerAspect is on the classpath
335332
(i.e. spring-aspects.jar), effectively activating "spring-configured" by default.
336333
337-
See Javadoc for org.springframework.context.annotation.EnableLoadTimeWeaving
334+
See javadoc for org.springframework.context.annotation.EnableLoadTimeWeaving
338335
for information on code-based alternatives to bootstrapping load-time weaving support.
339336
]]></xsd:documentation>
340337
<xsd:appinfo>

0 commit comments

Comments
 (0)