[libvirt] [libvirt-glib 2/4] config: Improve documentation of GVirConfigDomain::set_memory

[Daniel P. Berrange]

On Tue, Sep 04, 2012 at 02:44:46PM +0200, Christophe Fergeau wrote:
> Explicit the fact that it sets the maximum domain memory.
> ---
>  libvirt-gconfig/libvirt-gconfig-domain.c | 7 ++++---
>  1 file changed, 4 insertions(+), 3 deletions(-)
> 
> diff --git a/libvirt-gconfig/libvirt-gconfig-domain.c b/libvirt-gconfig/libvirt-gconfig-domain.c
> index 2ca478f..e6f22bd 100644
> --- a/libvirt-gconfig/libvirt-gconfig-domain.c
> +++ b/libvirt-gconfig/libvirt-gconfig-domain.c
> @@ -286,7 +286,7 @@ void gvir_config_domain_set_description(GVirConfigDomain *domain, const char *de
>   * gvir_config_domain_get_memory:
>   * @domain: a #GVirConfigDomain
>   *
> - * Returns: amount of RAM in kilobytes (i.e. blocks of 1024 bytes).
> + * Returns: maximum amount of RAM in kilobytes (i.e. blocks of 1024 bytes).
>   */
>  guint64 gvir_config_domain_get_memory(GVirConfigDomain *domain)
>  {
> @@ -297,9 +297,10 @@ guint64 gvir_config_domain_get_memory(GVirConfigDomain *domain)
>  /**
>   * gvir_config_domain_set_memory:
>   * @domain: a #GVirConfigDomain
> - * @memory: The amount of RAM in kilobytes.
> + * @memory: The maximum amount of RAM in kilobytes.
>   *
> - * Sets the amount of RAM allocated to @domain in kilobytes (i.e. blocks of 1024 bytes).
> + * Sets the maximum amount of RAM allocated to @domain in kilobytes (i.e.
> + * blocks of 1024 bytes).
>   */
>  void gvir_config_domain_set_memory(GVirConfigDomain *domain, guint64 memory)
>  {

ACK


Daniel
-- 
|: http://berrange.com      -o-    http://www.flickr.com/photos/dberrange/ :|
|: http://libvirt.org              -o-             http://virt-manager.org :|
|: http://autobuild.org       -o-         http://search.cpan.org/~danberr/ :|
|: http://entangle-photo.org       -o-       http://live.gnome.org/gtk-vnc :|