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

diff --git a/MdePkg/Include/Protocol/GuidedSectionExtraction.h b/MdePkg/Include/Protocol/GuidedSectionExtraction.h
index 23f87545c8..adeecc043c 100644
--- a/MdePkg/Include/Protocol/GuidedSectionExtraction.h
+++ b/MdePkg/Include/Protocol/GuidedSectionExtraction.h
@@ -126,14 +126,13 @@ EFI_STATUS
 );

 

 

-/**

-  @par Protocol Description:

-  Typically, protocol interface structures are identified by associating them with a GUID. Each

-  instance of a protocol with a given GUID must have the same interface structure. While all instances

-  of the GUIDed Section Extraction Protocol must have the same interface structure, they do not all

-  have the same GUID. The GUID that is associated with an instance of the GUIDed Section

-  Extraction Protocol is used to correlate it with the GUIDed section type that it is intended to process.

-**/

+///

+/// Typically, protocol interface structures are identified by associating them with a GUID. Each

+/// instance of a protocol with a given GUID must have the same interface structure. While all instances

+/// of the GUIDed Section Extraction Protocol must have the same interface structure, they do not all

+/// have the same GUID. The GUID that is associated with an instance of the GUIDed Section

+/// Extraction Protocol is used to correlate it with the GUIDed section type that it is intended to process.

+///

 struct _EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL {

   EFI_EXTRACT_GUIDED_SECTION  ExtractSection;

 };