Correct the structure's comments to follow doxygen format.

[mirror_edk2.git] / IntelFrameworkPkg / Include / Ppi / DeviceRecoveryModule.h

diff --git a/IntelFrameworkPkg/Include/Ppi/DeviceRecoveryModule.h b/IntelFrameworkPkg/Include/Ppi/DeviceRecoveryModule.h
index 74d12595c89f64f5c69351a2cdd3e5ec492a4461..aee8d0cd46fce2b928a5de8f2de4df5a013bd21e 100644 (file)
--- a/IntelFrameworkPkg/Include/Ppi/DeviceRecoveryModule.h
+++ b/IntelFrameworkPkg/Include/Ppi/DeviceRecoveryModule.h
@@ -8,7 +8,7 @@
   module determines the internal search order, with capsule number 1 as the highest load priority and\r
   number N as the lowest priority.\r
 \r
-  Copyright (c) 2007, Intel Corporation\r
+  Copyright (c) 2007 - 2009, 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
   which accompanies this distribution.  The full text of the license may be found at\r
@@ -112,24 +112,24 @@ EFI_STATUS
   OUT VOID                                        *Buffer\r
   );\r
 \r
-/**\r
-  @par Ppi Description:\r
-  Presents a standard interface to EFI_PEI_DEVICE_RECOVERY_MODULE_PPI,\r
-  regardless of the underlying device(s).\r
-\r
-  @param GetNumberRecoveryCapsules\r
-  Returns the number of DXE capsules that were found.\r
-\r
-  @param GetRecoveryCapsuleInfo\r
-  Returns the capsule image type and the size of a given image.\r
-\r
-  @param LoadRecoveryCapsule\r
-  Loads a DXE capsule into memory\r
-\r
-**/\r
+///\r
+/// Presents a standard interface to EFI_PEI_DEVICE_RECOVERY_MODULE_PPI,\r
+/// regardless of the underlying device(s).\r
+///\r
 struct _EFI_PEI_DEVICE_RECOVERY_MODULE_PPI {\r
+  ///\r
+  /// Returns the number of DXE capsules that were found.\r
+  ///\r
   EFI_PEI_DEVICE_GET_NUMBER_RECOVERY_CAPSULE  GetNumberRecoveryCapsules;\r
+  \r
+  ///\r
+  /// Returns the capsule image type and the size of a given image.\r
+  ///\r
   EFI_PEI_DEVICE_GET_RECOVERY_CAPSULE_INFO    GetRecoveryCapsuleInfo;\r
+  \r
+  ///\r
+  /// Loads a DXE capsule into memory\r
+  ///\r
   EFI_PEI_DEVICE_LOAD_RECOVERY_CAPSULE        LoadRecoveryCapsule;\r
 };\r
 \r