diff options
| author | xli24 <xli24@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-10-13 02:54:29 +0000 |
|---|---|---|
| committer | xli24 <xli24@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-10-13 02:54:29 +0000 |
| commit | 44717a398fddc4df1f4aeaa70bcd7a043187ed34 (patch) | |
| tree | b41f68d9d59c300d71efeeba5a12acc1bbcfb593 /MdePkg/Include/Protocol/BlockIo.h | |
| parent | 66eebcf94f14a0888a09f6fe5aca16563411becf (diff) | |
| download | edk2-platforms-44717a398fddc4df1f4aeaa70bcd7a043187ed34.tar.xz | |
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
Diffstat (limited to 'MdePkg/Include/Protocol/BlockIo.h')
| -rw-r--r-- | MdePkg/Include/Protocol/BlockIo.h | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/MdePkg/Include/Protocol/BlockIo.h b/MdePkg/Include/Protocol/BlockIo.h index dd3d9c1a15..adbeedc289 100644 --- a/MdePkg/Include/Protocol/BlockIo.h +++ b/MdePkg/Include/Protocol/BlockIo.h @@ -189,10 +189,9 @@ typedef struct { ///
#define EFI_BLOCK_IO_INTERFACE_REVISION EFI_BLOCK_IO_PROTOCOL_REVISION
-/**
- @par Protocol Description:
- This protocol provides control over block devices.
-**/
+///
+/// This protocol provides control over block devices.
+///
struct _EFI_BLOCK_IO_PROTOCOL {
///
/// The revision to which the block IO interface adheres. All future
@@ -200,7 +199,9 @@ struct _EFI_BLOCK_IO_PROTOCOL { /// back wards compatible, it is not the same GUID.
///
UINT64 Revision;
-
+ ///
+ /// Pointer to the EFI_BLOCK_IO_MEDIA data for this device.
+ ///
EFI_BLOCK_IO_MEDIA *Media;
EFI_BLOCK_RESET Reset;
|