Author: jstrachan
Date: Mon Jul 31 02:19:51 2006
New Revision: 427051
URL: http://svn.apache.org/viewvc?rev=427051&view=rev
Log:
Added better NDoc documentation
Modified:
incubator/activemq/trunk/activemq-dotnet/src/main/csharp/NMS/IConnection.cs
incubator/activemq/trunk/activemq-dotnet/src/main/csharp/NMS/IDestination.cs
incubator/activemq/trunk/activemq-dotnet/src/main/csharp/NMS/IQueue.cs
incubator/activemq/trunk/activemq-dotnet/src/main/csharp/NMS/IStartable.cs
incubator/activemq/trunk/activemq-dotnet/src/main/csharp/NMS/IStoppable.cs
incubator/activemq/trunk/activemq-dotnet/src/main/csharp/NMS/ITemporaryQueue.cs
incubator/activemq/trunk/activemq-dotnet/src/main/csharp/NMS/ITemporaryTopic.cs
incubator/activemq/trunk/activemq-dotnet/src/main/csharp/NMS/ITopic.cs
Modified:
incubator/activemq/trunk/activemq-dotnet/src/main/csharp/NMS/IConnection.cs
URL:
http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-dotnet/src/main/csharp/NMS/IConnection.cs?rev=427051&r1=427050&r2=427051&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-dotnet/src/main/csharp/NMS/IConnection.cs
(original)
+++ incubator/activemq/trunk/activemq-dotnet/src/main/csharp/NMS/IConnection.cs
Mon Jul 31 02:19:51 2006
@@ -16,6 +16,9 @@
*/
namespace NMS
{
+ /// <summary>
+ /// The mode used to acknowledge messages after they are consumed
+ /// </summary>
public enum AcknowledgementMode
{
/**
Modified:
incubator/activemq/trunk/activemq-dotnet/src/main/csharp/NMS/IDestination.cs
URL:
http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-dotnet/src/main/csharp/NMS/IDestination.cs?rev=427051&r1=427050&r2=427051&view=diff
==============================================================================
---
incubator/activemq/trunk/activemq-dotnet/src/main/csharp/NMS/IDestination.cs
(original)
+++
incubator/activemq/trunk/activemq-dotnet/src/main/csharp/NMS/IDestination.cs
Mon Jul 31 02:19:51 2006
@@ -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 @@
/// <summary>
- /// Summary description for Destination.
+ /// A base interface for destinations such as queues or topics
/// </summary>
public interface IDestination
{
Modified: incubator/activemq/trunk/activemq-dotnet/src/main/csharp/NMS/IQueue.cs
URL:
http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-dotnet/src/main/csharp/NMS/IQueue.cs?rev=427051&r1=427050&r2=427051&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-dotnet/src/main/csharp/NMS/IQueue.cs
(original)
+++ incubator/activemq/trunk/activemq-dotnet/src/main/csharp/NMS/IQueue.cs Mon
Jul 31 02:19:51 2006
@@ -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
{
Modified:
incubator/activemq/trunk/activemq-dotnet/src/main/csharp/NMS/IStartable.cs
URL:
http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-dotnet/src/main/csharp/NMS/IStartable.cs?rev=427051&r1=427050&r2=427051&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-dotnet/src/main/csharp/NMS/IStartable.cs
(original)
+++ incubator/activemq/trunk/activemq-dotnet/src/main/csharp/NMS/IStartable.cs
Mon Jul 31 02:19:51 2006
@@ -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
{
Modified:
incubator/activemq/trunk/activemq-dotnet/src/main/csharp/NMS/IStoppable.cs
URL:
http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-dotnet/src/main/csharp/NMS/IStoppable.cs?rev=427051&r1=427050&r2=427051&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-dotnet/src/main/csharp/NMS/IStoppable.cs
(original)
+++ incubator/activemq/trunk/activemq-dotnet/src/main/csharp/NMS/IStoppable.cs
Mon Jul 31 02:19:51 2006
@@ -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
{
Modified:
incubator/activemq/trunk/activemq-dotnet/src/main/csharp/NMS/ITemporaryQueue.cs
URL:
http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-dotnet/src/main/csharp/NMS/ITemporaryQueue.cs?rev=427051&r1=427050&r2=427051&view=diff
==============================================================================
---
incubator/activemq/trunk/activemq-dotnet/src/main/csharp/NMS/ITemporaryQueue.cs
(original)
+++
incubator/activemq/trunk/activemq-dotnet/src/main/csharp/NMS/ITemporaryQueue.cs
Mon Jul 31 02:19:51 2006
@@ -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
{
Modified:
incubator/activemq/trunk/activemq-dotnet/src/main/csharp/NMS/ITemporaryTopic.cs
URL:
http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-dotnet/src/main/csharp/NMS/ITemporaryTopic.cs?rev=427051&r1=427050&r2=427051&view=diff
==============================================================================
---
incubator/activemq/trunk/activemq-dotnet/src/main/csharp/NMS/ITemporaryTopic.cs
(original)
+++
incubator/activemq/trunk/activemq-dotnet/src/main/csharp/NMS/ITemporaryTopic.cs
Mon Jul 31 02:19:51 2006
@@ -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
{
Modified: incubator/activemq/trunk/activemq-dotnet/src/main/csharp/NMS/ITopic.cs
URL:
http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-dotnet/src/main/csharp/NMS/ITopic.cs?rev=427051&r1=427050&r2=427051&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-dotnet/src/main/csharp/NMS/ITopic.cs
(original)
+++ incubator/activemq/trunk/activemq-dotnet/src/main/csharp/NMS/ITopic.cs Mon
Jul 31 02:19:51 2006
@@ -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
{
