1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/calls.git synced 2024-12-14 00:17:35 +00:00

dbus: Document interface in a way that gtk-doc can use

Fixes #394
This commit is contained in:
Evangelos Ribeiro Tzaras 2022-01-20 10:50:48 +01:00
parent 12ae596352
commit 99057452c5

View file

@ -21,16 +21,44 @@
<node> <node>
<!--
org.gnome.Calls.Call:
This objects lets applications accept, reject calls
and query call properties like the call state, the id of the remote
peer and more.
-->
<interface name="org.gnome.Calls.Call"> <interface name="org.gnome.Calls.Call">
<!--
Accept:
Accept the incoming call.
-->
<method name="Accept"/> <method name="Accept"/>
<!--
Hangup:
Hang up the call
-->
<method name="Hangup"/> <method name="Hangup"/>
<!--
SendDtmf:
@tone: A one character string. One of: 0-9,A-D,* or #.
Send DTMF tone.
-->
<method name="SendDtmf"> <method name="SendDtmf">
<arg name="Tone" type="s" direction="in"> <arg name="tone" type="s" direction="in">
<doc:doc> <doc:doc>
<doc:summary>A one character string. One of: 0-9,A-D,* or #.</doc:summary> <doc:summary>A one character string. One of: 0-9,A-D,* or #.</doc:summary>
</doc:doc> </doc:doc>
</arg> </arg>
</method> </method>
<!--
Silence:
Silence the ringing of incoming call
-->
<method name="Silence"/> <method name="Silence"/>
<doc:doc> <doc:doc>
<doc:summary>Silence the ringing</doc:summary> <doc:summary>Silence the ringing</doc:summary>
@ -47,6 +75,10 @@
Unrecognized values should be considered equal to Unknown. Unrecognized values should be considered equal to Unknown.
--> -->
<property name="State" type="u" access="read"/> <property name="State" type="u" access="read"/>
<!--
Id:
The ID identifying the call, e.g. a phone number
-->
<property name="Id" type="s" access="read"> <property name="Id" type="s" access="read">
<doc:doc> <doc:doc>
<doc:description> <doc:description>
@ -54,13 +86,23 @@
</doc:description> </doc:description>
</doc:doc> </doc:doc>
</property> </property>
<!--
DisplayName:
The DisplayName of the calling party, e.g. from the address book
-->
<property name="DisplayName" type="s" access="read"> <property name="DisplayName" type="s" access="read">
<doc:doc> <doc:doc>
<doc:description> <doc:description>
<doc:para>The DisplayName of the calling party, e.g. from address book</doc:para> <doc:para>The DisplayName of the calling party, e.g. from the address book</doc:para>
</doc:description> </doc:description>
</doc:doc> </doc:doc>
</property> </property>
<!--
ImagePath:
The path to an (avatar) image to display for this call.
-->
<property name="ImagePath" type="s" access="read"> <property name="ImagePath" type="s" access="read">
<doc:doc> <doc:doc>
<doc:description> <doc:description>
@ -68,6 +110,11 @@
</doc:description> </doc:description>
</doc:doc> </doc:doc>
</property> </property>
<!--
Protocol:
The protocol used for this call, e.g. "tel" or "sip".
-->
<property name="Protocol" type="s" access="read"> <property name="Protocol" type="s" access="read">
<doc:doc> <doc:doc>
<doc:description> <doc:description>
@ -75,6 +122,11 @@
</doc:description> </doc:description>
</doc:doc> </doc:doc>
</property> </property>
<!--
Encrypted:
Whether this call is encrypted.
-->
<property name="Encrypted" type="b" access="read"> <property name="Encrypted" type="b" access="read">
<doc:doc> <doc:doc>
<doc:description> <doc:description>
@ -83,6 +135,11 @@
</doc:description> </doc:description>
</doc:doc> </doc:doc>
</property> </property>
<!--
CanDtmf:
Whether this call is capable of sending DTMF.
-->
<property name="CanDtmf" type="b" access="read"> <property name="CanDtmf" type="b" access="read">
<doc:doc> <doc:doc>
<doc:description> <doc:description>