libvirt.c: document the virState* functions

* src/libvirt.c (virStateActive, virStateCleanup, virStateReload):
(virStateActive): Add per-function comments.

diff --git a/ChangeLog b/ChangeLog
index 27acc624021eee93ac5f3c32566f251d0a1af9f4..c4f3990dc51525e797518b108eb358d131b80a31 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+Tue Nov 25 11:29:18 +0100 2008 Jim Meyering <meyering@redhat.com>
+
+       libvirt.c: document the virState* functions
+       * src/libvirt.c (virStateActive, virStateCleanup, virStateReload):
+       (virStateActive): Add per-function comments.
+
 Mon Nov 24 19:32:40 GMT 2008 Dnaiel P. Berrange <berrange@redhat.com>
 
        * src/openvz_conf.c, src/openvz_conf.h, src/openvz_driver.c:

diff --git a/src/libvirt.c b/src/libvirt.c
index f4453332e7550e11fc9087323e4a0747c04496a1..6195a4e776d2ce94600fd749eb2aaf2d1fb83781 100644 (file)
--- a/src/libvirt.c
+++ b/src/libvirt.c
@@ -636,6 +636,13 @@ virRegisterStateDriver(virStateDriverPtr driver)
     return virStateDriverTabCount++;
 }
 
+/**
+ * virStateInitialize:
+ *
+ * Initialize all virtualization drivers.
+ *
+ * Return 0 if all succeed, -1 upon any failure.
+ */
 int virStateInitialize(void) {
     int i, ret = 0;
 
@@ -650,6 +657,13 @@ int virStateInitialize(void) {
     return ret;
 }
 
+/**
+ * virStateCleanup:
+ *
+ * Run each virtualization driver's cleanup method.
+ *
+ * Return 0 if all succeed, -1 upon any failure.
+ */
 int virStateCleanup(void) {
     int i, ret = 0;
 
@@ -661,6 +675,13 @@ int virStateCleanup(void) {
     return ret;
 }
 
+/**
+ * virStateReload:
+ *
+ * Run each virtualization driver's reload method.
+ *
+ * Return 0 if all succeed, -1 upon any failure.
+ */
 int virStateReload(void) {
     int i, ret = 0;
 
@@ -672,6 +693,13 @@ int virStateReload(void) {
     return ret;
 }
 
+/**
+ * virStateActive:
+ *
+ * Run each virtualization driver's "active" method.
+ *
+ * Return 0 if none are active, 1 if at least one is.
+ */
 int virStateActive(void) {
     int i, ret = 0;