xnu-3789.1.32.tar.gz

[apple/xnu.git] / iokit / IOKit / IOTimerEventSource.h

diff --git a/iokit/IOKit/IOTimerEventSource.h b/iokit/IOKit/IOTimerEventSource.h
index f5accffa3f5d4f8f3a4f34b6449a568b70da3d00..538c4991b09585d452331fbba911bbad26a92702 100644 (file)
--- a/iokit/IOKit/IOTimerEventSource.h
+++ b/iokit/IOKit/IOTimerEventSource.h
@@ -1,5 +1,5 @@
 /*
 /*

- * Copyright (c) 1998-2000, 2009 Apple Inc. All rights reserved.
+ * Copyright (c) 1998-2016 Apple Inc. All rights reserved.

  *
  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  * 
  *
  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  * 


@@ -107,15 +107,13 @@ public:
 
 /*! @function timerEventSource
     @abstract Allocates and returns an initialized timer instance.
 
 /*! @function timerEventSource
     @abstract Allocates and returns an initialized timer instance.

-    @param owner
-    @param action */
+    */

     static IOTimerEventSource *
        timerEventSource(OSObject *owner, Action action = 0);
 
 /*! @function init
     @abstract Initializes the timer with an owner, and a handler to call when the timeout expires.
     static IOTimerEventSource *
        timerEventSource(OSObject *owner, Action action = 0);
 
 /*! @function init
     @abstract Initializes the timer with an owner, and a handler to call when the timeout expires.

-    @param owner 
-    @param action */
+    */

     virtual bool init(OSObject *owner, Action action = 0);
 
 /*! @function enable
     virtual bool init(OSObject *owner, Action action = 0);
 
 /*! @function enable


@@ -131,19 +129,19 @@ public:
 
 /*! @function setTimeoutTicks
     @abstract Setup a callback at after the delay in scheduler ticks.  See wakeAtTime(AbsoluteTime).
 
 /*! @function setTimeoutTicks
     @abstract Setup a callback at after the delay in scheduler ticks.  See wakeAtTime(AbsoluteTime).

-    @param interval Delay from now to wake up, in scheduler ticks, whatever that may be.
+    @param ticks Delay from now to wake up, in scheduler ticks, whatever that may be.

     @result kIOReturnSuccess if everything is fine, kIOReturnNoResources if action hasn't been declared. */
     virtual IOReturn setTimeoutTicks(UInt32 ticks);
 
 /*! @function setTimeoutMS
     @abstract Setup a callback at after the delay in milliseconds.  See wakeAtTime(AbsoluteTime).
     @result kIOReturnSuccess if everything is fine, kIOReturnNoResources if action hasn't been declared. */
     virtual IOReturn setTimeoutTicks(UInt32 ticks);
 
 /*! @function setTimeoutMS
     @abstract Setup a callback at after the delay in milliseconds.  See wakeAtTime(AbsoluteTime).

-    @param interval Delay from now to wake up, time in milliseconds.
+    @param ms Delay from now to wake up, time in milliseconds.

     @result kIOReturnSuccess if everything is fine, kIOReturnNoResources if action hasn't been declared. */
     virtual IOReturn setTimeoutMS(UInt32 ms);
 
 /*! @function setTimeoutUS
         @abstract Setup a callback at after the delay in microseconds.  See wakeAtTime(AbsoluteTime).
     @result kIOReturnSuccess if everything is fine, kIOReturnNoResources if action hasn't been declared. */
     virtual IOReturn setTimeoutMS(UInt32 ms);
 
 /*! @function setTimeoutUS
         @abstract Setup a callback at after the delay in microseconds.  See wakeAtTime(AbsoluteTime).

-    @param interval Delay from now to wake up, time in microseconds.
+    @param us Delay from now to wake up, time in microseconds.

     @result kIOReturnSuccess if everything is fine, kIOReturnNoResources if action hasn't been declared. */
     virtual IOReturn setTimeoutUS(UInt32 us);
 
     @result kIOReturnSuccess if everything is fine, kIOReturnNoResources if action hasn't been declared. */
     virtual IOReturn setTimeoutUS(UInt32 us);
 


@@ -168,19 +166,19 @@ public:
 
 /*! @function wakeAtTimeTicks
     @abstract Setup a callback at this absolute time.  See wakeAtTime(AbsoluteTime).
 
 /*! @function wakeAtTimeTicks
     @abstract Setup a callback at this absolute time.  See wakeAtTime(AbsoluteTime).

-    @param abstime Time to wake up in scheduler quantums, whatever that is?
+    @param ticks Time to wake up in scheduler quantums, whatever that is?

     @result kIOReturnSuccess if everything is fine, kIOReturnNoResources if action hasn't been declared. */
     virtual IOReturn wakeAtTimeTicks(UInt32 ticks);
 
 /*! @function wakeAtTimeMS
     @abstract Setup a callback at this absolute time.  See wakeAtTime(AbsoluteTime).
     @result kIOReturnSuccess if everything is fine, kIOReturnNoResources if action hasn't been declared. */
     virtual IOReturn wakeAtTimeTicks(UInt32 ticks);
 
 /*! @function wakeAtTimeMS
     @abstract Setup a callback at this absolute time.  See wakeAtTime(AbsoluteTime).

-    @param abstime Time to wake up in milliseconds.
+    @param ms Time to wake up in milliseconds.

     @result kIOReturnSuccess if everything is fine, kIOReturnNoResources if action hasn't been declared. */
     virtual IOReturn wakeAtTimeMS(UInt32 ms);
 
 /*! @function wakeAtTimeUS
     @abstract Setup a callback at this absolute time.  See wakeAtTime(AbsoluteTime).
     @result kIOReturnSuccess if everything is fine, kIOReturnNoResources if action hasn't been declared. */
     virtual IOReturn wakeAtTimeMS(UInt32 ms);
 
 /*! @function wakeAtTimeUS
     @abstract Setup a callback at this absolute time.  See wakeAtTime(AbsoluteTime).

-    @param abstime Time to wake up in microseconds.
+    @param us Time to wake up in microseconds.

     @result kIOReturnSuccess if everything is fine, kIOReturnNoResources if action hasn't been declared. */
     virtual IOReturn wakeAtTimeUS(UInt32 us);
 
     @result kIOReturnSuccess if everything is fine, kIOReturnNoResources if action hasn't been declared. */
     virtual IOReturn wakeAtTimeUS(UInt32 us);