Add comments and DoxyGen format for these files.

[mirror_edk2.git] / MdeModulePkg / Include / Protocol / FvbExtension.h

diff --git a/MdeModulePkg/Include/Protocol/FvbExtension.h b/MdeModulePkg/Include/Protocol/FvbExtension.h
index 8a85d3d905562b73b7edcdb1e2e66fe5f3c866e2..e961057f91e64fb7c6f07f46424db1b8460fc998 100644 (file)
--- a/MdeModulePkg/Include/Protocol/FvbExtension.h
+++ b/MdeModulePkg/Include/Protocol/FvbExtension.h
@@ -1,6 +1,8 @@
-/*++\r
+/** @file\r
 \r
-Copyright (c) 2006 - 2007, Intel Corporation\r
+  FVB Extension protocol that extends the FVB Class in a component fashion.\r
+\r
+Copyright (c) 2006 - 2008, 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
@@ -9,15 +11,7 @@ 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
-    FvbExtension.h\r
-\r
-Abstract:\r
-\r
-  FVB Extension protocol that extends the FVB Class in a component fashion.\r
-\r
---*/\r
+**/\r
 \r
 #ifndef __FVB_EXTENSION_H__\r
 #define __FVB_EXTENSION_H__\r
@@ -30,6 +24,21 @@ typedef struct _EFI_FVB_EXTENSION_PROTOCOL EFI_FVB_EXTENSION_PROTOCOL;
 //\r
 //  FVB Extension Function Prototypes\r
 //\r
+/**
+  Erases and initializes a specified range of a firmware volume\r
+
+  @param[in]     This           Pointer to the FVB Extension protocol instance
+  @param[in]     StartLba       The starting logical block index to be erased
+  @param[in]     OffsetStartLba Offset into the starting block at which to \r
+                                begin erasing    
+  @param[in]     LastLba        The last logical block index to be erased
+  @param[in]     OffsetLastLba  Offset into the last block at which to end erasing     
+
+  @retval   EFI_EFI_SUCCESS        Range was erased 
+  @retval   EFI_INVALID_PARAMETER  invalid parameter
+  @retval   EFI_UNSUPPORTED        Range can not be erased\r
+
+**/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI * EFI_FV_ERASE_CUSTOM_BLOCK) (\r
@@ -41,7 +50,7 @@ EFI_STATUS
 );\r
 \r
 //\r
-// IPMI TRANSPORT PROTOCOL\r
+// FVB Extension PROTOCOL\r
 //\r
 struct _EFI_FVB_EXTENSION_PROTOCOL {\r
   EFI_FV_ERASE_CUSTOM_BLOCK               EraseFvbCustomBlock;\r