# HG changeset patch
# User Ewan Mellor <ewan@xxxxxxxxxxxxx>
# Node ID 462b945e2f41238872de6b43a3300fbd3bbefecf
# Parent ecc16f3222dc877e22daed9307be04134752905e
Update doc-comments to match recent documentation tidy-ups.
Signed-off-by: Ewan Mellor <ewan@xxxxxxxxxxxxx>
---
tools/libxen/include/xen_console.h | 4 ++--
tools/libxen/include/xen_host.h | 4 ++--
tools/libxen/include/xen_host_cpu.h | 4 ++--
tools/libxen/include/xen_network.h | 4 ++--
tools/libxen/include/xen_pif.h | 4 ++--
tools/libxen/include/xen_sr.h | 4 ++--
tools/libxen/include/xen_user.h | 4 ++--
tools/libxen/include/xen_vdi.h | 4 ++--
tools/libxen/include/xen_vif.h | 4 ++--
tools/libxen/include/xen_vtpm.h | 4 ++--
10 files changed, 20 insertions(+), 20 deletions(-)
diff -r ecc16f3222dc -r 462b945e2f41 tools/libxen/include/xen_console.h
--- a/tools/libxen/include/xen_console.h Wed Dec 13 14:36:36 2006 +0000
+++ b/tools/libxen/include/xen_console.h Fri Dec 08 10:51:41 2006 +0000
@@ -149,14 +149,14 @@ xen_console_record_opt_set_free(xen_cons
/**
- * Get the current state of the given console.
+ * Get a record containing the current state of the given console.
*/
extern bool
xen_console_get_record(xen_session *session, xen_console_record **result,
xen_console console);
/**
- * Get a reference to the object with the specified UUID.
+ * Get a reference to the console instance with the specified UUID.
*/
extern bool
xen_console_get_by_uuid(xen_session *session, xen_console *result, char *uuid);
diff -r ecc16f3222dc -r 462b945e2f41 tools/libxen/include/xen_host.h
--- a/tools/libxen/include/xen_host.h Wed Dec 13 14:36:36 2006 +0000
+++ b/tools/libxen/include/xen_host.h Fri Dec 08 10:51:41 2006 +0000
@@ -154,14 +154,14 @@ xen_host_record_opt_set_free(xen_host_re
/**
- * Get the current state of the given host. !!!
+ * Get a record containing the current state of the given host.
*/
extern bool
xen_host_get_record(xen_session *session, xen_host_record **result, xen_host
host);
/**
- * Get a reference to the object with the specified UUID. !!!
+ * Get a reference to the host instance with the specified UUID.
*/
extern bool
xen_host_get_by_uuid(xen_session *session, xen_host *result, char *uuid);
diff -r ecc16f3222dc -r 462b945e2f41 tools/libxen/include/xen_host_cpu.h
--- a/tools/libxen/include/xen_host_cpu.h Wed Dec 13 14:36:36 2006 +0000
+++ b/tools/libxen/include/xen_host_cpu.h Fri Dec 08 10:51:41 2006 +0000
@@ -153,14 +153,14 @@ xen_host_cpu_record_opt_set_free(xen_hos
/**
- * Get the current state of the given host_cpu. !!!
+ * Get a record containing the current state of the given host_cpu.
*/
extern bool
xen_host_cpu_get_record(xen_session *session, xen_host_cpu_record **result,
xen_host_cpu host_cpu);
/**
- * Get a reference to the object with the specified UUID. !!!
+ * Get a reference to the host_cpu instance with the specified UUID.
*/
extern bool
xen_host_cpu_get_by_uuid(xen_session *session, xen_host_cpu *result, char
*uuid);
diff -r ecc16f3222dc -r 462b945e2f41 tools/libxen/include/xen_network.h
--- a/tools/libxen/include/xen_network.h Wed Dec 13 14:36:36 2006 +0000
+++ b/tools/libxen/include/xen_network.h Fri Dec 08 10:51:41 2006 +0000
@@ -152,14 +152,14 @@ xen_network_record_opt_set_free(xen_netw
/**
- * Get the current state of the given network. !!!
+ * Get a record containing the current state of the given network.
*/
extern bool
xen_network_get_record(xen_session *session, xen_network_record **result,
xen_network network);
/**
- * Get a reference to the object with the specified UUID. !!!
+ * Get a reference to the network instance with the specified UUID.
*/
extern bool
xen_network_get_by_uuid(xen_session *session, xen_network *result, char *uuid);
diff -r ecc16f3222dc -r 462b945e2f41 tools/libxen/include/xen_pif.h
--- a/tools/libxen/include/xen_pif.h Wed Dec 13 14:36:36 2006 +0000
+++ b/tools/libxen/include/xen_pif.h Fri Dec 08 10:51:41 2006 +0000
@@ -155,14 +155,14 @@ xen_pif_record_opt_set_free(xen_pif_reco
/**
- * Get the current state of the given PIF. !!!
+ * Get a record containing the current state of the given PIF.
*/
extern bool
xen_pif_get_record(xen_session *session, xen_pif_record **result, xen_pif pif);
/**
- * Get a reference to the object with the specified UUID. !!!
+ * Get a reference to the PIF instance with the specified UUID.
*/
extern bool
xen_pif_get_by_uuid(xen_session *session, xen_pif *result, char *uuid);
diff -r ecc16f3222dc -r 462b945e2f41 tools/libxen/include/xen_sr.h
--- a/tools/libxen/include/xen_sr.h Wed Dec 13 14:36:36 2006 +0000
+++ b/tools/libxen/include/xen_sr.h Fri Dec 08 10:51:41 2006 +0000
@@ -153,14 +153,14 @@ xen_sr_record_opt_set_free(xen_sr_record
/**
- * Get the current state of the given SR. !!!
+ * Get a record containing the current state of the given SR.
*/
extern bool
xen_sr_get_record(xen_session *session, xen_sr_record **result, xen_sr sr);
/**
- * Get a reference to the object with the specified UUID. !!!
+ * Get a reference to the SR instance with the specified UUID.
*/
extern bool
xen_sr_get_by_uuid(xen_session *session, xen_sr *result, char *uuid);
diff -r ecc16f3222dc -r 462b945e2f41 tools/libxen/include/xen_user.h
--- a/tools/libxen/include/xen_user.h Wed Dec 13 14:36:36 2006 +0000
+++ b/tools/libxen/include/xen_user.h Fri Dec 08 10:51:41 2006 +0000
@@ -146,14 +146,14 @@ xen_user_record_opt_set_free(xen_user_re
/**
- * Get the current state of the given user. !!!
+ * Get a record containing the current state of the given user.
*/
extern bool
xen_user_get_record(xen_session *session, xen_user_record **result, xen_user
user);
/**
- * Get a reference to the object with the specified UUID. !!!
+ * Get a reference to the user instance with the specified UUID.
*/
extern bool
xen_user_get_by_uuid(xen_session *session, xen_user *result, char *uuid);
diff -r ecc16f3222dc -r 462b945e2f41 tools/libxen/include/xen_vdi.h
--- a/tools/libxen/include/xen_vdi.h Wed Dec 13 14:36:36 2006 +0000
+++ b/tools/libxen/include/xen_vdi.h Fri Dec 08 10:51:41 2006 +0000
@@ -159,14 +159,14 @@ xen_vdi_record_opt_set_free(xen_vdi_reco
/**
- * Get the current state of the given VDI. !!!
+ * Get a record containing the current state of the given VDI.
*/
extern bool
xen_vdi_get_record(xen_session *session, xen_vdi_record **result, xen_vdi vdi);
/**
- * Get a reference to the object with the specified UUID. !!!
+ * Get a reference to the VDI instance with the specified UUID.
*/
extern bool
xen_vdi_get_by_uuid(xen_session *session, xen_vdi *result, char *uuid);
diff -r ecc16f3222dc -r 462b945e2f41 tools/libxen/include/xen_vif.h
--- a/tools/libxen/include/xen_vif.h Wed Dec 13 14:36:36 2006 +0000
+++ b/tools/libxen/include/xen_vif.h Fri Dec 08 10:51:41 2006 +0000
@@ -156,14 +156,14 @@ xen_vif_record_opt_set_free(xen_vif_reco
/**
- * Get the current state of the given VIF. !!!
+ * Get a record containing the current state of the given VIF.
*/
extern bool
xen_vif_get_record(xen_session *session, xen_vif_record **result, xen_vif vif);
/**
- * Get a reference to the object with the specified UUID. !!!
+ * Get a reference to the VIF instance with the specified UUID.
*/
extern bool
xen_vif_get_by_uuid(xen_session *session, xen_vif *result, char *uuid);
diff -r ecc16f3222dc -r 462b945e2f41 tools/libxen/include/xen_vtpm.h
--- a/tools/libxen/include/xen_vtpm.h Wed Dec 13 14:36:36 2006 +0000
+++ b/tools/libxen/include/xen_vtpm.h Fri Dec 08 10:51:41 2006 +0000
@@ -151,14 +151,14 @@ xen_vtpm_record_opt_set_free(xen_vtpm_re
/**
- * Get the current state of the given VTPM. !!!
+ * Get a record containing the current state of the given VTPM.
*/
extern bool
xen_vtpm_get_record(xen_session *session, xen_vtpm_record **result, xen_vtpm
vtpm);
/**
- * Get a reference to the object with the specified UUID. !!!
+ * Get a reference to the VTPM instance with the specified UUID.
*/
extern bool
xen_vtpm_get_by_uuid(xen_session *session, xen_vtpm *result, char *uuid);
_______________________________________________
Xen-changelog mailing list
Xen-changelog@xxxxxxxxxxxxxxxxxxx
http://lists.xensource.com/xen-changelog
|
Home