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, 12 insertions, 11 deletions

diff --git a/MdePkg/Include/Protocol/AbsolutePointer.h b/MdePkg/Include/Protocol/AbsolutePointer.h
index 853ce33c9a..e281d6ca82 100644
--- a/MdePkg/Include/Protocol/AbsolutePointer.h
+++ b/MdePkg/Include/Protocol/AbsolutePointer.h
@@ -176,17 +176,15 @@ EFI_STATUS
 );

 

 

-/**

-  @par Protocol Description:

-  The EFI_ABSOLUTE_POINTER_PROTOCOL provides a set of services

-  for a pointer device that can be used as an input device from an

-  application written to this specification. The services include

-  the ability to reset the pointer device, retrieve the state of

-  the pointer device, and retrieve the capabilities of the pointer

-  device. In addition certain data items describing the device are

-  provided.

-

-**/

+///

+/// The EFI_ABSOLUTE_POINTER_PROTOCOL provides a set of services

+/// for a pointer device that can be used as an input device from an

+/// application written to this specification. The services include

+/// the ability to reset the pointer device, retrieve the state of

+/// the pointer device, and retrieve the capabilities of the pointer

+/// device. In addition certain data items describing the device are

+/// provided.

+///

 struct _EFI_ABSOLUTE_POINTER_PROTOCOL {

   EFI_ABSOLUTE_POINTER_RESET      Reset;

   EFI_ABSOLUTE_POINTER_GET_STATE  GetState;

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

   ///

   EFI_EVENT                       WaitForInput;

+  ///

+  /// Pointer to EFI_ABSOLUTE_POINTER_MODE data.

+  ///

   EFI_ABSOLUTE_POINTER_MODE       *Mode;

 };