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/SimpleFileSystem.h b/MdePkg/Include/Protocol/SimpleFileSystem.h
index dcc3657103..eb850be94f 100644
--- a/MdePkg/Include/Protocol/SimpleFileSystem.h
+++ b/MdePkg/Include/Protocol/SimpleFileSystem.h
@@ -314,14 +314,13 @@ EFI_STATUS
 // 

 #define EFI_FILE_REVISION   EFI_FILE_PROTOCOL_REVISION

 

-/**  

-  @par Protocol Description:

-  The EFI_FILE_PROTOCOL provides file IO access to supported file systems.

-  An EFI_FILE_PROTOCOL provides access to a file's or directory's contents, 

-  and is also a reference to a location in the directory tree of the file system 

-  in which the file resides. With any given file handle, other files may be opened 

-  relative to this file's location, yielding new file handles.

-**/

+///

+/// The EFI_FILE_PROTOCOL provides file IO access to supported file systems.

+/// An EFI_FILE_PROTOCOL provides access to a file's or directory's contents, 

+/// and is also a reference to a location in the directory tree of the file system 

+/// in which the file resides. With any given file handle, other files may be opened 

+/// relative to this file's location, yielding new file handles.

+///

 struct _EFI_FILE_PROTOCOL {

   ///

   /// The version of the EFI_FILE_PROTOCOL interface. The version specified