1. added functions header for BaseUefiDecompressLi

[mirror_edk2.git] / MdePkg / Library / BaseLib / LinkedList.c

diff --git a/MdePkg/Library/BaseLib/LinkedList.c b/MdePkg/Library/BaseLib/LinkedList.c
index 15ceb584db1634db79e5ab2357e9479fb6ef78ea..6c083ef95cf18c7c9e3b281e0beab2d1b73f1e8f 100644 (file)
--- a/MdePkg/Library/BaseLib/LinkedList.c
+++ b/MdePkg/Library/BaseLib/LinkedList.c
@@ -14,6 +14,27 @@
 \r
 **/\r
 \r
+/**\r
+  Worker function that locates the Node in the List \r
+\r
+  By searching the List, finds the location of the Node in List. At the same time, \r
+  verifies the validity of this list.\r
+\r
+  If List is NULL, then ASSERT().\r
+  If List->ForwardLink is NULL, then ASSERT().\r
+  If List->backLink is NULL, then ASSERT().\r
+  If Node is NULL, then ASSERT();\r
+  If PcdMaximumLinkedListLenth is not zero, and prior to insertion the number\r
+  of nodes in ListHead, including the ListHead node, is greater than or \r
+  equal to PcdMaximumLinkedListLength, then ASSERT().\r
+\r
+  @param  List  A pointer to a node in a linked list.\r
+  @param  Node  A pointer to one nod.\r
+\r
+  @retval TRUE   Node is in List\r
+  @retval FALSE  Node isn't in List, or List is invalid \r
+\r
+**/\r
 BOOLEAN\r
 EFIAPI\r
 IsNodeInList (\r