From 99caac3b192bdcd42c7b199996a7ae9978ca29a9 Mon Sep 17 00:00:00 2001 From: xli24 Date: Wed, 8 Jul 2009 03:05:55 +0000 Subject: [PATCH] Add [in], [out] tag for function description. git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8792 6f19259b-4bc3-4df7-8a09-765794883524 --- .../Include/Protocol/SmmUsbDispatch.h | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/IntelFrameworkPkg/Include/Protocol/SmmUsbDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmUsbDispatch.h index b37171851b..e4cf74219c 100644 --- a/IntelFrameworkPkg/Include/Protocol/SmmUsbDispatch.h +++ b/IntelFrameworkPkg/Include/Protocol/SmmUsbDispatch.h @@ -61,8 +61,8 @@ typedef struct { /** Dispatch function for a USB SMI handler. - @param DispatchHandle Handle of this dispatch function. - @param DispatchContext Pointer to the dispatch function's context. + @param[in] DispatchHandle Handle of this dispatch function. + @param[in] DispatchContext Pointer to the dispatch function's context. The DispatchContext fields are filled in by the dispatching driver prior to invoking this dispatch function. @@ -78,15 +78,15 @@ VOID /** Register a child SMI source dispatch function with a parent SMM driver. - @param This Pointer to the EFI_SMM_USB_DISPATCH_PROTOCOL instance. - @param DispatchFunction Pointer to dispatch function to be invoked + @param[in] This Pointer to the EFI_SMM_USB_DISPATCH_PROTOCOL instance. + @param[in] DispatchFunction Pointer to dispatch function to be invoked for this SMI source. - @param DispatchContext Pointer to the dispatch function's context. + @param[in] DispatchContext Pointer to the dispatch function's context. The caller fills this context in before calling the register function to indicate to the register function the USB SMI types for which the dispatch function should be invoked. - @param DispatchHandle Handle generated by the dispatcher to track the + @param[out] DispatchHandle Handle generated by the dispatcher to track the function instance. @retval EFI_SUCCESS The dispatch function has been successfully @@ -110,8 +110,8 @@ EFI_STATUS /** Unregisters a USB service. - @param This Pointer to the EFI_SMM_USB_DISPATCH_PROTOCOL instance. - @param DispatchHandle Handle of the service to remove. + @param[in] This Pointer to the EFI_SMM_USB_DISPATCH_PROTOCOL instance. + @param[in] DispatchHandle Handle of the service to remove. @retval EFI_SUCCESS The dispatch function has been successfully unregistered and the SMI source has been disabled @@ -124,7 +124,7 @@ typedef EFI_STATUS (EFIAPI *EFI_SMM_USB_UNREGISTER)( IN EFI_SMM_USB_DISPATCH_PROTOCOL *This, - IN EFI_HANDLE DispatchHandle + IN EFI_HANDLE DispatchHandle ); /// -- 2.39.2