Fix function comments.

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

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

diff --git a/IntelFrameworkPkg/Library/FrameworkUefiLib/FrameworkUefiLib.h b/IntelFrameworkPkg/Library/FrameworkUefiLib/FrameworkUefiLib.h
index 89d4633a48452c28a78016a7342bbdc9733ecc86..630e892cb4f8098307096eea63800356de4f07c1 100644 (file)
--- 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,\r
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
-  Module Name:  FrameworkUefiLib.h\r
-\r
 **/\r
 \r
 #ifndef _UEFI_LIB_FRAMEWORK_H_\r

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

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

diff --git a/IntelFrameworkPkg/Library/HiiLibFramework/HiiLibFramework.c b/IntelFrameworkPkg/Library/HiiLibFramework/HiiLibFramework.c
index cf10739897158214aca6be31d952b873ba4cbc62..37d830375a2598bd41a992d6835898950fdf9ca7 100644 (file)
--- 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,\r
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
-  Module Name:  HiiLib.c\r
-\r
 **/\r
 \r
 \r
@@ -27,7 +25,18 @@
 \r
 EFI_HII_PROTOCOL      *gHiiProtocol = NULL;\r
 \r
+/**\r
+  The constructor function for HiiLibFramework library instance\r
+\r
+  The constructor function locates Hii protocol from protocol database.\r
+  It will ASSERT() if that operation fails and it will always return EFI_SUCCESS.\r
 \r
+  @param  ImageHandle   The firmware allocated handle for the EFI image.\r
+  @param  SystemTable   A pointer to the EFI System Table.\r
+\r
+  @retval EFI_SUCCESS   The constructor always returns EFI_SUCCESS.\r
+\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 HiiLibFrameworkConstructor (\r

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

diff --git a/IntelFrameworkPkg/Library/PeiSmbusLibSmbusPpi/PeiSmbusLib.c b/IntelFrameworkPkg/Library/PeiSmbusLibSmbusPpi/PeiSmbusLib.c
index dcae66e8bb6c8dfcc3eb2052e427030ee1b00ff4..33d9191f956a0fcb29e7c18348d335522e248360 100644 (file)
--- a/IntelFrameworkPkg/Library/PeiSmbusLibSmbusPpi/PeiSmbusLib.c
+++ b/IntelFrameworkPkg/Library/PeiSmbusLibSmbusPpi/PeiSmbusLib.c
@@ -1,5 +1,5 @@
 /** @file\r
-Implementation of SmBusLib class library for PEI phase.\r
+  Implementation of SmBusLib class library for PEI phase.\r
 \r
 Copyright (c) 2006, Intel Corporation<BR>\r
 All rights reserved. This program and the accompanying materials                          \r
@@ -10,9 +10,6 @@ http://opensource.org/licenses/bsd-license.php
 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
 \r
-\r
-Module Name: PeiSmbusLib.c\r
-\r
 **/\r
 \r
 #include "InternalSmbusLib.h"\r
@@ -21,7 +18,8 @@ Module Name: PeiSmbusLib.c
   Gets Smbus PPIs.\r
 \r
   This internal function retrieves Smbus PPI from PPI database.\r
-\r
+  If gEfiPeiSmbusPpiGuid can not be located, then ASSERT()\r
+  \r
   @param  PeiServices   An indirect pointer to the EFI_PEI_SERVICES published by the PEI Foundation.\r
 \r
   @return The pointer to Smbus PPI.\r