[docs] Add some more Doxygen strings.
authorMaximilian Wilhelm <max@rfc2324.org>
Thu, 14 Jan 2010 23:48:16 +0000 (00:48 +0100)
committerMaximilian Wilhelm <max@rfc2324.org>
Thu, 14 Jan 2010 23:48:16 +0000 (00:48 +0100)
Signed-off-by: Maximilian Wilhelm <max@rfc2324.org>

lib/types.h

index e9e76e6..cc7cbc5 100644 (file)
@@ -101,6 +101,9 @@ struct VscMgmtNetwork {
        uint32_t num_ips_free;
 };
 
+/*!
+ * @brief A VSC management managed virtual machine.
+ */
 struct VscMgmtVm {
        struct VscMgmtVm *next;
 
@@ -111,6 +114,9 @@ struct VscMgmtVm {
        struct VscMgmtIpv4 host_ip;
 };
 
+/*!
+ * @brief A VSC management managed host.
+ */
 struct VscMgmtHost {
        struct VscMgmtHost *next;
 
@@ -127,6 +133,9 @@ struct VscMgmtHost {
        char *virtual_hardware_filename;
 };
 
+/*!
+ * @brief A set of VSC management managed hosts.
+ */
 struct VscMgmtHosts {
        int num_hosts;
        struct VscMgmtHost **hosts;
@@ -134,6 +143,9 @@ struct VscMgmtHosts {
 
 struct VscMgmtMutex;
 
+/*!
+ * @brief Information about a VMware VMDK image file.
+ */
 struct VscMgmtVmdkInfo {
        unsigned int fields;
 
@@ -153,17 +165,27 @@ struct VscMgmtVmdkInfo {
 /*
  * Library configuration
  */
+
+/*!
+ * @biref Library configuration options of Xen related things
+ */
 struct VscMgmtConfigXen {
        char *hvm_loader_path;
        char *bridge_device_name;
 };
 
+/*!
+ * @brief Library configuraton options for ESX related things
+ */
 struct VscMgmtConfigESX {
        char *data_store_name;
        char *vm_network_name;
        int set_cpu_reservation;
 };
 
+/*!
+ * @brief Global library configuration options
+ */
 struct VscMgmtConfig {
        /* General */
        char *image_base_dirname;