UsbDkHelper: Beautify hider API documentation

Signed-off-by: Dmitry Fleytman <[email protected]>
xiayibing · Mar 22, 2015 · 142d173 · 142d173
1 parent 9075137
commit 142d173
Showing 1 changed file with 9 additions and 5 deletions.
diff --git a/UsbDkHelper/UsbDkHelperHider.h b/UsbDkHelper/UsbDkHelperHider.h
@@ -59,28 +59,32 @@ extern "C" {
     */
     DLL HANDLE           UsbDk_CreateHiderHandle(void);
 
-   /* Add a rule to determine which USB devices
-    * to be hidden when plugged in, a rule contains:
+    /* Add rule for detaching USB devices from OS stack.
+    *  The rule consists of:
     *
     * class, vendor, product, version, allow
     *
     * Use -1 for @class/@vendor/@product/@version to accept any value.
     *
     * @params
     *    IN  - HiderHandle  Handle to UsbDk driver
-             - rule - pointer to hiding rule
+             - Rule - pointer to hide rule
     *    OUT - None
     *
     * @return
     *  TRUE if function succeeds
     *
+    * @note
+    * Hide rule stays until HiderHandle is closed, client process exits or
+    * UsbDk_ClearHideRules() called
+    *
     */
     DLL BOOL             UsbDk_AddHideRule(HANDLE HiderHandle, PUSB_DK_HIDE_RULE Rule);
 
     /* Clear all hider rules
     *
     * @params
-    *    IN  -  HiderHandle  Handle to UsbDk driver
+    *    IN  - HiderHandle  Handle to UsbDk driver
     *    OUT - None
     *
     * @return
@@ -92,7 +96,7 @@ extern "C" {
     /* Close Handle to UsbDk hider interface
     *
     * @params
-    *    IN  -  HiderHandle  Handle to UsbDk driver
+    *    IN  - HiderHandle  Handle to UsbDk driver
     *    OUT - None
     *
     * @return