Reviewed the code comments in the Include/Protocol directory for typos, grammar issue...

[mirror_edk2.git] / MdePkg / Include / Protocol / Ebc.h

diff --git a/MdePkg/Include/Protocol/Ebc.h b/MdePkg/Include/Protocol/Ebc.h
index 7710b2144e086502b6e8d4e49b5c9b7262a97096..13ece4a22767b710abfeb8878919f0f4c61e52f0 100644 (file)
--- a/MdePkg/Include/Protocol/Ebc.h
+++ b/MdePkg/Include/Protocol/Ebc.h
@@ -20,29 +20,29 @@
     0x13AC6DD1, 0x73D0, 0x11D4, {0xB0, 0x6B, 0x00, 0xAA, 0x00, 0xBD, 0x6D, 0xE7 } \\r
   }\r
 \r
-//\r
-// Protocol Guid Name defined in spec.\r
-//\r
+///\r
+/// Protocol Guid Name defined in spec.\r
+///\r
 #define EFI_EBC_PROTOCOL_GUID EFI_EBC_INTERPRETER_PROTOCOL_GUID\r
 \r
-//\r
-// Define for forward reference.\r
-//\r
+///\r
+/// Define for forward reference.\r
+///\r
 typedef struct _EFI_EBC_PROTOCOL EFI_EBC_PROTOCOL;\r
 \r
 /**\r
   Creates a thunk for an EBC entry point, returning the address of the thunk.\r
   \r
   A PE32+ EBC image, like any other PE32+ image, contains an optional header that specifies the\r
-  entry point for image execution. However for EBC images this is the entry point of EBC\r
-  instructions, so is not directly executable by the native processor. Therefore when an EBC image is\r
-  loaded, the loader must call this service to get a pointer to native code (thunk) that can be executed\r
+  entry point for image execution. However, for EBC images, this is the entry point of EBC\r
+  instructions, so is not directly executable by the native processor. Therefore, when an EBC image is\r
+  loaded, the loader must call this service to get a pointer to native code (thunk) that can be executed,\r
   which will invoke the interpreter to begin execution at the original EBC entry point.\r
 \r
   @param  This          A pointer to the EFI_EBC_PROTOCOL instance.\r
   @param  ImageHandle   Handle of image for which the thunk is being created.\r
   @param  EbcEntryPoint Address of the actual EBC entry point or protocol service the thunk should call.\r
-  @param  Thunk         Returned pointer to a thunk created.\r
+  @param  Thunk         Returned pointer to a created thunk.\r
 \r
   @retval EFI_SUCCESS            The function completed successfully.\r
   @retval EFI_INVALID_PARAMETER  Image entry point is not 2-byte aligned.\r
@@ -96,9 +96,8 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  This routine is called by the core firmware to provide the EBC driver with\r
-  a function to call to flush the CPU's instruction cache following creation\r
-  of a thunk. It is not required.\r
+  Registers a callback function that the EBC interpreter calls to flush \r
+  the processor instruction cache following creation of thunks.\r
 \r
   @param  This       A pointer to the EFI_EBC_PROTOCOL instance.\r
   @param  Flush      Pointer to a function of type EBC_ICACH_FLUSH.\r
@@ -120,7 +119,7 @@ EFI_STATUS
   returned version is identical to that returned by the EBC BREAK 1 instruction.\r
 \r
   @param  This       A pointer to the EFI_EBC_PROTOCOL instance.  \r
-  @param  Version Pointer to where to store the returned version of the interpreter.\r
+  @param  Version       Pointer to the location to store the returned version of the interpreter.\r
 \r
   @retval EFI_SUCCESS            The function completed successfully.\r
   @retval EFI_INVALID_PARAMETER  Version pointer is NULL.\r
@@ -133,34 +132,12 @@ EFI_STATUS
   IN OUT UINT64                 *Version\r
   );\r
 \r
-//\r
-// Prototype for the actual EBC protocol interface\r
-//\r
-/**\r
-  This protocol provides the services that allow execution of EBC images.\r
-\r
-  @par Protocol Description:\r
-  The EFI EBC protocol provides services to load and execute EBC images, which will typically be\r
-  loaded into option ROMs. The image loader will load the EBC image, perform standard relocations,\r
-  and invoke the CreateThunk() service to create a thunk for the EBC image's entry point. The\r
-  image can then be run using the standard EFI start image services.\r
-\r
-  @param CreateThunk \r
-  Creates a thunk for an EBC image entry point or protocol service,\r
-  and returns a pointer to the thunk. \r
-  \r
-  @param UnloadImage \r
-  Called when an EBC image is unloaded to allow the interpreter to\r
-  perform any cleanup associated with the image execution. \r
-  \r
-  @param RegisterICacheFlush\r
-  Called to register a callback function that the EBC interpreter can\r
-  call to flush the processor instruction cache after creating thunks.\r
-  \r
-  @param GetVersion \r
-  Called to get the version of the associated EBC interpreter.\r
-\r
-**/\r
+///\r
+/// The EFI EBC protocol provides services to load and execute EBC images, which will typically be\r
+/// loaded into option ROMs. The image loader will load the EBC image, perform standard relocations,\r
+/// and invoke the CreateThunk() service to create a thunk for the EBC image's entry point. The\r
+/// image can then be run using the standard EFI start image services.\r
+///\r
 struct _EFI_EBC_PROTOCOL {\r
   EFI_EBC_CREATE_THUNK          CreateThunk;\r
   EFI_EBC_UNLOAD_IMAGE          UnloadImage;\r