INT-2150:fixed xsd doc errors

2011-09-29 10:58:37 -04:00
parent 2a3df6f08f
commit cfccea104f
1 changed files with 32 additions and 31 deletions
--- a/spring-integration-twitter/src/main/resources/org/springframework/integration/twitter/config/spring-integration-twitter-2.0.xsd
+++ b/spring-integration-twitter/src/main/resources/org/springframework/integration/twitter/config/spring-integration-twitter-2.0.xsd
@@ -15,12 +15,13 @@

 	<!--
 		INBOUND
-		-->
+	-->
+
 	<xsd:element name="inbound-channel-adapter">
 		<xsd:annotation>
 			<xsd:documentation>
-				Configures an inbound channel adapter that consumes message (representing your friends' timeline updates)
-				from twitter and sends Messages whose payloads are Tweet objects.
+				Configures an inbound channel adapter that consumes your friends' timeline updates
+				from Twitter and sends Messages whose payloads are Tweet objects.
 			</xsd:documentation>
 		</xsd:annotation>	
 		<xsd:complexType >
@@ -33,8 +34,8 @@
 	<xsd:element name="mentions-inbound-channel-adapter">
 		<xsd:annotation>
 			<xsd:documentation>
-				Configures an inbound channel adapter that consumes message (representing mentions of your handle)
-				from twitter and sends Messages whose payloads are Status objects.
+				Configures an inbound channel adapter that consumes mentions of your handle
+				from Twitter and sends Messages whose payloads are Tweet objects.
 			</xsd:documentation>
 		</xsd:annotation>
 		<xsd:complexType>
@@ -48,8 +49,8 @@
 	<xsd:element name="search-inbound-channel-adapter">
 		<xsd:annotation>
 			<xsd:documentation>
-				Configures an inbound channel adapter that consumes message (representing mentions of your handle)
-				from twitter and sends Messages whose payloads are Status objects.
+				Configures an inbound channel adapter that consumes search results for a given query
+				from Twitter and sends Messages whose payloads are Tweet objects.
 			</xsd:documentation>
 		</xsd:annotation>
 		<xsd:complexType>
@@ -58,7 +59,7 @@
 					<xsd:attribute name="query" type="xsd:string" use="required">
 						<xsd:annotation>
 							<xsd:documentation>
-							Twitter search query (e.g, #springintegration . 
+							Twitter search query (e.g, #springintegration).
 							For more info on Twitter queries please refer to this site: http://search.twitter.com/operators)
 							</xsd:documentation>
 						</xsd:annotation>
@@ -71,7 +72,8 @@
 	<xsd:element name="dm-inbound-channel-adapter">
 		<xsd:annotation>
 			<xsd:documentation>
-				Configures an inbound channel adapter that consumes direct messages and forwards them to Spring Integration
+				Configures an inbound channel adapter that consumes direct messages from Twitter
+				and sends Messages whose payloads are Tweet objects.
 			</xsd:documentation>
 		</xsd:annotation>
 		<xsd:complexType>
@@ -82,14 +84,14 @@
 	</xsd:element>

 	<!--
-			OUTBOUND
-		-->
+		OUTBOUND
+	-->

 	<xsd:element name="dm-outbound-channel-adapter">
 		<xsd:annotation>
 			<xsd:documentation>
-				Configures an inbound channel adapter that consumes message (representing your friends' timeline updates)
-				from twitter and sends Messages whose payloads are Tweet objects.
+				Configures an outbound channel adapter that sends Direct Messages to a Twitter user as
+				specified in the header whose name is defined by the TwitterHeaders.DM_TARGET_USER_ID constant.
 			</xsd:documentation>
 		</xsd:annotation>
 		<xsd:complexType>
@@ -103,8 +105,7 @@
 	<xsd:element name="outbound-channel-adapter">
 		<xsd:annotation>
 			<xsd:documentation>
-				Configures an inbound channel adapter that consumes message (representing your friends' timeline updates)
-				from twitter and sends Messages whose payloads are Tweet objects.
+				Configures an outbound channel adapter that posts a status update to the authorized user's timeline.
 			</xsd:documentation>
 		</xsd:annotation>
 		<xsd:complexType>
@@ -114,6 +115,10 @@
 		</xsd:complexType>
 	</xsd:element>

+	<!--
+		BASE TYPES
+	-->
+
 	<xsd:complexType name="inbound-twitter-type">
 		<xsd:sequence>
 				<xsd:element ref="integration:poller" minOccurs="0" maxOccurs="1" />
@@ -127,17 +132,17 @@
 					</tool:annotation>
 				</xsd:appinfo>
 				<xsd:documentation>
-				Reference to a [org.springframework.integration.twitter.core.TwitterOperations] bean. Spring 
-				Integration provides [Twitter4jTemplate] template for your convenience.
-				NOTE: in future releases TwitterOperations usage will be migrated to using Spring Social's TwitterOperations
+					Reference to a [org.springframework.integration.twitter.core.TwitterOperations] bean. Spring 
+					Integration provides [Twitter4jTemplate] template for your convenience.
+					NOTE: in future releases TwitterOperations usage will be migrated to using Spring Social's TwitterOperations
 				</xsd:documentation>
 			</xsd:annotation>
 		</xsd:attribute>
 		<xsd:attribute name="auto-startup" type="xsd:string" default="true">
 			<xsd:annotation>
 					<xsd:documentation>
-					Lifecycle attribute signaling if this component should be started during Application Context startup.
-					Default is 'true'
+					Lifecycle attribute signaling whether this component should be started during Application Context startup.
+					Default is 'true'.
 					</xsd:documentation>
 				</xsd:annotation>
 		</xsd:attribute>
@@ -149,10 +154,8 @@
 					</tool:annotation>
 				</xsd:appinfo>
 				<xsd:documentation>
-	            	Identifies channel attached to this adapter. Depending on the type of the adapter 
-					this channel could be the receiving channel (e.g., outbound-channel-adapter) or channel where 
-					messages will be sent to by this adapter (e.g., inbound-channel-adapter).
-	            	</xsd:documentation>
+	            	Message Channel to which messages will be sent by this adapter.
+	            </xsd:documentation>
 			</xsd:annotation>
 		</xsd:attribute>
 	</xsd:complexType>
@@ -167,10 +170,10 @@
 						</tool:annotation>
 					</xsd:appinfo>
 					<xsd:documentation>
-				Reference to a [org.springframework.integration.twitter.core.TwitterOperations] bean. Spring 
-				Integration provides [Twitter4jTemplate] template for your convenience.
-				NOTE: in future releases TwitterOperations usage will be migrated to using Spring Social's TwitterOperations
-				</xsd:documentation>
+						Reference to a [org.springframework.integration.twitter.core.TwitterOperations] bean. Spring 
+						Integration provides [Twitter4jTemplate] template for your convenience.
+						NOTE: in future releases TwitterOperations usage will be migrated to using Spring Social's TwitterOperations
+					</xsd:documentation>
 				</xsd:annotation>
 			</xsd:attribute>
 			<xsd:attribute name="channel" type="xsd:string">
@@ -181,9 +184,7 @@
 						</tool:annotation>
 					</xsd:appinfo>
 					<xsd:documentation>
-	            	Identifies channel attached to this adapter. Depending on the type of the adapter 
-					this channel could be the receiving channel (e.g., outbound-channel-adapter) or channel where 
-					messages will be sent to by this adapter (e.g., inbound-channel-adapter).
+	            		Message Channel where this adapter receives messages to be handled by performing Twitter operations.
 	            	</xsd:documentation>
 				</xsd:annotation>
 			</xsd:attribute>