Merge pull request #44 from mahkoh/bot/update-protocols

Update protocols

Author: mahkoh

protocols/river-protocols/river-layer-shell-v1.xml

@@ -93,10 +93,10 @@
         This event will be followed by a manage_start event after all other new
         state has been sent by the server.
       </description>
-      <arg name="x" type="int"/>
-      <arg name="y" type="int"/>
-      <arg name="width" type="int"/>
-      <arg name="height" type="int"/>
+      <arg name="x" type="int" summary="global x coordinate"/>
+      <arg name="y" type="int" summary="global y coordinate"/>
+      <arg name="width" type="int" summary="area width"/>
+      <arg name="height" type="int" summary="area height"/>
     </event>
     <request name="set_default">
       <description summary="Set default output for layer surfaces">
@@ -128,7 +128,7 @@
       </description>
     </request>
     <event name="focus_exclusive">
-      <description summary="">
+      <description summary="layer shell surface has exclusive focus">
         A layer shell surface will be given exclusive keyboard focus at the end
         of the manage sequence in which this event is sent. The window manager
         may want to update window decorations or similar to indicate that no
@@ -142,7 +142,7 @@
       </description>
     </event>
     <event name="focus_non_exclusive">
-      <description summary="">
+      <description summary="layer shell surface wants non-exclusive focus">
         A layer shell surface will be given non-exclusive keyboard focus at the
         end of the manage sequence in which this event is sent. The window
         manager may want to update window decorations or similar to indicate
@@ -153,12 +153,16 @@
         focus during the same manage sequence in which this event is sent, the
         layer surface will not be focused.
 
+        If the layer surface with non-exclusive focus is closed or the window
+        manager chooses to move focus away from the layer surface, a focus_none
+        event will be sent in the next manage sequence.
+
         This event will be followed by a manage_start event after all other new
         state has been sent by the server.
       </description>
     </event>
     <event name="focus_none">
-      <description summary="">
+      <description summary="no layer shell surface has focus">
         No layer shell surface will have keyboard focus at the end of the manage
         sequence in which this event is sent. The window manager may want to
         return focus to whichever window last had focus, for example.

wl-proxy/src/protocols/river_layer_shell_v1/river_layer_shell_output_v1.rs

