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

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

diff --git a/MdePkg/Include/Protocol/HiiConfigRouting.h b/MdePkg/Include/Protocol/HiiConfigRouting.h
index 535723936c0487036efb92fd1af96ce91d1ed133..1530bb824c571538c803a1ec2b62de2ed211e7c9 100644 (file)
--- a/MdePkg/Include/Protocol/HiiConfigRouting.h
+++ b/MdePkg/Include/Protocol/HiiConfigRouting.h
@@ -25,7 +25,6 @@
 \r
 typedef struct _EFI_HII_CONFIG_ROUTING_PROTOCOL EFI_HII_CONFIG_ROUTING_PROTOCOL;\r
 \r
-\r
 /**\r
    \r
   This function allows the caller to request the current\r
@@ -79,7 +78,7 @@ typedef struct _EFI_HII_CONFIG_ROUTING_PROTOCOL EFI_HII_CONFIG_ROUTING_PROTOCOL;
                                   values corresponding to all requested\r
                                   names.\r
 \r
-  @retval EFI_OUT_OF_MEMORY       Not enough memory to store the\r
+  @retval EFI_OUT_OF_RESOURCES    Not enough memory to store the\r
                                   parts of the results that must be\r
                                   stored awaiting possible future\r
                                   protocols.\r
@@ -88,8 +87,9 @@ typedef struct _EFI_HII_CONFIG_ROUTING_PROTOCOL EFI_HII_CONFIG_ROUTING_PROTOCOL;
                                   for the Request parameter\r
                                   would result in this type of\r
                                   error. The Progress parameter\r
-                                  is set to NULL. EFI_NOT_FOUND\r
-                                  Routing data doesn't match any\r
+                                  is set to NULL. \r
+  \r
+  @retval EFI_NOT_FOUND           Routing data doesn't match any\r
                                   known driver. Progress set to\r
                                   the "G" in "GUID" of the\r
                                   routing header that doesn't\r
@@ -139,7 +139,7 @@ EFI_STATUS
                                   values corresponding to all requested\r
                                   names.\r
   \r
-  @retval EFI_OUT_OF_MEMORY       Not enough memory to store the\r
+  @retval EFI_OUT_OF_RESOURCES    Not enough memory to store the\r
                                   parts of the results that must be\r
                                   stored awaiting possible future\r
                                   protocols.\r
@@ -184,7 +184,7 @@ EFI_STATUS
   @retval EFI_SUCCESS             The results have been distributed or are\r
                                   awaiting distribution.\r
   \r
-  @retval EFI_OUT_OF_MEMORY       Not enough memory to store the\r
+  @retval EFI_OUT_OF_RESOURCES    Not enough memory to store the\r
                                   parts of the results that must be\r
                                   stored awaiting possible future\r
                                   protocols.\r
@@ -243,7 +243,7 @@ EFI_STATUS
                                   to the null terminator at the end of the\r
                                   ConfigRequest string.\r
 \r
-  @retval EFI_OUT_OF_MEMORY       Not enough memory to allocate\r
+  @retval EFI_OUT_OF_RESOURCES    Not enough memory to allocate\r
                                   Config. Progress points to the\r
                                   first character of ConfigRequest.\r
 \r
@@ -257,8 +257,8 @@ EFI_STATUS
   @retval EFI_NOT_FOUND           Target for the specified routing data\r
                                   was not found. Progress points to the\r
                                   'G' in "GUID" of the errant routing\r
-                                  data. EFI_DEVICE_ERROR Block not large\r
-                                  enough. Progress undefined.\r
+                                  data. \r
+  @retval EFI_DEVICE_ERROR                             Block not large enough. Progress undefined.\r
 \r
   @retval EFI_INVALID_PARAMETER   Encountered non <BlockName>\r
                                   formatted string. Block is\r
@@ -325,7 +325,7 @@ EFI_STATUS
 \r
   @retval EFI_SUCCESS            The request succeeded. Progress points to the null\r
                                  terminator at the end of the ConfigResp string.\r
-  @retval EFI_OUT_OF_RESOURCES   Not enough memory to allocate Config.     Progress\r
+  @retval EFI_OUT_OF_RESOURCES   Not enough memory to allocate Config. Progress\r
                                  points to the first character of ConfigResp.\r
   @retval EFI_INVALID_PARAMETER  Passing in a NULL for the ConfigResp or\r
                                  Block parameter would result in this type of\r
@@ -389,41 +389,13 @@ EFI_STATUS
   IN  CONST EFI_DEVICE_PATH_PROTOCOL           *DevicePath,  \r
   IN  CONST UINT16                             *AltCfgId,\r
   OUT EFI_STRING                               *AltCfgResp \r
-  )\r
-;\r
-\r
-/**\r
-  @par Protocol Description:   \r
-  This protocol defines the configuration routing interfaces\r
-  between external applications and the HII. There may only be one\r
-  instance of this protocol in the system.\r
-  \r
-  @param ExtractConfig\r
-  This function allows a caller to extract the current configuration for \r
-  one or more named elements from one or more drivers.\r
-\r
-  @param ExportConfig\r
-  This function allows the caller to request the current configuration for \r
-  the entirety of the current HII database and returns the data \r
-  in a null-terminated Unicode string.\r
+  );\r
 \r
-  @param RouteConfig\r
-  This function processes the results of processing forms and routes it \r
-  to the appropriate handlers or storage.\r
-\r
-  @param BlockToConfig\r
-  This helper function is to be called by drivers to map configuration data \r
-  stored in byte array ("block") formats such as UEFI Variables into current \r
-  configuration strings.\r
-\r
-  @param ConfigToBlock\r
-  This helper function is to be called by drivers to map configuration strings \r
-  to configurations stored in byte array ("block") formats such as UEFI Variables.\r
-\r
-  @param GetAltConfig\r
-  This helper function is to be called by drivers to extract portions of a larger configuration string.\r
-\r
-**/\r
+///\r
+/// This protocol defines the configuration routing interfaces\r
+/// between external applications and the HII. There may only be one\r
+/// instance of this protocol in the system.\r
+///\r
 struct _EFI_HII_CONFIG_ROUTING_PROTOCOL {\r
   EFI_HII_ROUTING_EXTRACT_CONFIG  ExtractConfig;\r
   EFI_HII_ROUTING_EXPORT_CONFIG   ExportConfig;\r