Skip to content

Commit 020c6c0

Browse files
committed
Polish: remove Javadoc tags from spring-websocket.xsd
1 parent 29158aa commit 020c6c0

File tree

1 file changed

+14
-17
lines changed

1 file changed

+14
-17
lines changed

spring-websocket/src/main/resources/org/springframework/web/socket/config/spring-websocket.xsd

Lines changed: 14 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -526,14 +526,14 @@
526526
<xsd:attribute name="allowed-origins" type="xsd:string">
527527
<xsd:annotation>
528528
<xsd:documentation><![CDATA[
529-
Configure allowed {@code Origin} header values. Multiple origins may be specified
529+
Configure allowed Origin header values. Multiple origins may be specified
530530
as a comma-separated list.
531531
532532
This check is mostly designed for browser clients. There is noting preventing other
533533
types of client to modify the Origin header value.
534534
535535
When SockJS is enabled and allowed origins are restricted, transport types that do not
536-
use {@code Origin} headers for cross origin requests (jsonp-polling, iframe-xhr-polling,
536+
use Origin headers for cross origin requests (jsonp-polling, iframe-xhr-polling,
537537
iframe-eventsource and iframe-htmlfile) are disabled. As a consequence, IE6/IE7 won't be
538538
supported anymore and IE8/IE9 will only be supported without cookies.
539539
@@ -628,10 +628,10 @@
628628
629629
In general WebSocket servers expect that messages to a single WebSocket
630630
session are sent from a single thread at a time. This is automatically
631-
guaranteed when using {@code @EnableWebSocketMessageBroker} configuration.
631+
guaranteed when using @EnableWebSocketMessageBroker configuration.
632632
If message sending is slow, or at least slower than rate of messages sending,
633-
subsequent messages are buffered until either the {@code sendTimeLimit}
634-
or the {@code sendBufferSizeLimit} are reached at which point the session
633+
subsequent messages are buffered until either the sendTimeLimit
634+
or the sendBufferSizeLimit are reached at which point the session
635635
state is cleared and an attempt is made to close the session.
636636
637637
NOTE that the session time limit is checked only
@@ -648,7 +648,7 @@
648648
the server is using non-blocking IO such as Tomcat's NIO connector that
649649
is used by default on Tomcat 8. If you must use blocking IO consider
650650
customizing OS-level TCP settings, for example
651-
{@code /proc/sys/net/ipv4/tcp_retries2} on Linux.
651+
/proc/sys/net/ipv4/tcp_retries2 on Linux.
652652
653653
The default value is 10 seconds (i.e. 10 * 10000).
654654
]]></xsd:documentation>
@@ -663,10 +663,10 @@
663663
664664
In general WebSocket servers expect that messages to a single WebSocket
665665
session are sent from a single thread at a time. This is automatically
666-
guaranteed when using {@code @EnableWebSocketMessageBroker} configuration.
666+
guaranteed when using @EnableWebSocketMessageBroker configuration.
667667
If message sending is slow, or at least slower than rate of messages sending,
668-
subsequent messages are buffered until either the {@code sendTimeLimit}
669-
or the {@code sendBufferSizeLimit} are reached at which point the session
668+
subsequent messages are buffered until either the sendTimeLimit
669+
or the sendBufferSizeLimit are reached at which point the session
670670
state is cleared and an attempt is made to close the session.
671671
672672
NOTE that closing the session may not succeed in
@@ -675,14 +675,11 @@
675675
configured by default on Tomcat 7. Therefore it is recommended to ensure
676676
the server is using non-blocking IO such as Tomcat's NIO connector used
677677
by default on Tomcat 8. If you must use blocking IO consider customizing
678-
OS-level TCP settings, for example {@code /proc/sys/net/ipv4/tcp_retries2}
678+
OS-level TCP settings, for example /proc/sys/net/ipv4/tcp_retries2
679679
on Linux.
680680
681-
The default value is 512K (i.e. 512 * 1024).
682-
683-
@param sendBufferSizeLimit the maximum number of bytes to buffer when
684-
sending messages; if the value is less than or equal to 0 then buffering
685-
is effectively disabled.
681+
The default value is 512K (i.e. 512 * 1024). If the value is set to less
682+
than or equal to 0 then buffering is effectively disabled.
686683
]]></xsd:documentation>
687684
</xsd:annotation>
688685
</xsd:attribute>
@@ -727,14 +724,14 @@
727724
<xsd:attribute name="allowed-origins" type="xsd:string">
728725
<xsd:annotation>
729726
<xsd:documentation><![CDATA[
730-
Configure allowed {@code Origin} header values. Multiple origins may be specified
727+
Configure allowed Origin header values. Multiple origins may be specified
731728
as a comma-separated list.
732729
733730
This check is mostly designed for browser clients. There is noting preventing other
734731
types of client to modify the Origin header value.
735732
736733
When SockJS is enabled and allowed origins are restricted, transport types that do not
737-
use {@code Origin} headers for cross origin requests (jsonp-polling, iframe-xhr-polling,
734+
use Origin headers for cross origin requests (jsonp-polling, iframe-xhr-polling,
738735
iframe-eventsource and iframe-htmlfile) are disabled. As a consequence, IE6/IE7 won't be
739736
supported anymore and IE8/IE9 will only be supported without cookies.
740737

0 commit comments

Comments
 (0)