Formalize comments for Protocols and PPIs.

1. Use doxygen format for Protocol/PPI data structure
2. Remove doxygen comments for function elements in Protocol/Ppi
3. Use doxygen format for data elements in Protocol/Ppi, and add missing comments where necessary
4. PEI Services Table is also updated accordingly.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6107 6f19259b-4bc3-4df7-8a09-765794883524

1 files changed, 10 insertions, 8 deletions

diff --git a/MdePkg/Include/Protocol/SimplePointer.h b/MdePkg/Include/Protocol/SimplePointer.h
index a3b5a9da42..5d22bf6e44 100644
--- a/MdePkg/Include/Protocol/SimplePointer.h
+++ b/MdePkg/Include/Protocol/SimplePointer.h
@@ -83,14 +83,13 @@ EFI_STATUS
   IN OUT EFI_SIMPLE_POINTER_STATE         *State

   );

 

-/**  

-  @par Protocol Description:

-  The EFI_SIMPLE_POINTER_PROTOCOL provides a set of services for a pointer 

-  device that can use used as an input device from an application written 

-  to this specification. The services include the ability to reset the 

-  pointer device, retrieve get the state of the pointer device, and 

-  retrieve the capabilities of the pointer device.

-**/

+///

+/// The EFI_SIMPLE_POINTER_PROTOCOL provides a set of services for a pointer 

+/// device that can use used as an input device from an application written 

+/// to this specification. The services include the ability to reset the 

+/// pointer device, retrieve get the state of the pointer device, and 

+/// retrieve the capabilities of the pointer device.

+///

 struct _EFI_SIMPLE_POINTER_PROTOCOL {

   EFI_SIMPLE_POINTER_RESET      Reset;

   EFI_SIMPLE_POINTER_GET_STATE  GetState;

@@ -98,6 +97,9 @@ struct _EFI_SIMPLE_POINTER_PROTOCOL {
   /// Event to use with WaitForEvent() to wait for input from the pointer device.

   ///

   EFI_EVENT                     WaitForInput;

+  ///

+  /// Pointer to EFI_SIMPLE_POINTER_MODE data.

+  ///

   EFI_SIMPLE_POINTER_MODE       *Mode;

 };