MdeModulePkg: Change OPTIONAL keyword usage style

REF: https://bugzilla.tianocore.org/show_bug.cgi?id=3760

Update all use of ', OPTIONAL' to ' OPTIONAL,' for function params.

Cc: Andrew Fish <afish@apple.com>
Cc: Leif Lindholm <leif@nuviainc.com>
Cc: Michael Kubacki <michael.kubacki@microsoft.com>
Signed-off-by: Michael D Kinney <michael.d.kinney@intel.com>
Reviewed-by: Liming Gao <gaoliming@byosoft.com.cn>

13 files changed, 47 insertions, 48 deletions

diff --git a/MdeModulePkg/Include/Guid/Performance.h b/MdeModulePkg/Include/Guid/Performance.h
index 9d7b3ad324..a4244b8a19 100644
--- a/MdeModulePkg/Include/Guid/Performance.h
+++ b/MdeModulePkg/Include/Guid/Performance.h
@@ -158,9 +158,9 @@ typedef struct {
 typedef

 EFI_STATUS

 (EFIAPI * PERFORMANCE_START_GAUGE)(

-  IN CONST VOID   *Handle,  OPTIONAL

-  IN CONST CHAR8  *Token,   OPTIONAL

-  IN CONST CHAR8  *Module,  OPTIONAL

+  IN CONST VOID   *Handle   OPTIONAL,

+  IN CONST CHAR8  *Token    OPTIONAL,

+  IN CONST CHAR8  *Module   OPTIONAL,

   IN UINT64       TimeStamp

   );

 

@@ -191,9 +191,9 @@ EFI_STATUS
 typedef

 EFI_STATUS

 (EFIAPI * PERFORMANCE_END_GAUGE)(

-  IN CONST VOID   *Handle,  OPTIONAL

-  IN CONST CHAR8  *Token,   OPTIONAL

-  IN CONST CHAR8  *Module,  OPTIONAL

+  IN CONST VOID   *Handle   OPTIONAL,

+  IN CONST CHAR8  *Token    OPTIONAL,

+  IN CONST CHAR8  *Module   OPTIONAL,

   IN UINT64       TimeStamp

   );

 

@@ -249,9 +249,9 @@ EFI_STATUS
 typedef

 EFI_STATUS

 (EFIAPI * PERFORMANCE_START_GAUGE_EX)(

-  IN CONST VOID   *Handle,  OPTIONAL

-  IN CONST CHAR8  *Token,   OPTIONAL

-  IN CONST CHAR8  *Module,  OPTIONAL

+  IN CONST VOID   *Handle   OPTIONAL,

+  IN CONST CHAR8  *Token    OPTIONAL,

+  IN CONST CHAR8  *Module   OPTIONAL,

   IN UINT64       TimeStamp,

   IN UINT32       Identifier

   );

@@ -285,9 +285,9 @@ EFI_STATUS
 typedef

 EFI_STATUS

 (EFIAPI * PERFORMANCE_END_GAUGE_EX)(

-  IN CONST VOID   *Handle,  OPTIONAL

-  IN CONST CHAR8  *Token,   OPTIONAL

-  IN CONST CHAR8  *Module,  OPTIONAL

+  IN CONST VOID   *Handle   OPTIONAL,

+  IN CONST CHAR8  *Token    OPTIONAL,

+  IN CONST CHAR8  *Module   OPTIONAL,

   IN UINT64       TimeStamp,

   IN UINT32       Identifier

   );

diff --git a/MdeModulePkg/Include/Guid/PerformanceMeasurement.h b/MdeModulePkg/Include/Guid/PerformanceMeasurement.h
index 016f21a86c..9c5ef7f0df 100644
--- a/MdeModulePkg/Include/Guid/PerformanceMeasurement.h
+++ b/MdeModulePkg/Include/Guid/PerformanceMeasurement.h
@@ -53,11 +53,11 @@ typedef enum {
 typedef

 EFI_STATUS

 (EFIAPI *CREATE_PERFORMANCE_MEASUREMENT)(

-  IN CONST VOID                        *CallerIdentifier, OPTIONAL

-  IN CONST VOID                        *Guid,     OPTIONAL

-  IN CONST CHAR8                       *String,   OPTIONAL

-  IN       UINT64                      TimeStamp, OPTIONAL

-  IN       UINT64                      Address,   OPTIONAL

+  IN CONST VOID                        *CallerIdentifier  OPTIONAL,

+  IN CONST VOID                        *Guid      OPTIONAL,

+  IN CONST CHAR8                       *String    OPTIONAL,

+  IN       UINT64                      TimeStamp  OPTIONAL,

+  IN       UINT64                      Address    OPTIONAL,

   IN       UINT32                      Identifier,

   IN       PERF_MEASUREMENT_ATTRIBUTE  Attribute

   );

diff --git a/MdeModulePkg/Include/Guid/SmiHandlerProfile.h b/MdeModulePkg/Include/Guid/SmiHandlerProfile.h
index ff6bddeb58..359fe93fc1 100644
--- a/MdeModulePkg/Include/Guid/SmiHandlerProfile.h
+++ b/MdeModulePkg/Include/Guid/SmiHandlerProfile.h
@@ -172,7 +172,7 @@ EFI_STATUS
   IN EFI_GUID                       *HandlerGuid,

   IN EFI_SMM_HANDLER_ENTRY_POINT2   Handler,

   IN PHYSICAL_ADDRESS               CallerAddress,

-  IN VOID                           *Context, OPTIONAL

+  IN VOID                           *Context  OPTIONAL,

   IN UINTN                          ContextSize OPTIONAL

   );

 

@@ -199,7 +199,7 @@ EFI_STATUS
   IN SMI_HANDLER_PROFILE_PROTOCOL   *This,

   IN EFI_GUID                       *HandlerGuid,

   IN EFI_SMM_HANDLER_ENTRY_POINT2   Handler,

-  IN VOID                           *Context, OPTIONAL

+  IN VOID                           *Context  OPTIONAL,

   IN UINTN                          ContextSize OPTIONAL

   );

 

