Add doxygen style comments for functions in DxeMain.

[mirror_edk2.git] / MdeModulePkg / Core / Dxe / Hand / Notify.c

diff --git a/MdeModulePkg/Core/Dxe/Hand/Notify.c b/MdeModulePkg/Core/Dxe/Hand/Notify.c
index 8d64a5c8831b30a86fd757762ccb15511d03fc44..7ee81b984e78b965114104231373966c577318a3 100644 (file)
--- a/MdeModulePkg/Core/Dxe/Hand/Notify.c
+++ b/MdeModulePkg/Core/Dxe/Hand/Notify.c
@@ -15,23 +15,17 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 #include <DxeMain.h>\r
 \r
-VOID\r
-CoreNotifyProtocolEntry (\r
-  IN PROTOCOL_ENTRY   *ProtEntry\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
 \r
+/**\r
   Signal event for every protocol in protocol entry.\r
 \r
-Arguments:\r
-\r
-  ProtEntry     - Protocol entry\r
+  @param  ProtEntry              Protocol entry\r
 \r
-Returns:\r
-\r
---*/\r
+**/\r
+VOID\r
+CoreNotifyProtocolEntry (\r
+  IN PROTOCOL_ENTRY   *ProtEntry\r
+  )\r
 {\r
   PROTOCOL_NOTIFY     *ProtNotify;\r
   LIST_ENTRY          *Link;\r
@@ -45,31 +39,23 @@ Returns:
 }\r
 \r
 \r
+\r
+/**\r
+  Removes Protocol from the protocol list (but not the handle list).\r
+\r
+  @param  Handle                 The handle to remove protocol on. \r
+  @param  Protocol               GUID of the protocol to be moved \r
+  @param  Interface              The interface of the protocol \r
+\r
+  @return Protocol Entry\r
+\r
+**/\r
 PROTOCOL_INTERFACE *\r
 CoreRemoveInterfaceFromProtocol (\r
   IN IHANDLE        *Handle,\r
   IN EFI_GUID       *Protocol,\r
   IN VOID           *Interface\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Removes Protocol from the protocol list (but not the handle list).\r
-\r
-Arguments:\r
-\r
-  Handle -  The handle to remove protocol on.\r
-\r
-  Protocol  -  GUID of the protocol to be moved\r
-\r
-  Interface - The interface of the protocol\r
-\r
-Returns:\r
-\r
-  Protocol Entry\r
-\r
---*/\r
 {\r
   PROTOCOL_INTERFACE  *Prot;\r
   PROTOCOL_NOTIFY     *ProtNotify;\r
@@ -107,6 +93,20 @@ Returns:
 \r
 \r
 \r
+\r
+/**\r
+  Add a new protocol notification record for the request protocol.\r
+\r
+  @param  Protocol               The requested protocol to add the notify \r
+                                 registration \r
+  @param  Event                  The event to signal \r
+  @param  Registration           Returns the registration record \r
+\r
+  @retval EFI_INVALID_PARAMETER  Invalid parameter \r
+  @retval EFI_SUCCESS            Successfully returned the registration record \r
+                                 that has been added\r
+\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 CoreRegisterProtocolNotify (\r
@@ -114,28 +114,6 @@ CoreRegisterProtocolNotify (
   IN EFI_EVENT      Event,\r
   OUT  VOID           **Registration\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Add a new protocol notification record for the request protocol.\r
-\r
-Arguments:\r
-\r
-  Protocol      - The requested protocol to add the notify registration\r
-\r
-  Event         - The event to signal \r
-\r
-  Registration  - Returns the registration record\r
-\r
-\r
-Returns:\r
-\r
-  EFI_INVALID_PARAMETER       - Invalid parameter\r
-\r
-  EFI_SUCCESS                 - Successfully returned the registration record that has been added\r
-  \r
---*/\r
 {\r
   PROTOCOL_ENTRY      *ProtEntry;\r
   PROTOCOL_NOTIFY     *ProtNotify;\r
@@ -194,6 +172,21 @@ Returns:
 \r
 \r
 \r
+\r
+/**\r
+  Reinstall a protocol interface on a device handle.  The OldInterface for Protocol is replaced by the NewInterface.\r
+\r
+  @param  UserHandle             Handle on which the interface is to be \r
+                                 reinstalled \r
+  @param  Protocol               The numeric ID of the interface \r
+  @param  OldInterface           A pointer to the old interface \r
+  @param  NewInterface           A pointer to the new interface \r
+\r
+  @retval EFI_SUCCESS            The protocol interface was installed\r
+  @retval EFI_NOT_FOUND          The OldInterface on the handle was not found\r
+  @retval EFI_INVALID_PARAMETER  One of the parameters has an invalid value\r
+\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 CoreReinstallProtocolInterface (\r
@@ -202,29 +195,6 @@ CoreReinstallProtocolInterface (
   IN VOID           *OldInterface,\r
   IN VOID           *NewInterface\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Reinstall a protocol interface on a device handle.  The OldInterface for Protocol is replaced by the NewInterface.\r
-\r
-Arguments:\r
-\r
-  UserHandle    - Handle on which the interface is to be reinstalled\r
-  Protocol      - The numeric ID of the interface\r
-  OldInterface  - A pointer to the old interface\r
-  NewInterface  - A pointer to the new interface \r
-\r
-\r
-Returns:\r
-\r
-  Status code.\r
-\r
-  On EFI_SUCCESS            The protocol interface was installed\r
-  On EFI_NOT_FOUND          The OldInterface on the handle was not found\r
-  On EFI_INVALID_PARAMETER  One of the parameters has an invalid value\r
-  \r
---*/\r
 {\r
   EFI_STATUS                Status;\r
   IHANDLE                   *Handle;\r