Update comments for Protocol definitions to match UEFI spec.

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

diff --git a/MdePkg/Include/Protocol/ServiceBinding.h b/MdePkg/Include/Protocol/ServiceBinding.h
index c0b5e832321c733c1abf0f57abf7b38987766973..afd25efb5706356f75b668974391d1f9f0c5e0eb 100644 (file)
--- a/MdePkg/Include/Protocol/ServiceBinding.h
+++ b/MdePkg/Include/Protocol/ServiceBinding.h
@@ -18,9 +18,9 @@
 #ifndef __EFI_SERVICE_BINDING_H__\r
 #define __EFI_SERVICE_BINDING_H__\r
 \r
-//\r
-// Forward reference for pure ANSI compatability\r
-//\r
+///\r
+/// Forward reference for pure ANSI compatability\r
+///\r
 typedef struct _EFI_SERVICE_BINDING_PROTOCOL EFI_SERVICE_BINDING_PROTOCOL;\r
 \r
 /**\r
@@ -43,8 +43,7 @@ EFI_STATUS
 (EFIAPI *EFI_SERVICE_BINDING_CREATE_CHILD)(\r
   IN     EFI_SERVICE_BINDING_PROTOCOL  *This,\r
   IN OUT EFI_HANDLE                    *ChildHandle\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Destroys a child handle with a set of I/O services.\r
@@ -66,27 +65,19 @@ EFI_STATUS
 (EFIAPI *EFI_SERVICE_BINDING_DESTROY_CHILD)(\r
   IN EFI_SERVICE_BINDING_PROTOCOL          *This,\r
   IN EFI_HANDLE                            ChildHandle\r
-  )\r
-;\r
-\r
-/**  \r
-  @par Protocol Description:\r
-  The EFI_SERVICE_BINDING_PROTOCOL provides member functions to create and destroy \r
-  child handles. A driver is responsible for adding protocols to the child handle \r
-  in CreateChild() and removing protocols in DestroyChild(). It is also required \r
-  that the CreateChild() function opens the parent protocol BY_CHILD_CONTROLLER \r
-  to establish the parent-child relationship, and closes the protocol in DestroyChild().\r
-  The pseudo code for CreateChild() and DestroyChild() is provided to specify the \r
-  required behavior, not to specify the required implementation. Each consumer of \r
-  a software protocol is responsible for calling CreateChild() when it requires the \r
-  protocol and calling DestroyChild() when it is finished with that protocol.\r
-\r
-  @param CreateChild\r
-  Creates a child handle and installs a protocol.\r
-\r
-  @param DestroyChild\r
-  Destroys a child handle with a protocol installed on it.\r
-**/\r
+  );\r
+\r
+///\r
+/// The EFI_SERVICE_BINDING_PROTOCOL provides member functions to create and destroy \r
+/// child handles. A driver is responsible for adding protocols to the child handle \r
+/// in CreateChild() and removing protocols in DestroyChild(). It is also required \r
+/// that the CreateChild() function opens the parent protocol BY_CHILD_CONTROLLER \r
+/// to establish the parent-child relationship, and closes the protocol in DestroyChild().\r
+/// The pseudo code for CreateChild() and DestroyChild() is provided to specify the \r
+/// required behavior, not to specify the required implementation. Each consumer of \r
+/// a software protocol is responsible for calling CreateChild() when it requires the \r
+/// protocol and calling DestroyChild() when it is finished with that protocol.\r
+///\r
 struct _EFI_SERVICE_BINDING_PROTOCOL {\r
   EFI_SERVICE_BINDING_CREATE_CHILD         CreateChild;\r
   EFI_SERVICE_BINDING_DESTROY_CHILD        DestroyChild;\r