[Telepathy-commits] [telepathy-spec/master] Connection: use the proper annotations for <tp:added>, <tp:deprecated>

Simon McVittie simon.mcvittie at collabora.co.uk
Tue Sep 9 08:53:20 PDT 2008


20080522103215-53eee-8c0bca457a59e4e115e91f0162978eaa1c8b63ac.gz
---
 spec/Connection.xml |   13 +++++++++++--
 1 files changed, 11 insertions(+), 2 deletions(-)

diff --git a/spec/Connection.xml b/spec/Connection.xml
index 29ea4a6..0d54008 100644
--- a/spec/Connection.xml
+++ b/spec/Connection.xml
@@ -125,8 +125,11 @@ USA.</p>
       <tp:docstring>
         Emitted whenever the SelfHandle property changes. If the connection
         is not yet in the CONNECTED state, this signal is not guaranteed
-        to be emitted. (New in 0.17.UNRELEASED)
+        to be emitted.
       </tp:docstring>
+      <tp:added version="0.17.UNRELEASED">Clients MAY assume that if the
+        SelfHandle property exists, this signal will be emitted when
+        necessary.</tp:added>
 
       <arg type="u" tp:type="Contact_Handle" name="Self_Handle">
         <tp:docstring>
@@ -142,8 +145,11 @@ USA.</p>
         remain valid for the lifetime of this connection, or until a change
         in the user's identifier is signalled by the SelfHandleChanged signal.
         If the connection is not yet in the CONNECTED state, the value of
-        this property MAY be zero. (New in 0.17.UNRELEASED)
+        this property MAY be zero.
       </tp:docstring>
+      <tp:added version="0.17.UNRELEASED">For compatibility with older
+        versions, clients should fall back to calling the GetSelfHandle
+        method.</tp:added>
     </property>
 
     <method name="GetSelfHandle">
@@ -159,6 +165,9 @@ USA.</p>
         in the user's identifier is signalled by the Renamed signal on the
         Renaming interface (if present). This is always a CONTACT type handle.
       </tp:docstring>
+      <tp:deprecated version="0.17.UNRELEASED">Use GetAll to get the
+        SelfHandle property (and all other Connection properties)
+        instead.</tp:deprecated>
 
       <tp:possible-errors>
         <tp:error name="org.freedesktop.Telepathy.Error.Disconnected"/>
-- 
1.5.6.3




More information about the Telepathy-commits mailing list