ia64/xen-unstable

changeset 12999:462b945e2f41

Update doc-comments to match recent documentation tidy-ups.

Signed-off-by: Ewan Mellor <ewan@xensource.com>
author Ewan Mellor <ewan@xensource.com>
date Fri Dec 08 10:51:41 2006 +0000 (2006-12-08)
parents ecc16f3222dc
children 5fc7ac854bce
files tools/libxen/include/xen_console.h tools/libxen/include/xen_host.h tools/libxen/include/xen_host_cpu.h tools/libxen/include/xen_network.h tools/libxen/include/xen_pif.h tools/libxen/include/xen_sr.h tools/libxen/include/xen_user.h tools/libxen/include/xen_vdi.h tools/libxen/include/xen_vif.h tools/libxen/include/xen_vtpm.h
line diff
     1.1 --- a/tools/libxen/include/xen_console.h	Wed Dec 13 14:36:36 2006 +0000
     1.2 +++ b/tools/libxen/include/xen_console.h	Fri Dec 08 10:51:41 2006 +0000
     1.3 @@ -149,14 +149,14 @@ xen_console_record_opt_set_free(xen_cons
     1.4  
     1.5  
     1.6  /**
     1.7 - * Get the current state of the given console.
     1.8 + * Get a record containing the current state of the given console.
     1.9   */
    1.10  extern bool
    1.11  xen_console_get_record(xen_session *session, xen_console_record **result, xen_console console);
    1.12  
    1.13  
    1.14  /**
    1.15 - * Get a reference to the object with the specified UUID.
    1.16 + * Get a reference to the console instance with the specified UUID.
    1.17   */
    1.18  extern bool
    1.19  xen_console_get_by_uuid(xen_session *session, xen_console *result, char *uuid);
     2.1 --- a/tools/libxen/include/xen_host.h	Wed Dec 13 14:36:36 2006 +0000
     2.2 +++ b/tools/libxen/include/xen_host.h	Fri Dec 08 10:51:41 2006 +0000
     2.3 @@ -154,14 +154,14 @@ xen_host_record_opt_set_free(xen_host_re
     2.4  
     2.5  
     2.6  /**
     2.7 - * Get the current state of the given host.  !!!
     2.8 + * Get a record containing the current state of the given host.
     2.9   */
    2.10  extern bool
    2.11  xen_host_get_record(xen_session *session, xen_host_record **result, xen_host host);
    2.12  
    2.13  
    2.14  /**
    2.15 - * Get a reference to the object with the specified UUID.  !!!
    2.16 + * Get a reference to the host instance with the specified UUID.
    2.17   */
    2.18  extern bool
    2.19  xen_host_get_by_uuid(xen_session *session, xen_host *result, char *uuid);
     3.1 --- a/tools/libxen/include/xen_host_cpu.h	Wed Dec 13 14:36:36 2006 +0000
     3.2 +++ b/tools/libxen/include/xen_host_cpu.h	Fri Dec 08 10:51:41 2006 +0000
     3.3 @@ -153,14 +153,14 @@ xen_host_cpu_record_opt_set_free(xen_hos
     3.4  
     3.5  
     3.6  /**
     3.7 - * Get the current state of the given host_cpu.  !!!
     3.8 + * Get a record containing the current state of the given host_cpu.
     3.9   */
    3.10  extern bool
    3.11  xen_host_cpu_get_record(xen_session *session, xen_host_cpu_record **result, xen_host_cpu host_cpu);
    3.12  
    3.13  
    3.14  /**
    3.15 - * Get a reference to the object with the specified UUID.  !!!
    3.16 + * Get a reference to the host_cpu instance with the specified UUID.
    3.17   */
    3.18  extern bool
    3.19  xen_host_cpu_get_by_uuid(xen_session *session, xen_host_cpu *result, char *uuid);
     4.1 --- a/tools/libxen/include/xen_network.h	Wed Dec 13 14:36:36 2006 +0000
     4.2 +++ b/tools/libxen/include/xen_network.h	Fri Dec 08 10:51:41 2006 +0000
     4.3 @@ -152,14 +152,14 @@ xen_network_record_opt_set_free(xen_netw
     4.4  
     4.5  
     4.6  /**
     4.7 - * Get the current state of the given network.  !!!
     4.8 + * Get a record containing the current state of the given network.
     4.9   */
    4.10  extern bool
    4.11  xen_network_get_record(xen_session *session, xen_network_record **result, xen_network network);
    4.12  
    4.13  
    4.14  /**
    4.15 - * Get a reference to the object with the specified UUID.  !!!
    4.16 + * Get a reference to the network instance with the specified UUID.
    4.17   */
    4.18  extern bool
    4.19  xen_network_get_by_uuid(xen_session *session, xen_network *result, char *uuid);
     5.1 --- a/tools/libxen/include/xen_pif.h	Wed Dec 13 14:36:36 2006 +0000
     5.2 +++ b/tools/libxen/include/xen_pif.h	Fri Dec 08 10:51:41 2006 +0000
     5.3 @@ -155,14 +155,14 @@ xen_pif_record_opt_set_free(xen_pif_reco
     5.4  
     5.5  
     5.6  /**
     5.7 - * Get the current state of the given PIF.  !!!
     5.8 + * Get a record containing the current state of the given PIF.
     5.9   */
    5.10  extern bool
    5.11  xen_pif_get_record(xen_session *session, xen_pif_record **result, xen_pif pif);
    5.12  
    5.13  
    5.14  /**
    5.15 - * Get a reference to the object with the specified UUID.  !!!
    5.16 + * Get a reference to the PIF instance with the specified UUID.
    5.17   */
    5.18  extern bool
    5.19  xen_pif_get_by_uuid(xen_session *session, xen_pif *result, char *uuid);
     6.1 --- a/tools/libxen/include/xen_sr.h	Wed Dec 13 14:36:36 2006 +0000
     6.2 +++ b/tools/libxen/include/xen_sr.h	Fri Dec 08 10:51:41 2006 +0000
     6.3 @@ -153,14 +153,14 @@ xen_sr_record_opt_set_free(xen_sr_record
     6.4  
     6.5  
     6.6  /**
     6.7 - * Get the current state of the given SR.  !!!
     6.8 + * Get a record containing the current state of the given SR.
     6.9   */
    6.10  extern bool
    6.11  xen_sr_get_record(xen_session *session, xen_sr_record **result, xen_sr sr);
    6.12  
    6.13  
    6.14  /**
    6.15 - * Get a reference to the object with the specified UUID.  !!!
    6.16 + * Get a reference to the SR instance with the specified UUID.
    6.17   */
    6.18  extern bool
    6.19  xen_sr_get_by_uuid(xen_session *session, xen_sr *result, char *uuid);
     7.1 --- a/tools/libxen/include/xen_user.h	Wed Dec 13 14:36:36 2006 +0000
     7.2 +++ b/tools/libxen/include/xen_user.h	Fri Dec 08 10:51:41 2006 +0000
     7.3 @@ -146,14 +146,14 @@ xen_user_record_opt_set_free(xen_user_re
     7.4  
     7.5  
     7.6  /**
     7.7 - * Get the current state of the given user.  !!!
     7.8 + * Get a record containing the current state of the given user.
     7.9   */
    7.10  extern bool
    7.11  xen_user_get_record(xen_session *session, xen_user_record **result, xen_user user);
    7.12  
    7.13  
    7.14  /**
    7.15 - * Get a reference to the object with the specified UUID.  !!!
    7.16 + * Get a reference to the user instance with the specified UUID.
    7.17   */
    7.18  extern bool
    7.19  xen_user_get_by_uuid(xen_session *session, xen_user *result, char *uuid);
     8.1 --- a/tools/libxen/include/xen_vdi.h	Wed Dec 13 14:36:36 2006 +0000
     8.2 +++ b/tools/libxen/include/xen_vdi.h	Fri Dec 08 10:51:41 2006 +0000
     8.3 @@ -159,14 +159,14 @@ xen_vdi_record_opt_set_free(xen_vdi_reco
     8.4  
     8.5  
     8.6  /**
     8.7 - * Get the current state of the given VDI.  !!!
     8.8 + * Get a record containing the current state of the given VDI.
     8.9   */
    8.10  extern bool
    8.11  xen_vdi_get_record(xen_session *session, xen_vdi_record **result, xen_vdi vdi);
    8.12  
    8.13  
    8.14  /**
    8.15 - * Get a reference to the object with the specified UUID.  !!!
    8.16 + * Get a reference to the VDI instance with the specified UUID.
    8.17   */
    8.18  extern bool
    8.19  xen_vdi_get_by_uuid(xen_session *session, xen_vdi *result, char *uuid);
     9.1 --- a/tools/libxen/include/xen_vif.h	Wed Dec 13 14:36:36 2006 +0000
     9.2 +++ b/tools/libxen/include/xen_vif.h	Fri Dec 08 10:51:41 2006 +0000
     9.3 @@ -156,14 +156,14 @@ xen_vif_record_opt_set_free(xen_vif_reco
     9.4  
     9.5  
     9.6  /**
     9.7 - * Get the current state of the given VIF.  !!!
     9.8 + * Get a record containing the current state of the given VIF.
     9.9   */
    9.10  extern bool
    9.11  xen_vif_get_record(xen_session *session, xen_vif_record **result, xen_vif vif);
    9.12  
    9.13  
    9.14  /**
    9.15 - * Get a reference to the object with the specified UUID.  !!!
    9.16 + * Get a reference to the VIF instance with the specified UUID.
    9.17   */
    9.18  extern bool
    9.19  xen_vif_get_by_uuid(xen_session *session, xen_vif *result, char *uuid);
    10.1 --- a/tools/libxen/include/xen_vtpm.h	Wed Dec 13 14:36:36 2006 +0000
    10.2 +++ b/tools/libxen/include/xen_vtpm.h	Fri Dec 08 10:51:41 2006 +0000
    10.3 @@ -151,14 +151,14 @@ xen_vtpm_record_opt_set_free(xen_vtpm_re
    10.4  
    10.5  
    10.6  /**
    10.7 - * Get the current state of the given VTPM.  !!!
    10.8 + * Get a record containing the current state of the given VTPM.
    10.9   */
   10.10  extern bool
   10.11  xen_vtpm_get_record(xen_session *session, xen_vtpm_record **result, xen_vtpm vtpm);
   10.12  
   10.13  
   10.14  /**
   10.15 - * Get a reference to the object with the specified UUID.  !!!
   10.16 + * Get a reference to the VTPM instance with the specified UUID.
   10.17   */
   10.18  extern bool
   10.19  xen_vtpm_get_by_uuid(xen_session *session, xen_vtpm *result, char *uuid);