From 687ea021264c854ca8dff2c3e7e830665da11d84 Mon Sep 17 00:00:00 2001
From: Kalev Lember <kalevlember@gmail.com>
Date: Tue, 10 Sep 2013 00:35:47 +0200
Subject: [PATCH 7/7] interface: Add some documentation

Document the DistanceThreshold property and LocationUpdated signal.

https://bugs.freedesktop.org/show_bug.cgi?id=69105
---
 src/geoclue-interface.xml | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/src/geoclue-interface.xml b/src/geoclue-interface.xml
index 95cee7b..48a0a91 100644
--- a/src/geoclue-interface.xml
+++ b/src/geoclue-interface.xml
@@ -8,9 +8,27 @@
   </interface>
   <interface name="org.freedesktop.GeoClue2.Client">
     <property name="Location" type="o" access="read"/>
+
+    <!--
+        DistanceThreshold:
+
+        Contains the current distance threshold in meters. This value is used
+        by the service when it gets new location info. If the distance moved is
+        below the threshold, it won't emit the LocationUpdated signal.
+    -->
     <property name="DistanceThreshold" type="u" access="readwrite"/>
     <method name="Start"/>
     <method name="Stop"/>
+
+    <!--
+        LocationUpdated:
+        @old: old location
+        @new: new location
+
+        The signal is emitted every time the location changes.
+        The client should set the DistanceThreshold property to control how
+        often this signal is emitted.
+    -->
     <signal name="LocationUpdated">
       <arg name="old" type="o"/>
       <arg name="new" type="o"/>
-- 
1.8.3.1