You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@activemq.apache.org by ta...@apache.org on 2009/05/19 15:54:07 UTC
svn commit: r776319 - in
/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/core:
ActiveMQConnection.h ActiveMQConnectionSupport.h ActiveMQConsumer.h
ActiveMQProducer.h ActiveMQSession.h
Author: tabish
Date: Tue May 19 13:54:06 2009
New Revision: 776319
URL: http://svn.apache.org/viewvc?rev=776319&view=rev
Log:
More Doxygen comment cleanup.
Modified:
activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/core/ActiveMQConnection.h
activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/core/ActiveMQConnectionSupport.h
activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/core/ActiveMQConsumer.h
activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/core/ActiveMQProducer.h
activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/core/ActiveMQSession.h
Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/core/ActiveMQConnection.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/core/ActiveMQConnection.h?rev=776319&r1=776318&r2=776319&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/core/ActiveMQConnection.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/core/ActiveMQConnection.h Tue May 19 13:54:06 2009
@@ -137,7 +137,7 @@
/**
* Constructor
*
- * @param transprot
+ * @param transport
* The Transport requested for this connection to the Broker.
* @param properties
* The Properties that were defined for this connection
@@ -342,7 +342,6 @@
/**
* Event handler for an exception from a command transport.
- * @param source The source of the exception
* @param ex The exception.
*/
virtual void onException( const decaf::lang::Exception& ex );
@@ -385,7 +384,7 @@
* @throws ConnectorException thrown if an error response was received
* from the broker, or if any other error occurred.
*/
- void syncRequest( Pointer<commands::Command>, unsigned int timeout = 0 )
+ void syncRequest( Pointer<commands::Command> command, unsigned int timeout = 0 )
throw ( activemq::exceptions::ActiveMQException );
/**
Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/core/ActiveMQConnectionSupport.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/core/ActiveMQConnectionSupport.h?rev=776319&r1=776318&r2=776319&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/core/ActiveMQConnectionSupport.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/core/ActiveMQConnectionSupport.h Tue May 19 13:54:06 2009
@@ -112,6 +112,9 @@
* most common properties for a connection are pulled from the
* properties instance or are set to defaults.
*
+ * @param transport
+ * The Transport that this Connection will use for sending Commands
+ * to the Broker.
* @param properties
* The URI configured properties for this connection.
*/
Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/core/ActiveMQConsumer.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/core/ActiveMQConsumer.h?rev=776319&r1=776318&r2=776319&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/core/ActiveMQConsumer.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/core/ActiveMQConsumer.h Tue May 19 13:54:06 2009
@@ -199,8 +199,8 @@
virtual void setMessageListener( cms::MessageListener* listener ) throw ( cms::CMSException );
/**
- * Gets the MessageListener that this class will send notifs on
- * @param MessageListener interface pointer
+ * Gets the MessageListener that this class will send events to.
+ * @return the currently registered MessageListener interface pointer.
*/
virtual cms::MessageListener* getMessageListener() const throw ( cms::CMSException ) {
return this->listener;
@@ -336,14 +336,14 @@
/**
* Pre-consume processing
- * @param message - the message being consumed.
+ * @param dispatch - the message being consumed.
*/
void beforeMessageIsConsumed(
const Pointer<commands::MessageDispatch>& dispatch );
/**
* Post-consume processing
- * @param message - the consumed message
+ * @param dispatch - the consumed message
* @param messageExpired - flag indicating if the message has expired.
*/
void afterMessageIsConsumed(
Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/core/ActiveMQProducer.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/core/ActiveMQProducer.h?rev=776319&r1=776318&r2=776319&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/core/ActiveMQProducer.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/core/ActiveMQProducer.h Tue May 19 13:54:06 2009
@@ -103,7 +103,7 @@
/**
* Sends the message to the default producer destination.
- * @param a Message Object Pointer
+ * @param message A Message Object Pointer for the Message to send.
* @throws CMSException
*/
virtual void send( cms::Message* message ) throw ( cms::CMSException );
@@ -111,8 +111,8 @@
/**
* Sends the message to the default producer destination, but does
* not take ownership of the message, caller must still destroy it.
- * @param message - a Message Object Pointer
- * @param deliverMode The delivery mode to be used.
+ * @param message A Message Object Pointer
+ * @param deliveryMode The delivery mode to be used.
* @param priority The priority for this message.
* @param timeToLive The time to live value for this message in
* milliseconds.
@@ -124,7 +124,8 @@
/**
* Sends the message to the designated destination.
- * @param a Message Object Pointer
+ * @param destination The CMS Destination that defines where the message is sent.
+ * @param message A Message Object Pointer
* @throws CMSException
*/
virtual void send( const cms::Destination* destination,
@@ -135,7 +136,7 @@
* not take ownership of the message, caller must still destroy it.
* @param destination - a Message Object Pointer
* @param message - a Message Object Pointer
- * @param deliverMode The delivery mode to be used.
+ * @param deliveryMode The delivery mode to be used.
* @param priority The priority for this message.
* @param timeToLive The time to live value for this message in
* milliseconds.
@@ -148,7 +149,7 @@
/**
* Sets the delivery mode for this Producer
- * @param The DeliveryMode
+ * @param mode - The DeliveryMode to use for Message sends.
*/
virtual void setDeliveryMode( int mode ) throw ( cms::CMSException ){
this->defaultDeliveryMode = mode;
@@ -164,15 +165,15 @@
/**
* Sets if Message Ids are disabled for this Producer
- * @param boolean indicating enable / disable (true / false)
+ * @param value - boolean indicating enable / disable (true / false)
*/
virtual void setDisableMessageID( bool value ) throw ( cms::CMSException ) {
this->disableMessageId = value;
}
/**
- * Sets if Message Ids are disabled for this Producer
- * @param boolean indicating enable / disable (true / false)
+ * Gets if Message Ids are disabled for this Producer
+ * @return a boolean indicating state enable / disable (true / false) for MessageIds.
*/
virtual bool getDisableMessageID() const throw ( cms::CMSException ) {
return this->disableMessageId;
@@ -180,15 +181,15 @@
/**
* Sets if Message Time Stamps are disabled for this Producer
- * @param boolean indicating enable / disable (true / false)
+ * @param value - boolean indicating enable / disable (true / false)
*/
virtual void setDisableMessageTimeStamp( bool value ) throw ( cms::CMSException ) {
this->disableTimestamps = value;
}
/**
- * Sets if Message Time Stamps are disabled for this Producer
- * @param boolean indicating enable / disable (true / false)
+ * Gets if Message Time Stamps are disabled for this Producer
+ * @returns boolean indicating state of enable / disable (true / false)
*/
virtual bool getDisableMessageTimeStamp() const throw ( cms::CMSException ) {
return this->disableTimestamps;
@@ -196,7 +197,7 @@
/**
* Sets the Priority that this Producers sends messages at
- * @param int value for Priority level
+ * @param priority int value for Priority level
*/
virtual void setPriority( int priority ) throw ( cms::CMSException ) {
this->defaultPriority = priority;
Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/core/ActiveMQSession.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/core/ActiveMQSession.h?rev=776319&r1=776318&r2=776319&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/core/ActiveMQSession.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/core/ActiveMQSession.h Tue May 19 13:54:06 2009
@@ -224,7 +224,7 @@
/**
* Creates a MessageConsumer for the specified destination.
- * @param the Destination that this consumer receiving messages for.
+ * @param destination - The Destination that this consumer receiving messages for.
* @throws CMSException
*/
virtual cms::MessageConsumer* createConsumer(
@@ -234,8 +234,8 @@
/**
* Creates a MessageConsumer for the specified destination, using a
* message selector.
- * @param the Destination that this consumer receiving messages for.
- * @param the Message Selector string to use for this destination
+ * @param destination - The Destination that this consumer receiving messages for.
+ * @param selector - The Message Selector string to use for this destination
* @throws CMSException
*/
virtual cms::MessageConsumer* createConsumer(
@@ -245,9 +245,9 @@
/**
* Creates a MessageConsumer for the specified destination, using a
* message selector.
- * @param the Destination that this consumer receiving messages for.
- * @param the Message Selector string to use for this destination
- * @param if true, and the destination is a topic, inhibits the
+ * @param destination - The Destination that this consumer receiving messages for.
+ * @param selector - The Message Selector string to use for this destination
+ * @param noLocal - if true, and the destination is a topic, inhibits the
* delivery of messages published by its own connection. The
* behavior for NoLocal is not specified if the destination is
* a queue.
@@ -262,9 +262,13 @@
/**
* Creates a durable subscriber to the specified topic, using a
* message selector
- * @param the topic to subscribe to
- * @param name used to identify the subscription
- * @param only messages matching the selector are received
+ * @param destination - the topic to subscribe to
+ * @param name - The name used to identify the subscription
+ * @param selector - only messages matching the selector are received
+ * @param noLocal - if true, and the destination is a topic, inhibits the
+ * delivery of messages published by its own connection. The
+ * behavior for NoLocal is not specified if the destination is
+ * a queue.
* @throws CMSException
*/
virtual cms::MessageConsumer* createDurableConsumer(
@@ -277,7 +281,7 @@
/**
* Creates a MessageProducer to send messages to the specified
* destination.
- * @param the Destination to publish on
+ * @param destination - the Destination to publish on
* @throws CMSException
*/
virtual cms::MessageProducer* createProducer(
@@ -314,7 +318,7 @@
/**
* Creates a queue identity given a Queue name.
- * @param the name of the new Queue
+ * @param queueName - the name of the new Queue
* @throws CMSException
*/
virtual cms::Queue* createQueue( const std::string& queueName )
@@ -322,7 +326,7 @@
/**
* Creates a topic identity given a Queue name.
- * @param the name of the new Topic
+ * @param topicName - the name of the new Topic
* @throws CMSException
*/
virtual cms::Topic* createTopic( const std::string& topicName )
@@ -351,15 +355,20 @@
/**
* Creates a BytesMessage
+ *
+ * @return a newly created BytesMessage.
* @throws CMSException
*/
virtual cms::BytesMessage* createBytesMessage()
throw ( cms::CMSException );
/**
- * Creates a BytesMessage and sets the payload to the passed value
- * @param an array of bytes to set in the message
- * @param the size of the bytes array, or number of bytes to use
+ * Creates a BytesMessage and sets the pay-load to the passed value
+ *
+ * @param bytes - an array of bytes to set in the message
+ * @param bytesSize - the size of the bytes array, or number of bytes to use
+ * @return a newly created BytesMessage.
+ *
* @throws CMSException
*/
virtual cms::BytesMessage* createBytesMessage(
@@ -369,27 +378,33 @@
/**
* Creates a new StreamMessage
- * TODO - Throws UnsupportedOperation as this Message is not Implemented yet.
+ *
+ * @returns a newly created StreamMessage.
* @throws CMSException
*/
virtual cms::StreamMessage* createStreamMessage() throw ( cms::CMSException );
/**
* Creates a new TextMessage
+ * @returns a newly created TextMessage.
* @throws CMSException
*/
virtual cms::TextMessage* createTextMessage() throw ( cms::CMSException );
/**
* Creates a new TextMessage and set the text to the value given
- * @param the initial text for the message
+ *
+ * @param text - The initial text for the message
+ * @returns a newly created TextMessage with the given Text set in the Message body.
* @throws CMSException
*/
virtual cms::TextMessage* createTextMessage( const std::string& text )
throw ( cms::CMSException );
/**
- * Creates a new TextMessage
+ * Creates a new MapMessage
+ *
+ * @returns a newly created MapMessage.
* @throws CMSException
*/
virtual cms::MapMessage* createMapMessage()
@@ -434,7 +449,7 @@
*
* @param message
* The message to send to the broker.
- * @param prducer
+ * @param producer
* The sending Producer
* @param usage
* Pointer to a Usage tracker which if set will be increased by the size
@@ -504,7 +519,9 @@
/**
* Dispose of a Consumer from this session. Removes it from the Connection
* and clean up any resources associated with it.
- * @param consumerId - the Id of the Consumer to dispose.
+ *
+ * @param id - the Id of the Consumer to dispose.
+ * @throw ActiveMQException if an internal error occurs.
*/
void disposeOf( decaf::lang::Pointer<commands::ConsumerId> id )
throw ( activemq::exceptions::ActiveMQException );
@@ -512,7 +529,9 @@
/**
* Dispose of a Producer from this session. Removes it from the Connection
* and clean up any resources associated with it.
- * @param consumerId - the Id of the Producer to dispose.
+ *
+ * @param id - the Id of the Producer to dispose.
+ * @throw ActiveMQException if an internal error occurs.
*/
void disposeOf( decaf::lang::Pointer<commands::ProducerId> id )
throw ( activemq::exceptions::ActiveMQException );