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

diff --git a/MdePkg/Include/Protocol/Bds.h b/MdePkg/Include/Protocol/Bds.h
index 0dca932245..d9ef2fd803 100644
--- a/MdePkg/Include/Protocol/Bds.h
+++ b/MdePkg/Include/Protocol/Bds.h
@@ -55,18 +55,14 @@ VOID
   IN EFI_BDS_ARCH_PROTOCOL  *This

   );

 

-/**

-  Interface stucture for the BDS Architectural Protocol.

-

-  @par Protocol Description:

-  The EFI_BDS_ARCH_PROTOCOL transfers control from DXE to an operating 

-  system or a system utility.  If there are not enough drivers initialized 

-  when this protocol is used to access the required boot device(s), then 

-  this protocol should add drivers to the dispatch queue and return control 

-  back to the dispatcher.  Once the required boot devices are available, then 

-  the boot device can be used to load and invoke an OS or a system utility.

-

-**/

+///

+/// The EFI_BDS_ARCH_PROTOCOL transfers control from DXE to an operating 

+/// system or a system utility.  If there are not enough drivers initialized 

+/// when this protocol is used to access the required boot device(s), then 

+/// this protocol should add drivers to the dispatch queue and return control 

+/// back to the dispatcher.  Once the required boot devices are available, then 

+/// the boot device can be used to load and invoke an OS or a system utility.

+///

 struct _EFI_BDS_ARCH_PROTOCOL {

   EFI_BDS_ENTRY Entry;

 };