Correct the structure's comments to follow doxygen format.

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

diff --git a/IntelFrameworkPkg/Include/Ppi/ReadOnlyVariable.h b/IntelFrameworkPkg/Include/Ppi/ReadOnlyVariable.h
index b757662201ba50eb33e6385f67b3ef3fab1d24de..c93ad2664723965ad4b2596711c8056df61f2d77 100644 (file)
--- a/IntelFrameworkPkg/Include/Ppi/ReadOnlyVariable.h
+++ b/IntelFrameworkPkg/Include/Ppi/ReadOnlyVariable.h
@@ -6,7 +6,7 @@
   storage; as such, a write command to certain technologies would alter the contents of the entire part,\r
   thus making the in situ PEIM execution not follow the required flow.\r
 \r
-  Copyright (c) 2006, Intel Corporation\r
+  Copyright (c) 2006 - 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
@@ -106,20 +106,12 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  @par Ppi Description:\r
   This PPI provides a lightweight, read-only variant of the full EFI\r
   variable services.\r
-\r
-  @param GetVariable\r
-  A service to ascertain a given variable name.\r
-\r
-  @param GetNextVariableName\r
-  A service to ascertain a variable based upon a given, known variable\r
-\r
 **/\r
 struct _EFI_PEI_READ_ONLY_VARIABLE_PPI {\r
-  EFI_PEI_GET_VARIABLE            PeiGetVariable;\r
-  EFI_PEI_GET_NEXT_VARIABLE_NAME  PeiGetNextVariableName;\r
+  EFI_PEI_GET_VARIABLE            PeiGetVariable;         ///< A service to ascertain a given variable name.\r
+  EFI_PEI_GET_NEXT_VARIABLE_NAME  PeiGetNextVariableName; ///< A service to ascertain a variable based upon a given, known variable\r
 };\r
 \r
 extern EFI_GUID gEfiPeiReadOnlyVariablePpiGuid;\r