]> git.proxmox.com Git - mirror_edk2.git/commitdiff
Fix typo in comment.
authorklu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524>
Tue, 22 Apr 2008 05:16:14 +0000 (05:16 +0000)
committerklu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524>
Tue, 22 Apr 2008 05:16:14 +0000 (05:16 +0000)
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5108 6f19259b-4bc3-4df7-8a09-765794883524

MdePkg/Include/Library/BaseLib.h
MdePkg/Include/Library/PcdLib.h
MdePkg/Include/Library/ReportStatusCodeLib.h
MdePkg/Library/BaseLib/Ia32/Non-existing.c
MdePkg/Library/BaseLib/LinkedList.c
MdePkg/Library/BaseLib/String.c
MdePkg/Library/BaseMemoryLibOptDxe/MemLibInternals.h
MdePkg/Library/DxePcdLib/DxePcdLib.c

index d7c96a1a62b260c24fce8d9ab4e3ba5dae719f16..ae14cc72eab365c55126849d387666074ceb93b9 100644 (file)
@@ -632,7 +632,7 @@ StrHexToUint64 (
   @param  Source        Pointer to a Null-terminated Unicode string.
   @param  Destination   Pointer to a Null-terminated ASCII string.
 
   @param  Source        Pointer to a Null-terminated Unicode string.
   @param  Destination   Pointer to a Null-terminated ASCII string.
 
-  @reture Destination
+  @return Destination
 
 **/
 CHAR8 *
 
 **/
 CHAR8 *
@@ -1802,7 +1802,7 @@ GetPowerOfTwo64 (
   from little endian to big endian or vice versa. The byte swapped value is
   returned.
 
   from little endian to big endian or vice versa. The byte swapped value is
   returned.
 
-  @param  Operand A 16-bit unsigned value.
+  @param  Value Operand A 16-bit unsigned value.
 
   @return The byte swaped Operand.
 
 
   @return The byte swaped Operand.
 
@@ -1821,7 +1821,7 @@ SwapBytes16 (
   from little endian to big endian or vice versa. The byte swapped value is
   returned.
 
   from little endian to big endian or vice versa. The byte swapped value is
   returned.
 
-  @param  Operand A 32-bit unsigned value.
+  @param  Value Operand A 32-bit unsigned value.
 
   @return The byte swaped Operand.
 
 
   @return The byte swaped Operand.
 
@@ -1840,7 +1840,7 @@ SwapBytes32 (
   from little endian to big endian or vice versa. The byte swapped value is
   returned.
 
   from little endian to big endian or vice versa. The byte swapped value is
   returned.
 
-  @param  Operand A 64-bit unsigned value.
+  @param  Value Operand A 64-bit unsigned value.
 
   @return The byte swaped Operand.
 
 
   @return The byte swaped Operand.
 
index 2b9c76796b79050c9425957b6b7a864d3d44c3ad..8db9a0270af5a236af287d303d1b3e3200c865f3 100644 (file)
@@ -15,6 +15,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #ifndef __PCD_LIB_H__\r
 #define __PCD_LIB_H__\r
 \r
 #ifndef __PCD_LIB_H__\r
 #define __PCD_LIB_H__\r
 \r
+#include <Base.h>\r
+\r
 #define PCD_INVALID_TOKEN_NUMBER ((UINTN) 0)\r
 \r
 #define PcdToken(TokenName)                 _PCD_TOKEN_##TokenName\r
 #define PCD_INVALID_TOKEN_NUMBER ((UINTN) 0)\r
 \r
 #define PcdToken(TokenName)                 _PCD_TOKEN_##TokenName\r
@@ -126,7 +128,7 @@ LibPcdSetSku (
 /**\r
   Returns the 8-bit value for the token specified by TokenNumber. \r
 \r
 /**\r
   Returns the 8-bit value for the token specified by TokenNumber. \r
 \r
-  @param[in]  The PCD token number to retrieve a current value for.\r
+  @param[in]  TokenNumber The PCD token number to retrieve a current value for.\r
 \r
   @retval UINT8 Returns the 8-bit value for the token specified by TokenNumber. \r
 \r
 \r
   @retval UINT8 Returns the 8-bit value for the token specified by TokenNumber. \r
 \r
@@ -141,7 +143,7 @@ LibPcdGet8 (
 /**\r
   Returns the 16-bit value for the token specified by TokenNumber. \r
 \r
 /**\r
   Returns the 16-bit value for the token specified by TokenNumber. \r
 \r
-  @param[in]  The PCD token number to retrieve a current value for.\r
+  @param[in]  TokenNumber The PCD token number to retrieve a current value for.\r
 \r
   @retval UINT16 Returns the 16-bit value for the token specified by TokenNumber. \r
 \r
 \r
   @retval UINT16 Returns the 16-bit value for the token specified by TokenNumber. \r
 \r
@@ -446,9 +448,9 @@ LibPcdSet64 (
   If SizeOfValue is NULL, then ASSERT().\r
   If SizeOfValue > 0 and Buffer is NULL, then ASSERT().\r
   \r
   If SizeOfValue is NULL, then ASSERT().\r
   If SizeOfValue > 0 and Buffer is NULL, then ASSERT().\r
   \r
-  @param[in]  TokenNumber The PCD token number to set a current value for.\r
-  @param[in,out] SizeOfBuffer The size, in bytes, of Buffer.\r
-  @param[in]  Value A pointer to the buffer to set.\r
+  @param[in]      TokenNumber   The PCD token number to set a current value for.\r
+  @param[in,out]  SizeOfBuffer  The size, in bytes, of Buffer.\r
+  @param[in]      Buffer        Value A pointer to the buffer to set.\r
 \r
   @retval VOID* Return the pointer for the buffer been set.\r
 \r
 \r
   @retval VOID* Return the pointer for the buffer been set.\r
 \r
@@ -634,10 +636,10 @@ LibPcdSetExBool (
   modify the internal data in PCD database. \r
 \r
 \r
   modify the internal data in PCD database. \r
 \r
 \r
-  @param[in]  CallBackGuid The PCD token GUID being set.\r
-  @param[in]  CallBackToken The PCD token number being set.\r
-  @param[in, out]  TokenData A pointer to the token data being set.\r
-  @param[in]  TokenDataSize The size, in bytes, of the data being set.\r
+  @param[in]      CallBackGuid    The PCD token GUID being set.\r
+  @param[in]      CallBackToken   The PCD token number being set.\r
+  @param[in, out] TokenData       A pointer to the token data being set.\r
+  @param[in]      TokenDataSize   The size, in bytes, of the data being set.\r
 \r
   @retval VOID\r
 \r
 \r
   @retval VOID\r
 \r
@@ -704,10 +706,10 @@ LibPcdCancelCallback (
   token number in the token space, then 0 is returned.  If TokenNumber is not 0 and \r
   is not in the token space specified by Guid, then ASSERT().\r
 \r
   token number in the token space, then 0 is returned.  If TokenNumber is not 0 and \r
   is not in the token space specified by Guid, then ASSERT().\r
 \r
-  @param[in]  Pointer to a 128-bit unique value that designates which namespace \r
-              to set a value from.  If NULL, then the default token space is used.\r
-  @param[in]  The previous PCD token number.  If 0, then retrieves the first PCD \r
-              token number.\r
+  @param[in]  Guid        Pointer to a 128-bit unique value that designates which namespace \r
+                          to set a value from.  If NULL, then the default token space is used.\r
+  @param[in]  TokenNumber The previous PCD token number.  If 0, then retrieves the first PCD \r
+                          token number.\r
 \r
   @retval UINTN            The next valid token number.\r
 \r
 \r
   @retval UINTN            The next valid token number.\r
 \r
index 2dfa8f839b8cbe6e21daa4fe3ef4a2842c3872e9..b07b4adaa91beef5a6ed9030f681155e0a4fc4a1 100644 (file)
@@ -15,6 +15,8 @@
 #ifndef __REPORT_STATUS_CODE_LIB_H__\r
 #define __REPORT_STATUS_CODE_LIB_H__\r
 \r
 #ifndef __REPORT_STATUS_CODE_LIB_H__\r
 #define __REPORT_STATUS_CODE_LIB_H__\r
 \r
+#include <ProcessorBind.h>\r
+#include <Pi/PiMultiPhase.h>\r
 #include <Protocol/DevicePath.h>\r
 \r
 //\r
 #include <Protocol/DevicePath.h>\r
 \r
 //\r
index 3a835fb7eea0f5e9277e8b1c7f494441b68456b9..96e90de64dd0778bac47eb96979fa03c3d8346bb 100644 (file)
@@ -31,9 +31,9 @@
   specified by Context1 and Context2. Context1 and Context2 are optional and\r
   may be 0. The function EntryPoint must never return.\r
 \r
   specified by Context1 and Context2. Context1 and Context2 are optional and\r
   may be 0. The function EntryPoint must never return.\r
 \r
-  @param  Cs          The 16-bit selector to load in the CS before EntryPoint\r
-                      is called. The descriptor in the GDT that this selector\r
-                      references must be setup for 32-bit protected mode.\r
+  @param  CodeSelector  The 16-bit selector to load in the CS before EntryPoint\r
+                        is called. The descriptor in the GDT that this selector\r
+                        references must be setup for 32-bit protected mode.\r
   @param  EntryPoint  The 64-bit virtual address of the function to call with\r
                       the new stack after paging is disabled.\r
   @param  Context1    The 64-bit virtual address of the context to pass into\r
   @param  EntryPoint  The 64-bit virtual address of the function to call with\r
                       the new stack after paging is disabled.\r
   @param  Context1    The 64-bit virtual address of the context to pass into\r
index 8190ca345ccdf7340f31bc957717416d06681689..5d804109ab48f56ba1f14ba691db5194ddf2fb47 100644 (file)
@@ -89,7 +89,7 @@ IsNodeInList (
 \r
   If ListHead is NULL, then ASSERT().\r
 \r
 \r
   If ListHead is NULL, then ASSERT().\r
 \r
-  @param  ListHead  A pointer to the head node of a new doubly linked list.\r
+  @param  List  A pointer to the head node of a new doubly linked list.\r
 \r
   @return ListHead\r
 \r
 \r
   @return ListHead\r
 \r
@@ -122,7 +122,7 @@ InitializeListHead (
   of nodes in ListHead, including the ListHead node, is greater than or\r
   equal to PcdMaximumLinkedListLength, then ASSERT().\r
 \r
   of nodes in ListHead, including the ListHead node, is greater than or\r
   equal to PcdMaximumLinkedListLength, then ASSERT().\r
 \r
-  @param  ListHead  A pointer to the head node of a doubly linked list.\r
+  @param  List      A pointer to the head node of a doubly linked list.\r
   @param  Entry     A pointer to a node that is to be inserted at the beginning\r
                     of a doubly linked list.\r
 \r
   @param  Entry     A pointer to a node that is to be inserted at the beginning\r
                     of a doubly linked list.\r
 \r
@@ -162,7 +162,7 @@ InsertHeadList (
   of nodes in ListHead, including the ListHead node, is greater than or\r
   equal to PcdMaximumLinkedListLength, then ASSERT().\r
 \r
   of nodes in ListHead, including the ListHead node, is greater than or\r
   equal to PcdMaximumLinkedListLength, then ASSERT().\r
 \r
-  @param  ListHead  A pointer to the head node of a doubly linked list.\r
+  @param  List      A pointer to the head node of a doubly linked list.\r
   @param  Entry     A pointer to a node that is to be added at the end of the\r
                     doubly linked list.\r
 \r
   @param  Entry     A pointer to a node that is to be added at the end of the\r
                     doubly linked list.\r
 \r
@@ -269,7 +269,7 @@ GetNextNode (
   in List, including the List node, is greater than or equal to\r
   PcdMaximumLinkedListLength, then ASSERT().\r
 \r
   in List, including the List node, is greater than or equal to\r
   PcdMaximumLinkedListLength, then ASSERT().\r
 \r
-  @param  ListHead  A pointer to the head node of a doubly linked list.\r
+  @param  List  A pointer to the head node of a doubly linked list.\r
 \r
   @retval TRUE  The linked list is empty.\r
   @retval FALSE The linked list is not empty.\r
 \r
   @retval TRUE  The linked list is empty.\r
   @retval FALSE The linked list is not empty.\r
index 9fca9680748490729dfc19c7870ad4cb5045f61e..94471f332944a0d0bec47c9d706e1295eb134ac3 100644 (file)
@@ -1019,7 +1019,7 @@ InternalAsciiIsHexaDecimalDigitCharacter (
   @param  Source        Pointer to a Null-terminated Unicode string.\r
   @param  Destination   Pointer to a Null-terminated ASCII string.\r
 \r
   @param  Source        Pointer to a Null-terminated Unicode string.\r
   @param  Destination   Pointer to a Null-terminated ASCII string.\r
 \r
-  @reture Destination\r
+  @return Destination\r
 \r
 **/\r
 CHAR8 *\r
 \r
 **/\r
 CHAR8 *\r
@@ -1418,7 +1418,8 @@ AsciiStriCmp (
 \r
   @param  FirstString   Pointer to a Null-terminated ASCII string.\r
   @param  SecondString  Pointer to a Null-terminated ASCII string.\r
 \r
   @param  FirstString   Pointer to a Null-terminated ASCII string.\r
   @param  SecondString  Pointer to a Null-terminated ASCII string.\r
-\r
+  @param  Length        Maximum number of ASCII characters to compare.\r
+                        \r
   @retval 0   FirstString is identical to SecondString.\r
   @retval !=0 FirstString is not identical to SecondString.\r
 \r
   @retval 0   FirstString is identical to SecondString.\r
   @retval !=0 FirstString is not identical to SecondString.\r
 \r
@@ -1980,7 +1981,7 @@ AsciiStrHexToUint64 (
   @param  Source        Pointer to a Null-terminated ASCII string.\r
   @param  Destination   Pointer to a Null-terminated Unicode string.\r
 \r
   @param  Source        Pointer to a Null-terminated ASCII string.\r
   @param  Destination   Pointer to a Null-terminated Unicode string.\r
 \r
-  @reture Destination\r
+  @return Destination\r
 \r
 **/\r
 CHAR16 *\r
 \r
 **/\r
 CHAR16 *\r
index ceddbbe7a05b30419497fa9c491fcbe03993c8b4..258dd1013ac147349d3942c1ce6c6ed4f9d7e596 100644 (file)
@@ -32,9 +32,9 @@
 /**\r
   Copy Length bytes from Source to Destination.\r
 \r
 /**\r
   Copy Length bytes from Source to Destination.\r
 \r
-  @param  Destination Target of copy\r
-  @param  Source Place to copy from\r
-  @param  Length Number of bytes to copy\r
+  @param  DestinationBuffer Target of copy\r
+  @param  SourceBuffer      Place to copy from\r
+  @param  Length            Number of bytes to copy\r
 \r
   @return Destination\r
 \r
 \r
   @return Destination\r
 \r
@@ -50,9 +50,9 @@ InternalMemCopyMem (
 /**\r
   Set Buffer to Value for Size bytes.\r
 \r
 /**\r
   Set Buffer to Value for Size bytes.\r
 \r
-  @param  Buffer Memory to set.\r
-  @param  Size Number of bytes to set\r
-  @param  Value Value of the set operation.\r
+  @param  Buffer  Memory to set.\r
+  @param  Length  Number of bytes to set\r
+  @param  Value   Value of the set operation.\r
 \r
   @return Buffer\r
 \r
 \r
   @return Buffer\r
 \r
@@ -123,7 +123,7 @@ InternalMemSetMem64 (
   Set Buffer to 0 for Size bytes.\r
 \r
   @param  Buffer Memory to set.\r
   Set Buffer to 0 for Size bytes.\r
 \r
   @param  Buffer Memory to set.\r
-  @param  Size Number of bytes to set\r
+  @param  Length Number of bytes to set\r
 \r
   @return Buffer\r
 \r
 \r
   @return Buffer\r
 \r
index 98882d41664c27ff084c4c8fd8369b2b2fc0c671..10d6a20381a1a490690012b54647f2b9e5e8d83d 100644 (file)
@@ -89,7 +89,7 @@ LibPcdSetSku (
 /**\r
   Returns the 8-bit value for the token specified by TokenNumber. \r
 \r
 /**\r
   Returns the 8-bit value for the token specified by TokenNumber. \r
 \r
-  @param[in]  The PCD token number to retrieve a current value for.\r
+  @param[in]  TokenNumber   The PCD token number to retrieve a current value for.\r
 \r
   @retval UINT8 Returns the 8-bit value for the token specified by TokenNumber. \r
 \r
 \r
   @retval UINT8 Returns the 8-bit value for the token specified by TokenNumber. \r
 \r
@@ -108,7 +108,7 @@ LibPcdGet8 (
 /**\r
   Returns the 16-bit value for the token specified by TokenNumber. \r
 \r
 /**\r
   Returns the 16-bit value for the token specified by TokenNumber. \r
 \r
-  @param[in]  The PCD token number to retrieve a current value for.\r
+  @param[in]  TokenNumber   The PCD token number to retrieve a current value for.\r
 \r
   @retval UINT16 Returns the 16-bit value for the token specified by TokenNumber. \r
 \r
 \r
   @retval UINT16 Returns the 16-bit value for the token specified by TokenNumber. \r
 \r
@@ -517,9 +517,9 @@ LibPcdSet64 (
   \r
   If SizeOfValue > 0 and Buffer is NULL, then ASSERT().\r
   \r
   \r
   If SizeOfValue > 0 and Buffer is NULL, then ASSERT().\r
   \r
-  @param[in]  TokenNumber The PCD token number to set a current value for.\r
-  @param[in,out] SizeOfBuffer The size, in bytes, of Buffer.\r
-  @param[in]  Value A pointer to the buffer to set.\r
+  @param[in]      TokenNumber   The PCD token number to set a current value for.\r
+  @param[in,out]  SizeOfBuffer  The size, in bytes, of Buffer.\r
+  @param[in]      Buffer        A pointer to the buffer to set.\r
 \r
   @retval VOID* Return the pointer for the buffer been set.\r
 \r
 \r
   @retval VOID* Return the pointer for the buffer been set.\r
 \r
@@ -557,7 +557,7 @@ LibPcdSetPtr (
   to the value specified by Value.  Value is returned.\r
   \r
   @param[in]  TokenNumber The PCD token number to set a current value for.\r
   to the value specified by Value.  Value is returned.\r
   \r
   @param[in]  TokenNumber The PCD token number to set a current value for.\r
-  @param[in]  Value The boolean value to set.\r
+  @param[in]  Value       The boolean value to set.\r
 \r
   @retval BOOLEAN Return the value been set.\r
 \r
 \r
   @retval BOOLEAN Return the value been set.\r
 \r
@@ -875,10 +875,10 @@ LibPcdCancelCallback (
   token number in the token space, then 0 is returned.  If TokenNumber is not 0 and \r
   is not in the token space specified by Guid, then ASSERT().\r
 \r
   token number in the token space, then 0 is returned.  If TokenNumber is not 0 and \r
   is not in the token space specified by Guid, then ASSERT().\r
 \r
-  @param[in]  Pointer to a 128-bit unique value that designates which namespace \r
-              to set a value from.  If NULL, then the default token space is used.\r
-  @param[in]  The previous PCD token number.  If 0, then retrieves the first PCD \r
-              token number.\r
+  @param[in]  Guid        Pointer to a 128-bit unique value that designates which namespace \r
+                          to set a value from.  If NULL, then the default token space is used.\r
+  @param[in]  TokenNumber The previous PCD token number.  If 0, then retrieves the first PCD \r
+                          token number.\r
 \r
   @retval UINTN            The next valid token number.\r
 \r
 \r
   @retval UINTN            The next valid token number.\r
 \r
@@ -912,8 +912,8 @@ LibPcdGetNextToken (
 \r
 \r
   \r
 \r
 \r
   \r
-  @param[in]  Pointer to a 128-bit unique value that designates from which namespace \r
-              to start the search.\r
+  @param[in]  Guid  Pointer to a 128-bit unique value that designates from which namespace \r
+                    to start the search.\r
 \r
   @retval CONST GUID *  The next valid token namespace.\r
 \r
 \r
   @retval CONST GUID *  The next valid token namespace.\r
 \r