Coding style fix.

[mirror_edk2.git] / MdePkg / Include / Library / HobLib.h

diff --git a/MdePkg/Include/Library/HobLib.h b/MdePkg/Include/Library/HobLib.h
index a02246f6b0139863ba833f26d026a2e5df77fcc7..ae1fb16f8845292fb8d14868658d5e38720f2a85 100644 (file)
--- a/MdePkg/Include/Library/HobLib.h
+++ b/MdePkg/Include/Library/HobLib.h
@@ -17,9 +17,10 @@
 \r
 /**\r
   Returns the pointer to the HOB list.\r
+  ASSERT() if the HOB list returned by GetHobList() is NULL.\r
 \r
   This function returns the pointer to first HOB in the list.\r
-\r
+  \r
   @return The pointer to the HOB list.\r
 \r
 **/\r
@@ -373,15 +374,34 @@ BuildMemoryAllocationHob (
   IN EFI_MEMORY_TYPE             MemoryType\r
   );\r
 \r
+///\r
+/// Get a HOB's type from HOB header\r
+///\r
 #define GET_HOB_TYPE(Hob)     ((Hob).Header->HobType)\r
+\r
+///\r
+/// Get a HOB's length from HOB header\r
+///\r
 #define GET_HOB_LENGTH(Hob)   ((Hob).Header->HobLength)\r
+\r
+///\r
+/// Get the pointer to next HOB in HOB List\r
+///\r
 #define GET_NEXT_HOB(Hob)     ((Hob).Raw + GET_HOB_LENGTH (Hob))\r
+\r
+///\r
+/// Judge if the HOB is the end of HOB List\r
+///\r
 #define END_OF_HOB_LIST(Hob)  (GET_HOB_TYPE (Hob) == (UINT16)EFI_HOB_TYPE_END_OF_HOB_LIST)\r
 \r
-//\r
-// Get the data and data size field of GUID \r
-//\r
+///\r
+/// Get the pointer to data field of GUID HOB \r
+///\r
 #define GET_GUID_HOB_DATA(GuidHob)      ((VOID *) (((UINT8 *) &((GuidHob)->Name)) + sizeof (EFI_GUID)))\r
+\r
+///\r
+/// Get the data size of GUID HOB\r
+///\r
 #define GET_GUID_HOB_DATA_SIZE(GuidHob) (((GuidHob)->Header).HobLength - sizeof (EFI_HOB_GUID_TYPE))\r
 \r
 #endif\r