Fix function comments.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5031 6f19259b-4bc3-4df7-8a09-765794883524

7 files changed, 19 insertions, 19 deletions

diff --git a/IntelFrameworkPkg/Library/FrameworkUefiLib/Console.c b/IntelFrameworkPkg/Library/FrameworkUefiLib/Console.c
index 8baacaf8d4..67598b0b4f 100644
--- a/IntelFrameworkPkg/Library/FrameworkUefiLib/Console.c
+++ b/IntelFrameworkPkg/Library/FrameworkUefiLib/Console.c
@@ -1,5 +1,5 @@
 /** @file

-  Mde UEFI library functions.

+  The module provide methods to compute the displayed unicode width.

 

   Copyright (c) 2007, Intel Corporation<BR>

   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,

   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

 

-  Module Name:  Console.c

-

 **/

 

 #include "FrameworkUefiLib.h"

-

+  

 typedef struct {

   CHAR16  WChar;

   UINT32  Width;

diff --git a/IntelFrameworkPkg/Library/FrameworkUefiLib/FrameworkUefiLib.h b/IntelFrameworkPkg/Library/FrameworkUefiLib/FrameworkUefiLib.h
index 89d4633a48..630e892cb4 100644
--- a/IntelFrameworkPkg/Library/FrameworkUefiLib/FrameworkUefiLib.h
+++ b/IntelFrameworkPkg/Library/FrameworkUefiLib/FrameworkUefiLib.h
@@ -11,8 +11,6 @@
   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:  FrameworkUefiLib.h

-

 **/

 

 #ifndef _UEFI_LIB_FRAMEWORK_H_

diff --git a/IntelFrameworkPkg/Library/FrameworkUefiLib/UefiLib.c b/IntelFrameworkPkg/Library/FrameworkUefiLib/UefiLib.c
index af88f6353d..64f7cde184 100644
--- a/IntelFrameworkPkg/Library/FrameworkUefiLib/UefiLib.c
+++ b/IntelFrameworkPkg/Library/FrameworkUefiLib/UefiLib.c
@@ -1,5 +1,5 @@
 /** @file

-  Mde UEFI library functions.

+  Implementation of UefiLib 

 

   Copyright (c) 2006 - 2007, Intel Corporation<BR>

   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,

   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

 

-  Module Name:  UefiLib.c

-

 **/

 

 #include "FrameworkUefiLib.h"

diff --git a/IntelFrameworkPkg/Library/FrameworkUefiLib/UefiNotTiano.c b/IntelFrameworkPkg/Library/FrameworkUefiLib/UefiNotTiano.c
index f08b1ee754..fbe9ef7576 100644
--- a/IntelFrameworkPkg/Library/FrameworkUefiLib/UefiNotTiano.c
+++ b/IntelFrameworkPkg/Library/FrameworkUefiLib/UefiNotTiano.c
@@ -1,7 +1,7 @@
 /** @file

   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

   (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.

diff --git a/IntelFrameworkPkg/Library/HiiLibFramework/HiiLibFramework.c b/IntelFrameworkPkg/Library/HiiLibFramework/HiiLibFramework.c
index cf10739897..37d830375a 100644
--- a/IntelFrameworkPkg/Library/HiiLibFramework/HiiLibFramework.c
+++ b/IntelFrameworkPkg/Library/HiiLibFramework/HiiLibFramework.c
@@ -10,8 +10,6 @@
   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:  HiiLib.c

-

 **/

 

 

@@ -27,7 +25,18 @@
 

 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

 EFIAPI

 HiiLibFrameworkConstructor (

diff --git a/IntelFrameworkPkg/Library/PeiSmbusLibSmbusPpi/InternalSmbusLib.h b/IntelFrameworkPkg/Library/PeiSmbusLibSmbusPpi/InternalSmbusLib.h
index 216f806716..8b7a10a948 100644
--- a/IntelFrameworkPkg/Library/PeiSmbusLibSmbusPpi/InternalSmbusLib.h
+++ b/IntelFrameworkPkg/Library/PeiSmbusLibSmbusPpi/InternalSmbusLib.h
@@ -1,5 +1,5 @@
 /** @file

-Internal header file for Smbus library.

+  Internal header file for Smbus library.

 

 Copyright (c) 2006, Intel Corporation<BR>

 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,                     

 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             

 

-

 **/

 

 #ifndef __INTERNAL_SMBUS_LIB_H

diff --git a/IntelFrameworkPkg/Library/PeiSmbusLibSmbusPpi/PeiSmbusLib.c b/IntelFrameworkPkg/Library/PeiSmbusLibSmbusPpi/PeiSmbusLib.c
index dcae66e8bb..33d9191f95 100644
--- a/IntelFrameworkPkg/Library/PeiSmbusLibSmbusPpi/PeiSmbusLib.c
+++ b/IntelFrameworkPkg/Library/PeiSmbusLibSmbusPpi/PeiSmbusLib.c
@@ -1,5 +1,5 @@
 /** @file

-Implementation of SmBusLib class library for PEI phase.

+  Implementation of SmBusLib class library for PEI phase.

 

 Copyright (c) 2006, Intel Corporation<BR>

 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,                     

 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             

 

-

-Module Name: PeiSmbusLib.c

-

 **/

 

 #include "InternalSmbusLib.h"

@@ -21,7 +18,8 @@ Module Name: PeiSmbusLib.c
   Gets Smbus PPIs.

 

   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.