1
0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2025-03-07 17:28:15 +00:00

Fix apibuild.py warnings about missing comment headers

Also improve wording of some comments.
This commit is contained in:
Matthias Bolte 2011-06-15 12:32:19 +02:00
parent 64000eabed
commit 6c88f1194c

View File

@ -318,33 +318,41 @@ struct _virNodeInfo {
/** /**
* VIR_CPU_STATS_KERNEL: * VIR_CPU_STATS_KERNEL:
* *
* Macro for the cumulative CPU time which spends by kernel, * Macro for the cumulative CPU time which was spent by the kernel,
* when the node booting up.(in nanoseconds). * since the node booting up (in nanoseconds).
*/ */
#define VIR_CPU_STATS_KERNEL "kernel" #define VIR_CPU_STATS_KERNEL "kernel"
/** /**
* The cumulative CPU time which spends by user processes, * VIR_CPU_STATS_USER:
* when the node booting up.(in nanoseconds). *
* The cumulative CPU time which was spent by user processes,
* since the node booting up (in nanoseconds).
*/ */
#define VIR_CPU_STATS_USER "user" #define VIR_CPU_STATS_USER "user"
/** /**
* VIR_CPU_STATS_IDLE:
*
* The cumulative idle CPU time, * The cumulative idle CPU time,
* when the node booting up.(in nanoseconds). * since the node booting up (in nanoseconds).
*/ */
#define VIR_CPU_STATS_IDLE "idle" #define VIR_CPU_STATS_IDLE "idle"
/** /**
* VIR_CPU_STATS_IOWAIT:
*
* The cumulative I/O wait CPU time, * The cumulative I/O wait CPU time,
* when the node booting up.(in nanoseconds). * since the node booting up (in nanoseconds).
*/ */
#define VIR_CPU_STATS_IOWAIT "iowait" #define VIR_CPU_STATS_IOWAIT "iowait"
/** /**
* The CPU utilization. * VIR_CPU_STATS_UTILIZATION:
* The usage value is in percent and 100% represents all CPUs on *
* the server. * The CPU utilization of a node.
* The usage value is in percent and 100% represents all CPUs of
* the node.
*/ */
#define VIR_CPU_STATS_UTILIZATION "utilization" #define VIR_CPU_STATS_UTILIZATION "utilization"
@ -352,7 +360,7 @@ struct _virNodeInfo {
* virCPUStats: * virCPUStats:
* *
* a virNodeCPUStats is a structure filled by virNodeGetCPUStats() * a virNodeCPUStats is a structure filled by virNodeGetCPUStats()
* and providing the information for the cpu stats of the node. * providing information about the CPU stats of the node.
*/ */
typedef struct _virCPUStats virCPUStats; typedef struct _virCPUStats virCPUStats;
@ -388,7 +396,7 @@ struct _virCPUStats {
* VIR_MEMORY_STATS_FREE: * VIR_MEMORY_STATS_FREE:
* *
* Macro for the free memory of specified cell: * Macro for the free memory of specified cell:
* On linux, it includes buffer and cached memory, in case of * On Linux, it includes buffer and cached memory, in case of
* VIR_MEMORY_STATS_ALL_CELLS. * VIR_MEMORY_STATS_ALL_CELLS.
*/ */
@ -397,7 +405,7 @@ struct _virCPUStats {
/** /**
* VIR_MEMORY_STATS_BUFFERS: * VIR_MEMORY_STATS_BUFFERS:
* *
* Macro for the buffer memory: On linux, it only returns in case of * Macro for the buffer memory: On Linux, it is only returned in case of
* VIR_MEMORY_STATS_ALL_CELLS. * VIR_MEMORY_STATS_ALL_CELLS.
*/ */
@ -406,7 +414,7 @@ struct _virCPUStats {
/** /**
* VIR_MEMORY_STATS_CACHED: * VIR_MEMORY_STATS_CACHED:
* *
* Macro for the cached memory: On linux, it only returns in case of * Macro for the cached memory: On Linux, it is only returned in case of
* VIR_MEMORY_STATS_ALL_CELLS. * VIR_MEMORY_STATS_ALL_CELLS.
*/ */
@ -416,7 +424,7 @@ struct _virCPUStats {
* virMemoryStats: * virMemoryStats:
* *
* a virMemoryStats is a structure filled by virNodeGetMemoryStats() * a virMemoryStats is a structure filled by virNodeGetMemoryStats()
* and providing the information of the memory of the Node. * providing information about the memory of the node.
*/ */
typedef struct _virMemoryStats virMemoryStats; typedef struct _virMemoryStats virMemoryStats;