Changeset 10422 in vbox for trunk/include

Timestamp:

Jul 9, 2008 1:54:32 PM (16 years ago)

Author:

vboxsync

Message:

Fixed descriptions.

File:

• trunk/include/iprt/mp.h (modified) (2 diffs)

trunk/include/iprt/mp.h

@@ -133 +133 @@
 
 /**
- * Get the current CPU speed (in Mhz) of a CPU which is currently online.
- *
- * @returns CPU speed if CPU id is valid, 0 otherwise.
+ * Get the current frequency of a CPU.
+ *
+ * The CPU must be online.
+ *
+ * @returns The frequency as MHz. 0 if the CPU is offline
+ *          or the information is not available.
+ * @param   idCpu       The identifier of the CPU.
  */
 RTDECL(uint32_t) RTMpGetCurFrequency(RTCPUID idCpu);
@@ -141 +145 @@
 
 /**
- * Get the maximum CPU speed (in Mhz) of a CPU which is currently online.
- *
- * @returns CPU speed if CPU id is valid, 0 otherwise.
+ * Get the maximum frequency of a CPU.
+ *
+ * The CPU must be online.
+ *
+ * @returns The frequency as MHz. 0 if the CPU is offline
+ *          or the information is not available.
+ * @param   idCpu       The identifier of the CPU.
  */
 RTDECL(uint32_t) RTMpGetMaxFrequency(RTCPUID idCpu);