[Telepathy-commits] [telepathy-spec/master] Approver, Observer: add some cross-references

[Simon McVittie]

20080624160154-53eee-510021f80c96e26302863cb38e2b6f2435975fff.gz
---
 spec/Client_Approver.xml |   17 +++++++++++------
 spec/Client_Observer.xml |    5 +++--
 2 files changed, 14 insertions(+), 8 deletions(-)

diff --git a/spec/Client_Approver.xml b/spec/Client_Approver.xml
index ef86c16..45fec7b 100644
--- a/spec/Client_Approver.xml
+++ b/spec/Client_Approver.xml
@@ -91,7 +91,9 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 
       <arg name="Handlers" type="as" direction="in">
         <tp:docstring>
-          The well-known bus names of clients that could handle this channel.
+          The well-known bus names of
+          <tp:dbus-ref namespace="org.freedesktop.Telepathy">Client.ChannelHandler</tp:dbus-ref>s
+          that could handle this channel.
           The channel dispatcher SHOULD order them with the "most preferred"
           handler first, in an implementation-dependent way.
         </tp:docstring>
@@ -100,17 +102,20 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 
       <arg name="Dispatch" type="o" direction="in">
         <tp:docstring>
-          The channel dispatch operation, which is an object inside the
-          channel dispatcher (and hence has the same well-known bus name,
+          The <tp:dbus-ref namespace="org.freedesktop.Telepathy">ChannelDispatchOperation</tp:dbus-ref>,
+          which is an object inside the channel dispatcher (and hence has the
+          same well-known bus name,
           org.freedesktop.Telepathy.ChannelDispatcher).
         </tp:docstring>
       </arg>
 
       <arg name="Connection" type="o" direction="in">
         <tp:docstring>
-          The Telepathy connection. Its well-known bus name can be derived
-          from its object path by replacing all '/' with '.' and removing
-          the leading '.' that results.
+          The <tp:dbus-ref namespace="org.freedesktop.Telepathy">Connection</tp:dbus-ref>
+          with which the channels are associated. The
+          well-known bus name to use can be derived from this object
+          path by removing the leading '/' and replacing all subsequent
+          '/' by '.'.
         </tp:docstring>
       </arg>
 
diff --git a/spec/Client_Observer.xml b/spec/Client_Observer.xml
index d553fda..f598644 100644
--- a/spec/Client_Observer.xml
+++ b/spec/Client_Observer.xml
@@ -81,8 +81,9 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 
       <arg name="Channel" type="o" direction="in">
         <tp:docstring>
-          The channel. Its well-known bus name is the same as that of the
-          Connection.
+          The
+          <tp:dbus-ref namespace="org.freedesktop.Telepathy">Channel</tp:dbus-ref>.
+          Its well-known bus name is the same as that of the Connection.
         </tp:docstring>
       </arg>
       <!-- FIXME: or should observers be invoked per ChannelDispatchOperation?
-- 
1.5.6.5