xnu-4570.41.2.tar.gz

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

diff --git a/iokit/IOKit/IOCommandPool.h b/iokit/IOKit/IOCommandPool.h
index 811664751a5dc4a79b02b4f3ad57ad0e532a8a47..c21455c5cbf58432402f1bdf0df81613e7e74663 100644 (file)
--- a/iokit/IOKit/IOCommandPool.h
+++ b/iokit/IOKit/IOCommandPool.h
@@ -1,23 +1,29 @@
 /*
- * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2000-2016 Apple Inc. All rights reserved.
  *
- * @APPLE_LICENSE_HEADER_START@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  * 
- * The contents of this file constitute Original Code as defined in and
- * are subject to the Apple Public Source License Version 1.1 (the
- * "License").  You may not use this file except in compliance with the
- * License.  Please obtain a copy of the License at
- * http://www.apple.com/publicsource and read it before using this file.
+ * This file contains Original Code and/or Modifications of Original Code
+ * as defined in and that are subject to the Apple Public Source License
+ * Version 2.0 (the 'License'). You may not use this file except in
+ * compliance with the License. The rights granted to you under the License
+ * may not be used to create, or enable the creation or redistribution of,
+ * unlawful or unlicensed copies of an Apple operating system, or to
+ * circumvent, violate, or enable the circumvention or violation of, any
+ * terms of an Apple operating system software license agreement.
  * 
- * This Original Code and all software distributed under the License are
- * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * Please obtain a copy of the License at
+ * http://www.opensource.apple.com/apsl/ and read it before using this file.
+ * 
+ * The Original Code and all software distributed under the License are
+ * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
- * License for the specific language governing rights and limitations
- * under the License.
+ * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
+ * Please see the License for the specific language governing rights and
+ * limitations under the License.
  * 
- * @APPLE_LICENSE_HEADER_END@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  */
 
 /*
@@ -102,7 +108,7 @@ protected:
      * Free all of this object's outstanding resources.
      */
 
-    virtual void free(void);
+    virtual void free(void) APPLE_KEXT_OVERRIDE;
     
     
 public:
@@ -112,7 +118,7 @@ public:
      * @abstract Primary initializer for an IOCommandPool object.
      * @discussion Primary initializer for an IOCommandPool.
      * Should probably use IOCommandPool::withWorkLoop() as it is easier to use.
-     * @param inWorkLoop
+     * @param workLoop
      * The workloop that this command pool should synchronize with.
      * @result Returns true if command pool was successfully initialized.
      */
@@ -170,7 +176,7 @@ public:
      * @discussion
      * The returnCommand method is used to place an object of type IOCommand
      * into the pool, whether it be the first time, or the 1000th time.
-     * @param commmand
+     * @param command
      * The command to place in the pool.
      */
     
@@ -183,10 +189,10 @@ protected:
      * @discussion
      * The gatedGetCommand method is used to serialize the extraction of a 
      * command from the pool behind a command gate, runAction-ed by getCommand.
-     * @param vCommand
+     * @param command
      * A pointer to a pointer to an IOCommand object where the returned
      * command will be stored.
-     * @param vBlock
+     * @param blockForCommand
      * A bool that indicates whether to block the request until a command
      * becomes available.
      * @result
@@ -201,7 +207,7 @@ protected:
      * @discussion
      * The gatedReturnCommand method is used to serialize the return of a 
      * command to the pool behind a command gate, runAction-ed by returnCommand.
-     * @param vCommand
+     * @param command
      * A pointer to the IOCommand object to be returned to the pool.
      * @result
      * Always returns kIOReturnSuccess if the vCommand argument is valid.