[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]

[libvirt] [libvirt-glib] Add docs for gvir_config_domain_set/get_memory



From: "Zeeshan Ali (Khattak)" <zeeshanak gnome org>

Its not obvious what units these functions deal with so docs are
critical for these functions.
---
 libvirt-gconfig/libvirt-gconfig-domain.c |   13 +++++++++++++
 1 files changed, 13 insertions(+), 0 deletions(-)

diff --git a/libvirt-gconfig/libvirt-gconfig-domain.c b/libvirt-gconfig/libvirt-gconfig-domain.c
index 3261755..c20dee8 100644
--- a/libvirt-gconfig/libvirt-gconfig-domain.c
+++ b/libvirt-gconfig/libvirt-gconfig-domain.c
@@ -196,12 +196,25 @@ void gvir_config_domain_set_name(GVirConfigDomain *domain, const char *name)
     g_object_notify(G_OBJECT(domain), "name");
 }
 
+/**
+ * gvir_config_domain_get_memory:
+ * @domain: A domain configuration object.
+ *
+ * Returns: amount of RAM, in kilobytes.
+ */
 guint64 gvir_config_domain_get_memory(GVirConfigDomain *domain)
 {
     return gvir_config_object_get_node_content_uint64(GVIR_CONFIG_OBJECT(domain),
                                                       "memory");
 }
 
+/**
+ * gvir_config_domain_set_memory:
+ * @domain: A domain configuration object.
+ * @memory: The amount of RAM.
+ *
+ * Sets the amount of RAM allocated to @domain, in kilobytes.
+ */
 void gvir_config_domain_set_memory(GVirConfigDomain *domain, guint64 memory)
 {
     gvir_config_object_set_node_content_uint64(GVIR_CONFIG_OBJECT(domain),
-- 
1.7.7.5


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]