diff --git a/MdeModulePkg/Include/Library/CustomizedDisplayLib.h b/MdeModulePkg/Include/Library/CustomizedDisplayLib.h
index b9ae15524a..8898350d6b 100644
--- a/MdeModulePkg/Include/Library/CustomizedDisplayLib.h
+++ b/MdeModulePkg/Include/Library/CustomizedDisplayLib.h
@@ -103,7 +103,7 @@ UpdateStatusBar (
 VOID

 EFIAPI

 CreateDialog (

-  OUT EFI_INPUT_KEY  *Key,        OPTIONAL

+  OUT EFI_INPUT_KEY  *Key         OPTIONAL,

   ...

   );

 

diff --git a/MdeModulePkg/Include/Library/DebugAgentLib.h b/MdeModulePkg/Include/Library/DebugAgentLib.h
index b0c5de39e1..262a156b76 100644
--- a/MdeModulePkg/Include/Library/DebugAgentLib.h
+++ b/MdeModulePkg/Include/Library/DebugAgentLib.h
@@ -71,7 +71,7 @@ VOID
 EFIAPI

 InitializeDebugAgent (

   IN UINT32                InitFlag,

-  IN VOID                  *Context, OPTIONAL

+  IN VOID                  *Context  OPTIONAL,

   IN DEBUG_AGENT_CONTINUE  Function  OPTIONAL

   );

 

diff --git a/MdeModulePkg/Include/Library/FileExplorerLib.h b/MdeModulePkg/Include/Library/FileExplorerLib.h
index 75523d4c84..528a3cabb6 100644
--- a/MdeModulePkg/Include/Library/FileExplorerLib.h
+++ b/MdeModulePkg/Include/Library/FileExplorerLib.h
@@ -33,8 +33,8 @@ EFI_STATUS
 EFIAPI

 ChooseFile (

   IN  EFI_DEVICE_PATH_PROTOCOL  *RootDirectory,

-  IN  CHAR16                    *FileType,  OPTIONAL

-  IN  CHOOSE_HANDLER            ChooseHandler,  OPTIONAL

+  IN  CHAR16                    *FileType   OPTIONAL,

+  IN  CHOOSE_HANDLER            ChooseHandler   OPTIONAL,

   OUT EFI_DEVICE_PATH_PROTOCOL  **File  OPTIONAL

   );

 

diff --git a/MdeModulePkg/Include/Library/FrameBufferBltLib.h b/MdeModulePkg/Include/Library/FrameBufferBltLib.h
index 689aeebf15..326cdf0473 100644
--- a/MdeModulePkg/Include/Library/FrameBufferBltLib.h
+++ b/MdeModulePkg/Include/Library/FrameBufferBltLib.h
@@ -73,7 +73,7 @@ RETURN_STATUS
 EFIAPI

 FrameBufferBlt (

   IN     FRAME_BUFFER_CONFIGURE             *Configure,

-  IN OUT EFI_GRAPHICS_OUTPUT_BLT_PIXEL      *BltBuffer, OPTIONAL

+  IN OUT EFI_GRAPHICS_OUTPUT_BLT_PIXEL      *BltBuffer  OPTIONAL,

   IN     EFI_GRAPHICS_OUTPUT_BLT_OPERATION  BltOperation,

   IN     UINTN                              SourceX,

   IN     UINTN                              SourceY,

diff --git a/MdeModulePkg/Include/Library/HiiLib.h b/MdeModulePkg/Include/Library/HiiLib.h
index cd9027fefd..5d16358412 100644
--- a/MdeModulePkg/Include/Library/HiiLib.h
+++ b/MdeModulePkg/Include/Library/HiiLib.h
@@ -117,7 +117,7 @@ EFI_STRING_ID
 EFIAPI

 HiiSetString (

   IN EFI_HII_HANDLE    HiiHandle,

-  IN EFI_STRING_ID     StringId,            OPTIONAL

+  IN EFI_STRING_ID     StringId             OPTIONAL,

   IN CONST EFI_STRING  String,

   IN CONST CHAR8       *SupportedLanguages  OPTIONAL

   )

@@ -332,8 +332,8 @@ HiiGetSupportedLanguages (
 EFI_STRING

 EFIAPI

 HiiConstructConfigHdr (

-  IN CONST EFI_GUID  *Guid,  OPTIONAL

-  IN CONST CHAR16    *Name,  OPTIONAL

+  IN CONST EFI_GUID  *Guid   OPTIONAL,

+  IN CONST CHAR16    *Name   OPTIONAL,

   IN EFI_HANDLE      DriverHandle

   );

 

@@ -356,7 +356,7 @@ HiiConstructConfigHdr (
 BOOLEAN

 EFIAPI

 HiiSetToDefaults (

-  IN CONST EFI_STRING  Request,  OPTIONAL

+  IN CONST EFI_STRING  Request   OPTIONAL,

   IN UINT16            DefaultId

   );

 

@@ -397,7 +397,7 @@ BOOLEAN
 EFIAPI

 HiiIsConfigHdrMatch (

   IN CONST EFI_STRING  ConfigHdr,

-  IN CONST EFI_GUID    *Guid,     OPTIONAL

+  IN CONST EFI_GUID    *Guid      OPTIONAL,

   IN CONST CHAR16      *Name      OPTIONAL

   );

 

@@ -419,8 +419,8 @@ HiiIsConfigHdrMatch (
 BOOLEAN

 EFIAPI

 HiiGetBrowserData (

-  IN CONST EFI_GUID  *VariableGuid,  OPTIONAL

-  IN CONST CHAR16    *VariableName,  OPTIONAL

+  IN CONST EFI_GUID  *VariableGuid   OPTIONAL,

+  IN CONST CHAR16    *VariableName   OPTIONAL,

   IN UINTN           BufferSize,

   OUT UINT8          *Buffer

   );

@@ -449,8 +449,8 @@ HiiGetBrowserData (
 BOOLEAN

 EFIAPI

 HiiSetBrowserData (

-  IN CONST EFI_GUID  *VariableGuid, OPTIONAL

-  IN CONST CHAR16    *VariableName, OPTIONAL

+  IN CONST EFI_GUID  *VariableGuid  OPTIONAL,

+  IN CONST CHAR16    *VariableName  OPTIONAL,

   IN UINTN           BufferSize,

   IN CONST UINT8     *Buffer,

   IN CONST CHAR16    *RequestElement  OPTIONAL

@@ -642,7 +642,7 @@ EFIAPI
 HiiCreateGuidOpCode (

   IN VOID            *OpCodeHandle,

   IN CONST EFI_GUID  *Guid,

-  IN CONST VOID      *GuidOpCode,    OPTIONAL

+  IN CONST VOID      *GuidOpCode     OPTIONAL,

   IN UINTN           OpCodeSize

   );

 

@@ -769,7 +769,7 @@ HiiCreateGotoExOpCode (
   IN UINT8            QuestionFlags,

   IN EFI_QUESTION_ID  QuestionId,

   IN EFI_QUESTION_ID  RefQuestionId,

-  IN EFI_GUID         *RefFormSetId,    OPTIONAL

+  IN EFI_GUID         *RefFormSetId     OPTIONAL,

   IN EFI_STRING_ID    RefDevicePath

   );

 

@@ -1029,8 +1029,8 @@ EFIAPI
 HiiCreateDateOpCode (

   IN VOID             *OpCodeHandle,

   IN EFI_QUESTION_ID  QuestionId,

-  IN EFI_VARSTORE_ID  VarStoreId,   OPTIONAL

-  IN UINT16           VarOffset,    OPTIONAL

+  IN EFI_VARSTORE_ID  VarStoreId    OPTIONAL,

+  IN UINT16           VarOffset     OPTIONAL,

   IN EFI_STRING_ID    Prompt,

   IN EFI_STRING_ID    Help,

   IN UINT8            QuestionFlags,

@@ -1068,8 +1068,8 @@ EFIAPI
 HiiCreateTimeOpCode (

   IN VOID             *OpCodeHandle,

   IN EFI_QUESTION_ID  QuestionId,

-  IN EFI_VARSTORE_ID  VarStoreId,   OPTIONAL

-  IN UINT16           VarOffset,    OPTIONAL

+  IN EFI_VARSTORE_ID  VarStoreId    OPTIONAL,

+  IN UINT16           VarOffset     OPTIONAL,

   IN EFI_STRING_ID    Prompt,

   IN EFI_STRING_ID    Help,

   IN UINT8            QuestionFlags,

@@ -1138,7 +1138,7 @@ EFI_STATUS
 EFIAPI

 HiiUpdateForm (

   IN EFI_HII_HANDLE  HiiHandle,

-  IN EFI_GUID        *FormSetGuid,        OPTIONAL

+  IN EFI_GUID        *FormSetGuid         OPTIONAL,

   IN EFI_FORM_ID     FormId,

   IN VOID            *StartOpCodeHandle,

   IN VOID            *EndOpCodeHandle     OPTIONAL

diff --git a/MdeModulePkg/Include/Library/LockBoxLib.h b/MdeModulePkg/Include/Library/LockBoxLib.h
index 9dcd715d87..cab50da527 100644
--- a/MdeModulePkg/Include/Library/LockBoxLib.h
+++ b/MdeModulePkg/Include/Library/LockBoxLib.h
@@ -117,7 +117,7 @@ RETURN_STATUS
 EFIAPI

 RestoreLockBox (

   IN  GUID                        *Guid,

-  IN  VOID                        *Buffer, OPTIONAL

+  IN  VOID                        *Buffer  OPTIONAL,

   IN  OUT UINTN                   *Length  OPTIONAL

   );

 

diff --git a/MdeModulePkg/Include/Library/OemHookStatusCodeLib.h b/MdeModulePkg/Include/Library/OemHookStatusCodeLib.h
index b13c38d2f7..9aeff52b81 100644
--- a/MdeModulePkg/Include/Library/OemHookStatusCodeLib.h
+++ b/MdeModulePkg/Include/Library/OemHookStatusCodeLib.h
@@ -65,9 +65,8 @@ OemHookStatusCodeReport (
   IN EFI_STATUS_CODE_TYPE     CodeType,

   IN EFI_STATUS_CODE_VALUE    Value,

   IN UINT32                   Instance,

-  IN EFI_GUID                 *CallerId, OPTIONAL

+  IN EFI_GUID                 *CallerId  OPTIONAL,

   IN EFI_STATUS_CODE_DATA     *Data      OPTIONAL

   );

 

 #endif // __OEM_HOOK_STATUSCODE_LIB__

-

diff --git a/MdeModulePkg/Include/Library/SecurityManagementLib.h b/MdeModulePkg/Include/Library/SecurityManagementLib.h
index 9bb29121af..8efe3117c7 100644
--- a/MdeModulePkg/Include/Library/SecurityManagementLib.h
+++ b/MdeModulePkg/Include/Library/SecurityManagementLib.h
@@ -261,7 +261,7 @@ EFIAPI
 ExecuteSecurity2Handlers (

   IN  UINT32                           AuthenticationOperation,

   IN  UINT32                           AuthenticationStatus,

-  IN  CONST EFI_DEVICE_PATH_PROTOCOL   *File, OPTIONAL

+  IN  CONST EFI_DEVICE_PATH_PROTOCOL   *File  OPTIONAL,

   IN  VOID                             *FileBuffer,

   IN  UINTN                            FileSize,

   IN  BOOLEAN                          BootPolicy

diff --git a/MdeModulePkg/Include/Library/UefiBootManagerLib.h b/MdeModulePkg/Include/Library/UefiBootManagerLib.h
index 0b69a6021d..41a4c2b498 100644
--- a/MdeModulePkg/Include/Library/UefiBootManagerLib.h
+++ b/MdeModulePkg/Include/Library/UefiBootManagerLib.h
@@ -322,7 +322,7 @@ EfiBootManagerStartHotkeyService (
 EFI_STATUS

 EFIAPI

 EfiBootManagerAddKeyOptionVariable (

-  OUT EFI_BOOT_MANAGER_KEY_OPTION *AddedOption,   OPTIONAL

+  OUT EFI_BOOT_MANAGER_KEY_OPTION *AddedOption    OPTIONAL,

   IN UINT16                       BootOptionNumber,

   IN UINT32                       Modifier,

   ...

@@ -341,7 +341,7 @@ EfiBootManagerAddKeyOptionVariable (
 EFI_STATUS

 EFIAPI

 EfiBootManagerDeleteKeyOptionVariable (

-  IN EFI_BOOT_MANAGER_KEY_OPTION *DeletedOption, OPTIONAL

+  IN EFI_BOOT_MANAGER_KEY_OPTION *DeletedOption  OPTIONAL,

   IN UINT32                      Modifier,

   ...

   );

diff --git a/MdeModulePkg/Include/Protocol/FileExplorer.h b/MdeModulePkg/Include/Protocol/FileExplorer.h
index 43f1f398f3..a6e949d688 100644
--- a/MdeModulePkg/Include/Protocol/FileExplorer.h
+++ b/MdeModulePkg/Include/Protocol/FileExplorer.h
@@ -55,8 +55,8 @@ typedef
 EFI_STATUS

 (EFIAPI   *CHOOSE_FILE) (

   IN  EFI_DEVICE_PATH_PROTOCOL  *RootDirectory,

-  IN  CHAR16                    *FileType,  OPTIONAL

-  IN  CHOOSE_HANDLER            ChooseHandler,  OPTIONAL

+  IN  CHAR16                    *FileType   OPTIONAL,

+  IN  CHOOSE_HANDLER            ChooseHandler   OPTIONAL,

   OUT EFI_DEVICE_PATH_PROTOCOL  **File  OPTIONAL

   );