Fix function comment to follows doxygen format.

[mirror_edk2.git] / MdeModulePkg / Core / Pei / Hob / Hob.c

diff --git a/MdeModulePkg/Core/Pei/Hob/Hob.c b/MdeModulePkg/Core/Pei/Hob/Hob.c
index c353fa5bfab045c0b30b9fc8a593015921ea5db5..aa38228bec647c9312cb3433fda6d79b66f57e07 100644 (file)
--- a/MdeModulePkg/Core/Pei/Hob/Hob.c
+++ b/MdeModulePkg/Core/Pei/Hob/Hob.c
@@ -1,5 +1,6 @@
 /** @file\r
-\r
+  This module provide Hand-Off Block manupulation.\r
+  \r
 Copyright (c) 2006, Intel Corporation                                                         \r
 All rights reserved. This program and the accompanying materials                          \r
 are licensed and made available under the terms and conditions of the BSD License         \r
@@ -9,42 +10,29 @@ 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
-Module Name:\r
+**/\r
 \r
-  Hob.c\r
+#include <PeiMain.h>\r
 \r
-Abstract:\r
+/**\r
 \r
-  EFI PEI Core HOB services\r
+  Gets the pointer to the HOB List.\r
 \r
-**/\r
 \r
-#include <PeiMain.h>\r
+  @param PeiServices                   The PEI core services table.\r
+  @param HobList                       Pointer to the HOB List.\r
+\r
+  @retval EFI_SUCCESS                  Get the pointer of HOB List\r
+  @retval EFI_NOT_AVAILABLE_YET        the HOB List is not yet published\r
+  @retval EFI_INVALID_PARAMETER        HobList is NULL (in debug mode)\r
 \r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 PeiGetHobList (\r
   IN CONST EFI_PEI_SERVICES  **PeiServices,\r
   IN OUT VOID          **HobList\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Gets the pointer to the HOB List.\r
-\r
-Arguments:\r
-\r
-  PeiServices - The PEI core services table.\r
-  HobList     - Pointer to the HOB List.\r
-\r
-Returns:\r
-\r
-  EFI_SUCCESS                 - Get the pointer of HOB List\r
-  EFI_NOT_AVAILABLE_YET       - the HOB List is not yet published\r
-  EFI_INVALID_PARAMETER       - HobList is NULL (in debug mode)\r
-            \r
---*/\r
 {\r
   PEI_CORE_INSTANCE *PrivateData;\r
 \r
@@ -68,6 +56,20 @@ Returns:
 }\r
 \r
 \r
+/**\r
+  Add a new HOB to the HOB List.\r
+\r
+  @param PeiServices     - The PEI core services table.\r
+  @param Type            - Type of the new HOB.\r
+  @param Length          - Length of the new HOB to allocate.\r
+  @param Hob             - Pointer to the new HOB.\r
+\r
+  @return  EFI_SUCCESS           Success to create hob.\r
+  @retval  EFI_INVALID_PARAMETER if Hob is NULL\r
+  @retval  EFI_NOT_AVAILABLE_YET if HobList is still not available.\r
+  @retval  EFI_OUT_OF_RESOURCES  if there is no more memory to grow the Hoblist.\r
+\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 PeiCreateHob (\r
@@ -76,27 +78,6 @@ PeiCreateHob (
   IN UINT16            Length,\r
   IN OUT VOID          **Hob\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Add a new HOB to the HOB List.\r
-\r
-Arguments:\r
-\r
-  PeiServices - The PEI core services table.\r
-  Type        - Type of the new HOB.\r
-  Length      - Length of the new HOB to allocate.\r
-  Hob         - Pointer to the new HOB.\r
-\r
-Returns:\r
-\r
-  Status  - EFI_SUCCESS\r
-          - EFI_INVALID_PARAMETER if Hob is NULL\r
-          - EFI_NOT_AVAILABLE_YET if HobList is still not available.\r
-          - EFI_OUT_OF_RESOURCES if there is no more memory to grow the Hoblist.\r
-            \r
---*/\r
 {\r
   EFI_STATUS                           Status;\r
   EFI_HOB_HANDOFF_INFO_TABLE           *HandOffHob;\r
@@ -142,29 +123,23 @@ Returns:
 }\r
 \r
 \r
+/**\r
+\r
+  Builds a Handoff Information Table HOB\r
+\r
+  @param BootMode        - Current Bootmode\r
+  @param MemoryBegin     - Start Memory Address.\r
+  @param MemoryLength    - Length of Memory.\r
+\r
+  @return EFI_SUCCESS Always success to initialize HOB.\r
+\r
+**/\r
 EFI_STATUS\r
 PeiCoreBuildHobHandoffInfoTable (\r
   IN EFI_BOOT_MODE         BootMode,\r
   IN EFI_PHYSICAL_ADDRESS  MemoryBegin,\r
   IN UINT64                MemoryLength\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Builds a Handoff Information Table HOB\r
-\r
-Arguments:\r
-\r
-  BootMode      - Current Bootmode\r
-  MemoryBegin   - Start Memory Address.\r
-  MemoryLength  - Length of Memory.\r
-\r
-Returns:\r
-\r
-  EFI_SUCCESS\r
-\r
---*/\r
 {\r
   EFI_HOB_HANDOFF_INFO_TABLE   *Hob;\r
   EFI_HOB_GENERIC_HEADER       *HobEnd;\r