svn commit: r1628669 - /qpid/proton/trunk/proton-c/include/proton/event.h

[rh...@apache.org]

Author: rhs
Date: Wed Oct  1 10:13:46 2014
New Revision: 1628669

URL: http://svn.apache.org/r1628669
Log:
added missing doxygen for new transport events

Modified:
    qpid/proton/trunk/proton-c/include/proton/event.h

Modified: qpid/proton/trunk/proton-c/include/proton/event.h
URL: http://svn.apache.org/viewvc/qpid/proton/trunk/proton-c/include/proton/event.h?rev=1628669&r1=1628668&r2=1628669&view=diff
==============================================================================
--- qpid/proton/trunk/proton-c/include/proton/event.h (original)
+++ qpid/proton/trunk/proton-c/include/proton/event.h Wed Oct  1 10:13:46 2014
@@ -238,12 +238,31 @@ typedef enum {
    */
   PN_TRANSPORT,
 
+  /**
+   * Indicates that a transport error has occurred. Use
+   * ::pn_transport_condition() to access the details of the error
+   * from the associated transport.
+   */
   PN_TRANSPORT_ERROR,
 
+  /**
+   * Indicates that the head of the transport has been closed. This
+   * means the transport will never produce more bytes for output to
+   * the network. Events of this type point to the relevant transport.
+   */
   PN_TRANSPORT_HEAD_CLOSED,
 
+  /**
+   * Indicates that the tail of the transport has been closed. This
+   * means the transport will never be able to process more bytes from
+   * the network. Events of this type point to the relevant transport.
+   */
   PN_TRANSPORT_TAIL_CLOSED,
 
+  /**
+   * Indicates that the both the head and tail of the transport are
+   * closed. Events of this type point to the relevant transport.
+   */
   PN_TRANSPORT_CLOSED
 
 } pn_event_type_t;



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org