Re: [libvirt] [dbus PATCH v2 6/6] Use Documentation Annotations in D-Bus Interface XML

Since we don't follow the exact naming of libvirt API for libvirt-dbus, documentation should clarify which API call is used internally each time. Signed-off-by: Katerina Koukiou <kkoukiou(a)redhat.com&gt; --- data/org.libvirt.Connect.xml | 24 ++++++++++++++++ data/org.libvirt.Domain.xml | 66 ++++++++++++++++++++++++++++++++++++++------ 2 files changed, 82 insertions(+), 8 deletions(-) diff --git a/data/org.libvirt.Connect.xml b/data/org.libvirt.Connect.xml index 787cd8d..9849abe 100644 --- a/data/org.libvirt.Connect.xml +++ b/data/org.libvirt.Connect.xml @@ -4,51 +4,75 @@ <node name="/org/libvirt/connect"> <interface name="org.libvirt.Connect"> <method name="ListDomains"> + <annotation name="org.gtk.GDBus.DocString" + value="See https://libvirt.org/html/libvirt-libvirt-domain.html#virConnectListDomain...

<arg name="flags" type="u" direction="in"/> <arg name="domains" type="ao" direction="out"/> </method> <method name="CreateXML"> + <annotation name="org.gtk.GDBus.DocString" + value="See https://libvirt.org/html/libvirt-libvirt-domain.html#virDomainCreateXML&q... <arg name="xml" type="s" direction="in"/> <arg name="flags" type="u" direction="in"/> <arg name="domain" type="o" direction="out"/> </method> <method name="DefineXML"> + <annotation name="org.gtk.GDBus.DocString" + value="See https://libvirt.org/html/libvirt-libvirt-domain.html#virDomainDefineXML&q... <arg name="xml" type="s" direction="in"/> <arg name="domain" type="o" direction="out"/> </method> <signal name="DomainCrashed"> + <annotation name="org.gtk.GDBus.DocString" + value="See https://libvirt.org/html/libvirt-libvirt-domain.html#VIR_DOMAIN_EVENT_CRA... <arg name="reason" type="s"/> <arg name="domain" type="o"/> </signal>

<signal name="DomainDefined"> + <annotation name="org.gtk.GDBus.DocString" + value="See https://libvirt.org/html/libvirt-libvirt-domain.html#VIR_DOMAIN_EVENT_DEF... <arg name="reason" type="s"/> <arg name="domain" type="o"/> </signal> <signal name="DomainPMSuspended"> + <annotation name="org.gtk.GDBus.DocString" + value="See https://libvirt.org/html/libvirt-libvirt-domain.html#VIR_DOMAIN_EVENT_SUS... <arg name="reason" type="s"/> <arg name="domain" type="o"/> </signal> <signal name="DomainResumed"> + <annotation name="org.gtk.GDBus.DocString" + value="See https://libvirt.org/html/libvirt-libvirt-domain.html#VIR_DOMAIN_EVENT_RES... <arg name="reason" type="s"/> <arg name="domain" type="o"/> </signal> <signal name="DomainShutdown"> + <annotation name="org.gtk.GDBus.DocString" + value="See https://libvirt.org/html/libvirt-libvirt-domain.html#VIR_DOMAIN_EVENT_SHU... <arg name="reason" type="s"/> <arg name="domain" type="o"/> </signal> <signal name="DomainStarted"> + <annotation name="org.gtk.GDBus.DocString" + value="See https://libvirt.org/html/libvirt-libvirt-domain.html#VIR_DOMAIN_EVENT_STA... <arg name="reason" type="s"/> <arg name="domain" type="o"/> </signal> <signal name="DomainStopped"> + <annotation name="org.gtk.GDBus.DocString" + value="See https://libvirt.org/html/libvirt-libvirt-domain.html#VIR_DOMAIN_EVENT_STO... <arg name="reason" type="s"/> <arg name="domain" type="o"/> </signal> <signal name="DomainSuspended"> + <annotation name="org.gtk.GDBus.DocString" + value="See https://libvirt.org/html/libvirt-libvirt-domain.html#VIR_DOMAIN_EVENT_SUS... <arg name="reason" type="s"/> <arg name="domain" type="o"/> </signal> <signal name="DomainUndefined"> + <annotation name="org.gtk.GDBus.DocString" + value="See https://libvirt.org/html/libvirt-libvirt-domain.html#VIR_DOMAIN_EVENT_UND... <arg name="reason" type="s"/> <arg name="domain" type="o"/> </signal> diff --git a/data/org.libvirt.Domain.xml b/data/org.libvirt.Domain.xml index e79fb5e..4b927a8 100644 --- a/data/org.libvirt.Domain.xml +++ b/data/org.libvirt.Domain.xml @@ -3,58 +3,108 @@ <node name="/org/libvirt/domain"> <interface name="org.libvirt.Domain"> - <property name="Name" type="s" access="read"/> - <property name="UUID" type="s" access="read"/> - <property name="Id" type="u" access="read"/> - <property name="OSType" type="s" access="read"/> - <property name="Active" type="b" access="read"/> - <property name="Persistent" type="b" access="read"/> - <property name="State" type="s" access="read"/> - <property name="Autostart" type="b" access="read"/> + <property name="Name" type="s" access="read"> + <annotation name="org.gtk.GDBus.DocString" + value="See https://libvirt.org/html/libvirt-libvirt-domain.html#virDomainGetName&quo... + </property> + <property name="UUID" type="s" access="read"> + <annotation name="org.gtk.GDBus.DocString" + value="See https://libvirt.org/html/libvirt-libvirt-domain.html#virDomainGetUUID&quo...