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@xxxxxxxxxx> --- 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#virConnectListDomains"/> <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"/> <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"/> <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_CRASHED"/> <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_DEFINED"/> <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_SUSPENDED"/> <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_RESUMED"/> <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_SHUTDOWN"/> <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_STARTED"/> <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_STOPPED"/> <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_SUSPENDED"/> <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_UNDEFINED"/> <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"/> + </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"/> + </property> + <property name="Id" type="u" access="read"> + <annotation name="org.gtk.GDBus.DocString" + value="See https://libvirt.org/html/libvirt-libvirt-domain.html#virDomainGetID"/> + </property> + <property name="OSType" type="s" access="read"> + <annotation name="org.gtk.GDBus.DocString" + value="See https://libvirt.org/html/libvirt-libvirt-domain.html#virDomainGetOSType"/> + </property> + <property name="Active" type="b" access="read"> + <annotation name="org.gtk.GDBus.DocString" + value="See https://libvirt.org/html/libvirt-libvirt-domain.html#virDomainIsActive"/> + </property> + <property name="Persistent" type="b" access="read"> + <annotation name="org.gtk.GDBus.DocString" + value="See https://libvirt.org/html/libvirt-libvirt-domain.html#virDomainIsPersistent"/> + </property> + <property name="State" type="s" access="read"> + <annotation name="org.gtk.GDBus.DocString" + value="See https://libvirt.org/html/libvirt-libvirt-domain.html#virDomainGetState"/> + </property> + <property name="Autostart" type="b" access="read"> + <annotation name="org.gtk.GDBus.DocString" + value="See https://libvirt.org/html/libvirt-libvirt-domain.html#virDomainGetAutostart"/> + </property> <method name="GetVcpus"> + <annotation name="org.gtk.GDBus.DocString" + value="See https://libvirt.org/html/libvirt-libvirt-domain.html#virDomainGetVcpusFlags"/> <arg name="flags" type="u" direction="in"/> <arg name="vcpus" type="u" direction="out"/> </method> <method name="GetXMLDesc"> + <annotation name="org.gtk.GDBus.DocString" + value="See https://libvirt.org/html/libvirt-libvirt-domain.html#virDomainGetXMLDesc"/> <arg name="flags" type="u" direction="in"/> <arg name="xml" type="s" direction="out"/> </method> <method name="GetStats"> + <annotation name="org.gtk.GDBus.DocString" + value="See https://libvirt.org/html/libvirt-libvirt-domain.html#virDomainListGetStats"/> <arg name="stats" type="u" direction="in"/> <arg name="flags" type="u" direction="in"/> <arg name="records" type="a{sv}" direction="out"/> </method> <method name="Shutdown"> + <annotation name="org.gtk.GDBus.DocString" + value="See https://libvirt.org/html/libvirt-libvirt-domain.html#virDomainShutdownFlags"/> <arg name="flags" type="u" direction="in"/> </method> <method name="Destroy"> + <annotation name="org.gtk.GDBus.DocString" + value="See https://libvirt.org/html/libvirt-libvirt-domain.html#virDomainDestroyFlags"/> <arg name="flags" type="u" direction="in"/> </method> <method name="Reboot"> + <annotation name="org.gtk.GDBus.DocString" + value="See https://libvirt.org/html/libvirt-libvirt-domain.html#virDomainReboot"/> <arg name="flags" type="u" direction="in"/> </method> <method name="Reset"> + <annotation name="org.gtk.GDBus.DocString" + value="See https://libvirt.org/html/libvirt-libvirt-domain.html#virDomainReset"/> <arg name="flags" type="u" direction="in"/> </method> <method name="Create"> + <annotation name="org.gtk.GDBus.DocString" + value="See https://libvirt.org/html/libvirt-libvirt-domain.html#virDomainCreateWithFlags"/> <arg name="flags" type="u" direction="in"/> </method> <method name="Undefine"> + <annotation name="org.gtk.GDBus.DocString" + value="See https://libvirt.org/html/libvirt-libvirt-domain.html#virDomainUndefineFlags"/> <arg name="flags" type="u" direction="in"/> </method> <signal name="DeviceAdded"> + <annotation name="org.gtk.GDBus.DocString" + value="See https://libvirt.org/html/libvirt-libvirt-domain.html#VIR_DOMAIN_EVENT_ID_DEVICE_ADDED"/> <arg name="device" type="s"/> </signal> <signal name="DeviceRemoved"> + <annotation name="org.gtk.GDBus.DocString" + value="See https://libvirt.org/html/libvirt-libvirt-domain.html#VIR_DOMAIN_EVENT_ID_DEVICE_REMOVED"/> <arg name="device" type="s"/> </signal> <signal name="DiskChange"> + <annotation name="org.gtk.GDBus.DocString" + value="See https://libvirt.org/html/libvirt-libvirt-domain.html#VIR_DOMAIN_EVENT_ID_DISK_CHANGE"/> <arg name="oldSrcPath" type="s"/> <arg name="newSrcPath" type="s"/> <arg name="device" type="s"/> <arg name="reason" type="s"/> </signal> <signal name="TrayChange"> + <annotation name="org.gtk.GDBus.DocString" + value="See https://libvirt.org/html/libvirt-libvirt-domain.html#VIR_DOMAIN_EVENT_ID_TRAY_CHANGE"/> <arg name="device" type="s"/> <arg name="reason" type="s"/> </signal> -- 2.15.0 -- libvir-list mailing list libvir-list@xxxxxxxxxx https://www.redhat.com/mailman/listinfo/libvir-list