From 518e981b4b3ed07fbc238219c98c7d0cccd4f9c7 Mon Sep 17 00:00:00 2001
From: James Strachan <jstrachan@apache.org>
Date: Mon, 31 Jul 2006 09:19:51 +0000
Subject: [PATCH] Added better NDoc documentation

git-svn-id: https://svn.apache.org/repos/asf/incubator/activemq/trunk@427051 13f79535-47bb-0310-9956-ffa450edef68
---
 activemq-dotnet/src/main/csharp/NMS/IConnection.cs     | 3 +++
 activemq-dotnet/src/main/csharp/NMS/IDestination.cs    | 5 ++++-
 activemq-dotnet/src/main/csharp/NMS/IQueue.cs          | 3 ++-
 activemq-dotnet/src/main/csharp/NMS/IStartable.cs      | 2 +-
 activemq-dotnet/src/main/csharp/NMS/IStoppable.cs      | 2 +-
 activemq-dotnet/src/main/csharp/NMS/ITemporaryQueue.cs | 3 ++-
 activemq-dotnet/src/main/csharp/NMS/ITemporaryTopic.cs | 3 ++-
 activemq-dotnet/src/main/csharp/NMS/ITopic.cs          | 3 ++-
 8 files changed, 17 insertions(+), 7 deletions(-)

diff --git a/activemq-dotnet/src/main/csharp/NMS/IConnection.cs b/activemq-dotnet/src/main/csharp/NMS/IConnection.cs
index fb2f8378ac..a9963ee234 100644
--- a/activemq-dotnet/src/main/csharp/NMS/IConnection.cs
+++ b/activemq-dotnet/src/main/csharp/NMS/IConnection.cs
@@ -16,6 +16,9 @@
  */
 namespace NMS
 {
+	/// <summary>
+	/// The mode used to acknowledge messages after they are consumed
+	/// </summary>
 	public enum AcknowledgementMode
     {
 		/**
diff --git a/activemq-dotnet/src/main/csharp/NMS/IDestination.cs b/activemq-dotnet/src/main/csharp/NMS/IDestination.cs
index c21249d8b2..9e4281c53d 100644
--- a/activemq-dotnet/src/main/csharp/NMS/IDestination.cs
+++ b/activemq-dotnet/src/main/csharp/NMS/IDestination.cs
@@ -16,6 +16,9 @@
  */
 namespace NMS
 {
+	/// <summary>
+	/// Represents the type of the destination such as a queue or topic.
+	/// </summary>
 	public enum DestinationType
 	{
 		Queue,
@@ -26,7 +29,7 @@ namespace NMS
 	
 	
 	/// <summary>
-	/// Summary description for Destination.
+	/// A base interface for destinations such as queues or topics
 	/// </summary>
 	public interface IDestination
 	{
diff --git a/activemq-dotnet/src/main/csharp/NMS/IQueue.cs b/activemq-dotnet/src/main/csharp/NMS/IQueue.cs
index cc33597f0b..3c614e5dfd 100644
--- a/activemq-dotnet/src/main/csharp/NMS/IQueue.cs
+++ b/activemq-dotnet/src/main/csharp/NMS/IQueue.cs
@@ -17,7 +17,8 @@
 namespace NMS
 {
 	/// <summary>
-	/// Summary description for IQueue.
+	/// Represents a queue in a message broker. A message sent to a queue is delivered
+        /// to at most one consumer on the queue.
 	/// </summary>
 	public interface IQueue : IDestination
 	{
diff --git a/activemq-dotnet/src/main/csharp/NMS/IStartable.cs b/activemq-dotnet/src/main/csharp/NMS/IStartable.cs
index 005f5f82c3..36afc106b9 100644
--- a/activemq-dotnet/src/main/csharp/NMS/IStartable.cs
+++ b/activemq-dotnet/src/main/csharp/NMS/IStartable.cs
@@ -17,7 +17,7 @@
 namespace NMS
 {
 	/// <summary>
-	/// Implemented by NMS objects that can be started.
+	/// A lifecycle for NMS objects to indicate they can be started
 	/// </summary>
 	public interface IStartable
     {
diff --git a/activemq-dotnet/src/main/csharp/NMS/IStoppable.cs b/activemq-dotnet/src/main/csharp/NMS/IStoppable.cs
index 0aa66a1329..c7e60e2709 100644
--- a/activemq-dotnet/src/main/csharp/NMS/IStoppable.cs
+++ b/activemq-dotnet/src/main/csharp/NMS/IStoppable.cs
@@ -17,7 +17,7 @@
 namespace NMS
 {
 	/// <summary>
-	/// Implemented by NMS objects that can be started.
+	/// A lifecycle for NMS objects to indicate they can be stopped
 	/// </summary>
 	public interface IStoppable
 	{
diff --git a/activemq-dotnet/src/main/csharp/NMS/ITemporaryQueue.cs b/activemq-dotnet/src/main/csharp/NMS/ITemporaryQueue.cs
index ab3c799128..5dcc276f91 100644
--- a/activemq-dotnet/src/main/csharp/NMS/ITemporaryQueue.cs
+++ b/activemq-dotnet/src/main/csharp/NMS/ITemporaryQueue.cs
@@ -17,7 +17,8 @@
 namespace NMS
 {
 	/// <summary>
-	/// Summary description for ITemporaryQueue.
+	/// Represents a temporary queue which exists for the duration 
+        /// of the IConnection which created it.
 	/// </summary>
 	public interface ITemporaryQueue : IDestination
 	{
diff --git a/activemq-dotnet/src/main/csharp/NMS/ITemporaryTopic.cs b/activemq-dotnet/src/main/csharp/NMS/ITemporaryTopic.cs
index 438521f183..7194c598c6 100644
--- a/activemq-dotnet/src/main/csharp/NMS/ITemporaryTopic.cs
+++ b/activemq-dotnet/src/main/csharp/NMS/ITemporaryTopic.cs
@@ -17,7 +17,8 @@
 namespace NMS
 {
 	/// <summary>
-	/// Summary description for TemporaryTopic.
+	/// Represents a temporary topic which exists for the duration 
+        /// of the IConnection which created it.
 	/// </summary>
 	public interface ITemporaryTopic : IDestination
 	{
diff --git a/activemq-dotnet/src/main/csharp/NMS/ITopic.cs b/activemq-dotnet/src/main/csharp/NMS/ITopic.cs
index 255ec81668..2608168b22 100644
--- a/activemq-dotnet/src/main/csharp/NMS/ITopic.cs
+++ b/activemq-dotnet/src/main/csharp/NMS/ITopic.cs
@@ -17,7 +17,8 @@
 namespace NMS
 {
 	/// <summary>
-	/// Summary description for ITopic.
+	/// Represents a topic in a message broker. A message sent to a topic
+        /// is delivered to all consumers on the topic who are interested in the message.
 	/// </summary>
 	public interface ITopic : IDestination
 	{