From ac9868ecb859e877a665d1cead72d49dba0db674 Mon Sep 17 00:00:00 2001 From: jljusten Date: Thu, 2 Jul 2009 00:47:58 +0000 Subject: Update comments for coding style. git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8711 6f19259b-4bc3-4df7-8a09-765794883524 --- .../Include/Protocol/SmmPowerButtonDispatch.h | 95 ++++++++++------------ 1 file changed, 45 insertions(+), 50 deletions(-) (limited to 'IntelFrameworkPkg/Include/Protocol/SmmPowerButtonDispatch.h') diff --git a/IntelFrameworkPkg/Include/Protocol/SmmPowerButtonDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmPowerButtonDispatch.h index 95a6d51..c17bb44 100644 --- a/IntelFrameworkPkg/Include/Protocol/SmmPowerButtonDispatch.h +++ b/IntelFrameworkPkg/Include/Protocol/SmmPowerButtonDispatch.h @@ -1,21 +1,19 @@ /** @file Provides the parent dispatch service for the power button SMI source generator. - Copyright (c) 2007, Intel Corporation - All rights reserved. This program and the accompanying materials - are licensed and made available under the terms and conditions of the BSD License - which accompanies this distribution. The full text of the license may be found at - http://opensource.org/licenses/bsd-license.php - - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. - - Module Name: SmmPowerButtonDispatch.h - @par Revision Reference: This Protocol is defined in Framework of EFI SMM Core Interface Spec Version 0.9. +Copyright (c) 2007, Intel Corporation +All rights reserved. This program and the accompanying materials +are licensed and made available under the terms and conditions of the BSD License +which accompanies this distribution. The full text of the license may be found at +http://opensource.org/licenses/bsd-license.php + +THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + **/ #ifndef _EFI_SMM_POWER_BUTTON_DISPATCH_H_ @@ -56,13 +54,11 @@ typedef struct { /** Dispatch function for a Power Button SMI handler. - @param DispatchHandle Handle of this dispatch function. - @param DispatchContext Pointer to the dispatch function's context. - The DispatchContext fields are filled in - by the dispatching driver prior to - invoking this dispatch function. - - @return None + @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. **/ typedef @@ -75,22 +71,22 @@ VOID /** Provides the parent dispatch service for a given SMI source generator - @param This Pointer to the EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL instance. - @param DispatchFunction Function to install. - @param 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 Power Button SMI phase for which the dispatch - function should be invoked. - @param DispatchHandle Handle generated by the dispatcher to track the function instance. - - @retval EFI_SUCCESS The dispatch function has been successfully - registered and the SMI source has been enabled. - @retval EFI_DEVICE_ERROR The driver was unable to enable the SMI source. - @retval EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this - child. - @retval EFI_INVALID_PARAMETER DispatchContext is invalid. The Power Button SMI - phase is not within valid range. + @param[in] This Pointer to the EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL instance. + @param[in] DispatchFunction Function to install. + @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 Power Button SMI phase for which the dispatch + function should be invoked. + @param[out] DispatchHandle Handle generated by the dispatcher to track the function instance. + + @retval EFI_SUCCESS The dispatch function has been successfully + registered and the SMI source has been enabled. + @retval EFI_DEVICE_ERROR The driver was unable to enable the SMI source. + @retval EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this + child. + @retval EFI_INVALID_PARAMETER DispatchContext is invalid. The Power Button SMI + phase is not within valid range. **/ typedef @@ -105,14 +101,15 @@ EFI_STATUS /** Unregisters a power-button service. - @param This Pointer to the EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL instance. - @param DispatchHandle Handle of the service to remove. + @param[in] This Pointer to the EFI_SMM_POWER_BUTTON_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 - if there are no other registered child dispatch - functions for this SMI source. - @retval EFI_INVALID_PARAMETER Handle is invalid. + @retval EFI_SUCCESS The dispatch function has been successfully + unregistered and the SMI source has been + disabled if there are no other registered + child dispatch functions for this SMI + source. + @retval EFI_INVALID_PARAMETER Handle is invalid. **/ typedef @@ -122,22 +119,20 @@ EFI_STATUS IN EFI_HANDLE DispatchHandle ); -// -// Interface structure for the SMM Power Button SMI Dispatch Protocol -// /** @par Protocol Description: Provides the parent dispatch service for the SMM power button SMI source generator. - @param Register - Installs a child service to be dispatched by this protocol. - - @param UnRegister - Removes a child service dispatched by this protocol. - **/ struct _EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL { + /// + /// Installs a child service to be dispatched by this protocol. + /// EFI_SMM_POWER_BUTTON_REGISTER Register; + + /// + /// Removes a child service dispatched by this protocol. + /// EFI_SMM_POWER_BUTTON_UNREGISTER UnRegister; }; -- cgit v1.1