Update to doxygen comments.

[mirror_edk2.git] / EdkCompatibilityPkg / Compatibility / ReadOnlyVariable2ToReadOnlyVariableThunk / ReadOnlyVariable2ToReadOnlyVariableThunk.c

diff --git a/EdkCompatibilityPkg/Compatibility/ReadOnlyVariable2ToReadOnlyVariableThunk/ReadOnlyVariable2ToReadOnlyVariableThunk.c b/EdkCompatibilityPkg/Compatibility/ReadOnlyVariable2ToReadOnlyVariableThunk/ReadOnlyVariable2ToReadOnlyVariableThunk.c
index ee8156573c4c41fd8ed10eb5ec1bdbe2119f947d..d7d4df6ebc94c4d882a0834e1f76380c58a90285 100644 (file)
--- a/EdkCompatibilityPkg/Compatibility/ReadOnlyVariable2ToReadOnlyVariableThunk/ReadOnlyVariable2ToReadOnlyVariableThunk.c
+++ b/EdkCompatibilityPkg/Compatibility/ReadOnlyVariable2ToReadOnlyVariableThunk/ReadOnlyVariable2ToReadOnlyVariableThunk.c
@@ -116,6 +116,21 @@ Returns:
   return PeiServicesInstallPpi (&mPpiListVariable);\r
 }\r
 \r
+/**\r
+  Provide the read variable functionality of the variable services.\r
+\r
+  @param  PeiServices           General purpose services available to every PEIM.\r
+  @param  VariableName          The variable name\r
+  @param  VendorGuid            The vendor's GUID\r
+  @param  Attributes            Pointer to the attribute\r
+  @param  DataSize              Size of data\r
+  @param  Data                  Pointer to data\r
+\r
+  @retval EFI_SUCCESS           The interface could be successfully installed\r
+  @retval EFI_NOT_FOUND         The variable could not be discovered\r
+  @retval EFI_BUFFER_TOO_SMALL  The caller buffer is not large enough\r
+\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 PeiGetVariable (\r
@@ -126,35 +141,6 @@ PeiGetVariable (
   IN OUT    UINTN                           *DataSize,\r
   OUT       VOID                            *Data\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Provide the read variable functionality of the variable services.\r
-\r
-Arguments:\r
-\r
-  PeiServices - General purpose services available to every PEIM.\r
-\r
-  VariableName     - The variable name\r
-\r
-  VendorGuid       - The vendor's GUID\r
-\r
-  Attributes       - Pointer to the attribute\r
-\r
-  DataSize         - Size of data\r
-\r
-  Data             - Pointer to data\r
-\r
-Returns:\r
-\r
-  EFI_SUCCESS           - The interface could be successfully installed\r
-\r
-  EFI_NOT_FOUND         - The variable could not be discovered\r
-\r
-  EFI_BUFFER_TOO_SMALL  - The caller buffer is not large enough\r
-\r
---*/\r
 {\r
   EFI_STATUS                     Status;\r
   EFI_PEI_READ_ONLY_VARIABLE_PPI *ReadOnlyVariable;\r
@@ -177,6 +163,21 @@ Returns:
                              );\r
 }\r
 \r
+/**\r
+  Provide the get next variable functionality of the variable services.\r
+\r
+  @param  PeiServices           General purpose services available to every PEIM.\r
+  @param  VariabvleNameSize     The variable name's size.\r
+  @param  VariableName          A pointer to the variable's name.\r
+  @param  VariableGuid          A pointer to the EFI_GUID structure.\r
+  @param  VariableNameSize      Size of the variable name\r
+  @param  VariableName          The variable name\r
+  @param  VendorGuid            The vendor's GUID\r
+\r
+  @retval EFI_SUCCESS           The interface could be successfully installed\r
+  @retval EFI_NOT_FOUND         The variable could not be discovered\r
+\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 PeiGetNextVariableName (\r
@@ -185,32 +186,6 @@ PeiGetNextVariableName (
   IN OUT CHAR16                             *VariableName,\r
   IN OUT EFI_GUID                           *VariableGuid\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Provide the get next variable functionality of the variable services.\r
-\r
-Arguments:\r
-\r
-  PeiServices        - General purpose services available to every PEIM.\r
-  VariabvleNameSize  - The variable name's size.\r
-  VariableName       - A pointer to the variable's name.\r
-  VariableGuid       - A pointer to the EFI_GUID structure.\r
-\r
-  VariableNameSize - Size of the variable name\r
-\r
-  VariableName     - The variable name\r
-\r
-  VendorGuid       - The vendor's GUID\r
-\r
-Returns:\r
-\r
-  EFI_SUCCESS - The interface could be successfully installed\r
-\r
-  EFI_NOT_FOUND - The variable could not be discovered\r
-\r
---*/\r
 {\r
   EFI_STATUS                     Status;\r
   EFI_PEI_READ_ONLY_VARIABLE_PPI *ReadOnlyVariable;\r