add doc comment to HandshakeFailure

antonilol · May 1, 2024 · 21f7f4f · 21f7f4f
1 parent 389b086
commit 21f7f4f
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/src/monitor/event.rs b/src/monitor/event.rs
@@ -30,12 +30,14 @@ macro_rules! type_or_u32 {
 
 macro_rules! define_handshake_failure_enum {
     (
+        $(#[$attr:meta])*
         pub enum HandshakeFailure {
             $(
                 $name:ident = $zmq_sys_name:ident,
             )*
         }
     ) => {
+        $(#[$attr])*
         #[repr(u32)]
         #[derive(Debug, Clone, Copy, PartialEq, Eq)]
         pub enum HandshakeFailure {
@@ -62,6 +64,7 @@ macro_rules! define_handshake_failure_enum {
 }
 
 define_handshake_failure_enum! {
+    /// Possible values for the ZMQ_EVENT_HANDSHAKE_FAILED_PROTOCOL socket event.
     pub enum HandshakeFailure {
         ZmtpUnspecified = ZMQ_PROTOCOL_ERROR_ZMTP_UNSPECIFIED,
         ZmtpUnexpectedCommand = ZMQ_PROTOCOL_ERROR_ZMTP_UNEXPECTED_COMMAND,
@@ -128,8 +131,7 @@ macro_rules! define_socket_event_enum {
 
 define_socket_event_enum! {
     /// An event from one of the connected sockets. See the "SUPPORTED EVENTS" section in the
-    /// "zmq_socket_monitor" manual page (`man zmq_socket_monitor`) for the original
-    /// documentation.
+    /// "zmq_socket_monitor" manual page (`man zmq_socket_monitor`) for the original documentation.
     pub enum SocketEvent {
         Connected(fd) = ZMQ_EVENT_CONNECTED,
         ConnectDelayed = ZMQ_EVENT_CONNECT_DELAYED,