@@ -132,10 +132,10 @@ impl RiverLayerShellOutputV1 {
     ///
     /// # Arguments
     ///
-    /// - `x`:
-    /// - `y`:
-    /// - `width`:
-    /// - `height`:
+    /// - `x`: global x coordinate
+    /// - `y`: global y coordinate
+    /// - `width`: area width
+    /// - `height`: area height
     #[inline]
     pub fn try_send_non_exclusive_area(
         &self,
@@ -204,10 +204,10 @@ impl RiverLayerShellOutputV1 {
     ///
     /// # Arguments
     ///
-    /// - `x`:
-    /// - `y`:
-    /// - `width`:
-    /// - `height`:
+    /// - `x`: global x coordinate
+    /// - `y`: global y coordinate
+    /// - `width`: area width
+    /// - `height`: area height
     #[inline]
     pub fn send_non_exclusive_area(
         &self,
@@ -345,10 +345,10 @@ pub trait RiverLayerShellOutputV1Handler: Any {
     ///
     /// # Arguments
     ///
-    /// - `x`:
-    /// - `y`:
-    /// - `width`:
-    /// - `height`:
+    /// - `x`: global x coordinate
+    /// - `y`: global y coordinate
+    /// - `width`: area width
+    /// - `height`: area height
     #[inline]
     fn handle_non_exclusive_area(
         &mut self,

wl-proxy/src/protocols/river_layer_shell_v1/river_layer_shell_seat_v1.rs

@@ -118,6 +118,7 @@ impl RiverLayerShellSeatV1 {
     /// Since when the focus_exclusive message is available.
     pub const MSG__FOCUS_EXCLUSIVE__SINCE: u32 = 1;
 
+    /// layer shell surface has exclusive focus
     ///
     /// A layer shell surface will be given exclusive keyboard focus at the end
     /// of the manage sequence in which this event is sent. The window manager
@@ -164,6 +165,7 @@ impl RiverLayerShellSeatV1 {
         Ok(())
     }
 
+    /// layer shell surface has exclusive focus
     ///
     /// A layer shell surface will be given exclusive keyboard focus at the end
     /// of the manage sequence in which this event is sent. The window manager
@@ -189,6 +191,7 @@ impl RiverLayerShellSeatV1 {
     /// Since when the focus_non_exclusive message is available.
     pub const MSG__FOCUS_NON_EXCLUSIVE__SINCE: u32 = 1;
 
+    /// layer shell surface wants non-exclusive focus
     ///
     /// A layer shell surface will be given non-exclusive keyboard focus at the
     /// end of the manage sequence in which this event is sent. The window
@@ -200,6 +203,10 @@ impl RiverLayerShellSeatV1 {
     /// focus during the same manage sequence in which this event is sent, the
     /// layer surface will not be focused.
     ///
+    /// If the layer surface with non-exclusive focus is closed or the window
+    /// manager chooses to move focus away from the layer surface, a focus_none
+    /// event will be sent in the next manage sequence.
+    ///
     /// This event will be followed by a manage_start event after all other new
     /// state has been sent by the server.
     #[inline]
@@ -237,6 +244,7 @@ impl RiverLayerShellSeatV1 {
         Ok(())
     }
 
+    /// layer shell surface wants non-exclusive focus
     ///
     /// A layer shell surface will be given non-exclusive keyboard focus at the
     /// end of the manage sequence in which this event is sent. The window
@@ -248,6 +256,10 @@ impl RiverLayerShellSeatV1 {
     /// focus during the same manage sequence in which this event is sent, the
     /// layer surface will not be focused.
     ///
+    /// If the layer surface with non-exclusive focus is closed or the window
+    /// manager chooses to move focus away from the layer surface, a focus_none
+    /// event will be sent in the next manage sequence.
+    ///
     /// This event will be followed by a manage_start event after all other new
     /// state has been sent by the server.
     #[inline]
@@ -264,6 +276,7 @@ impl RiverLayerShellSeatV1 {
     /// Since when the focus_none message is available.
     pub const MSG__FOCUS_NONE__SINCE: u32 = 1;
 
+    /// no layer shell surface has focus
     ///
     /// No layer shell surface will have keyboard focus at the end of the manage
     /// sequence in which this event is sent. The window manager may want to
@@ -306,6 +319,7 @@ impl RiverLayerShellSeatV1 {
         Ok(())
     }
 
+    /// no layer shell surface has focus
     ///
     /// No layer shell surface will have keyboard focus at the end of the manage
     /// sequence in which this event is sent. The window manager may want to
@@ -357,6 +371,7 @@ pub trait RiverLayerShellSeatV1Handler: Any {
         }
     }
 
+    /// layer shell surface has exclusive focus
     ///
     /// A layer shell surface will be given exclusive keyboard focus at the end
     /// of the manage sequence in which this event is sent. The window manager
@@ -383,6 +398,7 @@ pub trait RiverLayerShellSeatV1Handler: Any {
         }
     }
 
+    /// layer shell surface wants non-exclusive focus
     ///
     /// A layer shell surface will be given non-exclusive keyboard focus at the
     /// end of the manage sequence in which this event is sent. The window
@@ -394,6 +410,10 @@ pub trait RiverLayerShellSeatV1Handler: Any {
     /// focus during the same manage sequence in which this event is sent, the
     /// layer surface will not be focused.
     ///
+    /// If the layer surface with non-exclusive focus is closed or the window
+    /// manager chooses to move focus away from the layer surface, a focus_none
+    /// event will be sent in the next manage sequence.
+    ///
     /// This event will be followed by a manage_start event after all other new
     /// state has been sent by the server.
     #[inline]
@@ -411,6 +431,7 @@ pub trait RiverLayerShellSeatV1Handler: Any {
         }
     }
 
+    /// no layer shell surface has focus
     ///
     /// No layer shell surface will have keyboard focus at the end of the manage
     /// sequence in which this event is sent. The window manager may want to