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/Mtftp4.h | |
parent | 66eebcf94f14a0888a09f6fe5aca16563411becf (diff) | |
download | edk2-44717a398fddc4df1f4aeaa70bcd7a043187ed34.tar.gz edk2-44717a398fddc4df1f4aeaa70bcd7a043187ed34.tar.bz2 edk2-44717a398fddc4df1f4aeaa70bcd7a043187ed34.zip |
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/Mtftp4.h')
-rw-r--r-- | MdePkg/Include/Protocol/Mtftp4.h | 14 |
1 files changed, 5 insertions, 9 deletions
diff --git a/MdePkg/Include/Protocol/Mtftp4.h b/MdePkg/Include/Protocol/Mtftp4.h index 00eb75f954..f2c3084b88 100644 --- a/MdePkg/Include/Protocol/Mtftp4.h +++ b/MdePkg/Include/Protocol/Mtftp4.h @@ -460,15 +460,11 @@ EFI_STATUS IN EFI_MTFTP4_PROTOCOL *This
);
-/**
- The EFI MTFTPv4 Protocol provides basic services for client-side unicast
- and/or multicast TFTP operations.
-
- @par Protocol Description:
- The EFI_MTFTP4_PROTOCOL is designed to be used by UEFI drivers and applications
- to transmit and receive data files. The EFI MTFTPv4 Protocol driver uses
- the underlying EFI UDPv4 Protocol driver and EFI IPv4 Protocol driver.
-**/
+///
+/// The EFI_MTFTP4_PROTOCOL is designed to be used by UEFI drivers and applications
+/// to transmit and receive data files. The EFI MTFTPv4 Protocol driver uses
+/// the underlying EFI UDPv4 Protocol driver and EFI IPv4 Protocol driver.
+///
struct _EFI_MTFTP4_PROTOCOL {
EFI_MTFTP4_GET_MODE_DATA GetModeData;
EFI_MTFTP4_CONFIGURE Configure;
|