From: klu2 Date: Tue, 22 Apr 2008 05:52:01 +0000 (+0000) Subject: Fix typo in comment. X-Git-Tag: edk2-stable201903~21093 X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=commitdiff_plain;h=7459094d5f6904a0c8445d97519f4a99b654ef43;ds=sidebyside Fix typo in comment. git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5109 6f19259b-4bc3-4df7-8a09-765794883524 --- diff --git a/IntelFrameworkPkg/Include/Ppi/PciCfg.h b/IntelFrameworkPkg/Include/Ppi/PciCfg.h index 31a8b53fec..e867aeb882 100644 --- a/IntelFrameworkPkg/Include/Ppi/PciCfg.h +++ b/IntelFrameworkPkg/Include/Ppi/PciCfg.h @@ -21,6 +21,8 @@ #ifndef __PEI_PCI_CFG_H__ #define __PEI_PCI_CFG_H__ +#include + #define EFI_PEI_PCI_CFG_PPI_INSTALLED_GUID \ { \ 0xe1f2eba0, 0xf7b9, 0x4a26, {0x86, 0x20, 0x13, 0x12, 0x21, 0x64, 0x2a, 0x90 } \ @@ -82,7 +84,6 @@ EFI_STATUS ); /** - @par Ppi Description: The EFI_PEI_PCI_CFG_PPI interfaces are used to abstract accesses to PCI controllers behind a PCI root bridge controller. diff --git a/IntelFrameworkPkg/Library/DxeIoLibCpuIo/DxeCpuIoLibInternal.h b/IntelFrameworkPkg/Library/DxeIoLibCpuIo/DxeCpuIoLibInternal.h index 3f71fa6304..23ce633b1d 100644 --- a/IntelFrameworkPkg/Library/DxeIoLibCpuIo/DxeCpuIoLibInternal.h +++ b/IntelFrameworkPkg/Library/DxeIoLibCpuIo/DxeCpuIoLibInternal.h @@ -109,7 +109,8 @@ MmioReadWorker ( @param Address The MMIO register to read. The caller is responsible for aligning the Address if required. @param Width The width of the I/O operation. - + @param Data The value to write to the I/O port. + @return Data read from registers in the EFI system memory space. **/ diff --git a/IntelFrameworkPkg/Library/DxeIoLibCpuIo/IoLib.c b/IntelFrameworkPkg/Library/DxeIoLibCpuIo/IoLib.c index 808933f3fa..57a2335571 100644 --- a/IntelFrameworkPkg/Library/DxeIoLibCpuIo/IoLib.c +++ b/IntelFrameworkPkg/Library/DxeIoLibCpuIo/IoLib.c @@ -168,7 +168,8 @@ MmioReadWorker ( @param Address The MMIO register to read. The caller is responsible for aligning the Address if required. @param Width The width of the I/O operation. - + @param Data The value to write to the I/O port. + @return Data read from registers in the EFI system memory space. **/ diff --git a/IntelFrameworkPkg/Library/FrameworkHiiLib/HiiLib.c b/IntelFrameworkPkg/Library/FrameworkHiiLib/HiiLib.c index dd4cedddd9..f2edf44317 100644 --- a/IntelFrameworkPkg/Library/FrameworkHiiLib/HiiLib.c +++ b/IntelFrameworkPkg/Library/FrameworkHiiLib/HiiLib.c @@ -137,10 +137,11 @@ PreparePackages ( Then, EFI_HII_PACKAGE_LIST will be register to the default System HII Database. The Handle to the newly registered Package List is returned throught HiiHandle. - @param NumberOfPackages The number of HII packages to register. - @param GuidId Package List GUID ID. + @param NumberOfPackages The number of HII packages to register. + @param GuidId Package List GUID ID. + @param DriverHandle The pointer of driver handle @param HiiHandle The ID used to retrieve the Package List later. - @param ... The variable argument list describing all HII Package. + @param ... The variable argument list describing all HII Package. @return The allocated and initialized packages. @@ -279,7 +280,7 @@ HiiLibGetStringFromToken ( If HiiHandle could not be found in the default HII database, then ASSERT. If StringId is not found in PackageList, then ASSERT. - @param HiiHandle The HII handle of package list. + @param PackageList The HII handle of package list. @param StringId The String ID. @param String The output string. diff --git a/IntelFrameworkPkg/Library/FrameworkIfrSupportLib/IfrVariable.c b/IntelFrameworkPkg/Library/FrameworkIfrSupportLib/IfrVariable.c index 8c662b6064..5974a2640f 100644 --- a/IntelFrameworkPkg/Library/FrameworkIfrSupportLib/IfrVariable.c +++ b/IntelFrameworkPkg/Library/FrameworkIfrSupportLib/IfrVariable.c @@ -23,6 +23,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @param Pack - List of variables @param Name - Name of the variable/map @param Guid - GUID of the variable/map + @param Id - The index of the variable/map to retrieve @param Var - Pointer to the variable/map @param Size - Size of the variable/map in bytes **/ @@ -119,11 +120,12 @@ EfiLibHiiVariablePackListForEachVar ( @param List - List of variables @param Name - Name of the variable/map @param Guid - GUID of the variable/map + @param Id - Id of the variable/map @param Var - Pointer to the variable/map @param Size - Size of the variable/map in bytes - @param EFI_SUCCESS - Variable is found, OUT parameters are valid - @param EFI_NOT_FOUND - Variable is not found, OUT parameters are not valid + @return EFI_SUCCESS - Variable is found, OUT parameters are valid + @return EFI_NOT_FOUND - Variable is not found, OUT parameters are not valid **/ EFI_STATUS EfiLibHiiVariablePackListGetMapByIdx ( @@ -233,6 +235,7 @@ EfiLibHiiVariablePackListGetMapById ( @param List - List of variables @param Name - Name of the variable/map to be found @param Guid - GUID of the variable/map to be found + @param Id - Id of the variable/map to be found @param Var - Pointer to the variable/map found @param Size - Size of the variable/map in bytes found diff --git a/IntelFrameworkPkg/Library/FrameworkUefiLib/UefiLib.c b/IntelFrameworkPkg/Library/FrameworkUefiLib/UefiLib.c index 64f7cde184..143870ae9d 100644 --- a/IntelFrameworkPkg/Library/FrameworkUefiLib/UefiLib.c +++ b/IntelFrameworkPkg/Library/FrameworkUefiLib/UefiLib.c @@ -252,9 +252,7 @@ EfiNamedEventSignal ( can then immediately be restored back to the current TPL level with a call to RestoreTPL(). - @param VOID - - @retvale EFI_TPL The current TPL. + @return The current TPL. **/ EFI_TPL @@ -305,7 +303,7 @@ EfiInitializeLock ( priority level of the mutual exclusion lock. Then, it places the lock in the acquired state. - @param Priority The task priority level of the lock. + @param Lock Point to EFI_LOCK instance **/ VOID @@ -454,7 +452,7 @@ EfiTestManagedDevice ( @param ControllerHandle A handle for a (parent) controller to test. @param ChildHandle A child handle to test. - @param ConsumsedGuid Supplies the protocol that the child controller + @param ProtocolGuid Supplies the protocol that the child controller opens on its parent controller. @retval EFI_SUCCESS ChildHandle is a child of the ControllerHandle. diff --git a/IntelFrameworkPkg/Library/FrameworkUefiLib/UefiNotTiano.c b/IntelFrameworkPkg/Library/FrameworkUefiLib/UefiNotTiano.c index fbe9ef7576..067a85e719 100644 --- a/IntelFrameworkPkg/Library/FrameworkUefiLib/UefiNotTiano.c +++ b/IntelFrameworkPkg/Library/FrameworkUefiLib/UefiNotTiano.c @@ -137,7 +137,7 @@ EfiCreateEventLegacyBootEx ( the EDK/EFI 1.10 form and EDK II/UEFI 2.0 form and allows common code to work both ways. - @param LegacyBootEvent Returns the EFI event returned from gBS->CreateEvent(Ex). + @param ReadyToBootEvent Returns the EFI event returned from gBS->CreateEvent(Ex). @retval EFI_SUCCESS Event was created. @retval Other Event was not created. @@ -170,7 +170,7 @@ EfiCreateEventReadyToBoot ( @param NotifyTpl The task priority level of the event. @param NotifyFunction The notification function to call when the event is signaled. @param NotifyContext The content to pass to NotifyFunction when the event is signaled. - @param LegacyBootEvent Returns the EFI event returned from gBS->CreateEvent(Ex). + @param ReadyToBootEvent Returns the EFI event returned from gBS->CreateEvent(Ex). @retval EFI_SUCCESS Event was created. @retval Other Event was not created. diff --git a/IntelFrameworkPkg/Library/HiiLibFramework/HiiLibFramework.c b/IntelFrameworkPkg/Library/HiiLibFramework/HiiLibFramework.c index 98a69f9c47..68bc432c63 100644 --- a/IntelFrameworkPkg/Library/HiiLibFramework/HiiLibFramework.c +++ b/IntelFrameworkPkg/Library/HiiLibFramework/HiiLibFramework.c @@ -64,7 +64,8 @@ HiiLibFrameworkConstructor ( and the variable length argument list of package pointers. @param NumberOfPackages The number of HII packages to prepare. - @param Guid Package GUID. + @param Guid Package GUID. + @param Args Package contents @return The allocated and initialized packages. diff --git a/IntelFrameworkPkg/Library/PeiSmbusLibSmbusPpi/PeiSmbusLib.c b/IntelFrameworkPkg/Library/PeiSmbusLibSmbusPpi/PeiSmbusLib.c index 33d9191f95..6a9c8cd990 100644 --- a/IntelFrameworkPkg/Library/PeiSmbusLibSmbusPpi/PeiSmbusLib.c +++ b/IntelFrameworkPkg/Library/PeiSmbusLibSmbusPpi/PeiSmbusLib.c @@ -20,8 +20,6 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. This internal function retrieves Smbus PPI from PPI database. If gEfiPeiSmbusPpiGuid can not be located, then ASSERT() - @param PeiServices An indirect pointer to the EFI_PEI_SERVICES published by the PEI Foundation. - @return The pointer to Smbus PPI. **/