Fix function comments.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5031 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
klu2
2008-04-09 09:07:37 +00:00
parent ffa5008abb
commit b2cefd7c90
7 changed files with 19 additions and 19 deletions

View File

@ -1,5 +1,5 @@
/** @file /** @file
Mde UEFI library functions. The module provide methods to compute the displayed unicode width.
Copyright (c) 2007, Intel Corporation<BR> Copyright (c) 2007, Intel Corporation<BR>
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
@ -10,12 +10,10 @@
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Module Name: Console.c
**/ **/
#include "FrameworkUefiLib.h" #include "FrameworkUefiLib.h"
typedef struct { typedef struct {
CHAR16 WChar; CHAR16 WChar;
UINT32 Width; UINT32 Width;

View File

@ -11,8 +11,6 @@
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Module Name: FrameworkUefiLib.h
**/ **/
#ifndef _UEFI_LIB_FRAMEWORK_H_ #ifndef _UEFI_LIB_FRAMEWORK_H_

View File

@ -1,5 +1,5 @@
/** @file /** @file
Mde UEFI library functions. Implementation of UefiLib
Copyright (c) 2006 - 2007, Intel Corporation<BR> Copyright (c) 2006 - 2007, Intel Corporation<BR>
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
@ -10,8 +10,6 @@
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Module Name: UefiLib.c
**/ **/
#include "FrameworkUefiLib.h" #include "FrameworkUefiLib.h"

View File

@ -1,7 +1,7 @@
/** @file /** @file
Library functions that abstract areas of conflict between Tiano an UEFI 2.1. Library functions that abstract areas of conflict between Tiano an UEFI 2.1.
Help Port Framework/Tinao code that has conflicts with UEFI 2.1 by hiding the Help Port Framework/Tiano code that has conflicts with UEFI 2.1 by hiding the
oldconflicts with library functions and supporting implementations of the old oldconflicts with library functions and supporting implementations of the old
(EDK/EFI 1.10) and new (EDK II/UEFI 2.1) way. This module is a DXE driver as (EDK/EFI 1.10) and new (EDK II/UEFI 2.1) way. This module is a DXE driver as
it contains DXE enum extensions for EFI event services. it contains DXE enum extensions for EFI event services.

View File

@ -10,8 +10,6 @@
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Module Name: HiiLib.c
**/ **/
@ -27,7 +25,18 @@
EFI_HII_PROTOCOL *gHiiProtocol = NULL; EFI_HII_PROTOCOL *gHiiProtocol = NULL;
/**
The constructor function for HiiLibFramework library instance
The constructor function locates Hii protocol from protocol database.
It will ASSERT() if that operation fails and it will always return EFI_SUCCESS.
@param ImageHandle The firmware allocated handle for the EFI image.
@param SystemTable A pointer to the EFI System Table.
@retval EFI_SUCCESS The constructor always returns EFI_SUCCESS.
**/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
HiiLibFrameworkConstructor ( HiiLibFrameworkConstructor (

View File

@ -1,5 +1,5 @@
/** @file /** @file
Internal header file for Smbus library. Internal header file for Smbus library.
Copyright (c) 2006, Intel Corporation<BR> Copyright (c) 2006, Intel Corporation<BR>
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
@ -10,7 +10,6 @@ http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/ **/
#ifndef __INTERNAL_SMBUS_LIB_H #ifndef __INTERNAL_SMBUS_LIB_H

View File

@ -1,5 +1,5 @@
/** @file /** @file
Implementation of SmBusLib class library for PEI phase. Implementation of SmBusLib class library for PEI phase.
Copyright (c) 2006, Intel Corporation<BR> Copyright (c) 2006, Intel Corporation<BR>
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
@ -10,9 +10,6 @@ http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Module Name: PeiSmbusLib.c
**/ **/
#include "InternalSmbusLib.h" #include "InternalSmbusLib.h"
@ -21,7 +18,8 @@ Module Name: PeiSmbusLib.c
Gets Smbus PPIs. Gets Smbus PPIs.
This internal function retrieves Smbus PPI from PPI database. 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. @param PeiServices An indirect pointer to the EFI_PEI_SERVICES published by the PEI Foundation.
@return The pointer to Smbus PPI. @return The pointer to Smbus PPI.