From 3604b93797477104350949f4c1f2558e7c24e363 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Guido=20G=C3=BCnther?= <agx@sigxcpu.org>
Date: Wed, 18 Sep 2024 12:12:03 +0200
Subject: [PATCH] dbus: Update OSK0 protocol from phosh

No functional change. Let's just make sure people copy pasting from here
get the commented version.

Part-of: <https://gitlab.gnome.org/World/Phosh/squeekboard/-/merge_requests/678>
---
 data/dbus/sm.puri.OSK0.xml | 35 +++++++++++++++++++++++------------
 1 file changed, 23 insertions(+), 12 deletions(-)

diff --git a/data/dbus/sm.puri.OSK0.xml b/data/dbus/sm.puri.OSK0.xml
index a543ee1d..cbcd0fbc 100644
--- a/data/dbus/sm.puri.OSK0.xml
+++ b/data/dbus/sm.puri.OSK0.xml
@@ -1,20 +1,31 @@
 <!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
 "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
 <node xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
+
+  <!--
+      sm.puri.OSK0:
+
+      This interface is exported by on screen keyboards (OSK) to
+      indicate and set state like visibility.
+  -->
+
   <interface name="sm.puri.OSK0">
+    <!--
+        SetVisible:
+        @visible: %TRUE if the OSK should be shown to the user, %FALSE otherwise
+
+        Toggle keyboard visibility.
+    -->
     <method name="SetVisible">
-      <arg name="visible" type="b" direction="in"/>
-      <doc:doc><doc:description>
-        Switch keyboard visibility
-      </doc:description></doc:doc>
+      <arg type="b" direction="in" name="visible"/>
     </method>
-    <method name="GetVisible">
-      <arg name="visible" type="b" direction="out"/>
-      <doc:doc><doc:description>
-        Get keyboard visibility
-      </doc:description></doc:doc>
-    </method>
-    <property name="Visible" type="b" access="read">
-    </property>
+    <!--
+        Visible:
+
+        Indicates whether the on screen keyboard is currently
+        unfolded. %TRUE if the OSK is currently visible to the user,
+        %FALSE otherwise.
+    -->
+    <property name="Visible" type="b" access="read"/>
   </interface>
 </node>