summaryrefslogtreecommitdiff
path: root/MdePkg/Include/Protocol/StatusCode.h
diff options
context:
space:
mode:
authorxli24 <xli24@6f19259b-4bc3-4df7-8a09-765794883524>2008-10-13 02:54:29 +0000
committerxli24 <xli24@6f19259b-4bc3-4df7-8a09-765794883524>2008-10-13 02:54:29 +0000
commit44717a398fddc4df1f4aeaa70bcd7a043187ed34 (patch)
treeb41f68d9d59c300d71efeeba5a12acc1bbcfb593 /MdePkg/Include/Protocol/StatusCode.h
parent66eebcf94f14a0888a09f6fe5aca16563411becf (diff)
downloadedk2-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/StatusCode.h')
-rw-r--r--MdePkg/Include/Protocol/StatusCode.h12
1 files changed, 5 insertions, 7 deletions
diff --git a/MdePkg/Include/Protocol/StatusCode.h b/MdePkg/Include/Protocol/StatusCode.h
index 8f90cafb76..70fa619ba8 100644
--- a/MdePkg/Include/Protocol/StatusCode.h
+++ b/MdePkg/Include/Protocol/StatusCode.h
@@ -56,13 +56,11 @@ EFI_STATUS
IN EFI_STATUS_CODE_DATA *Data OPTIONAL
);
-/**
- @par Protocol Description:
- Provides the service required to report a status code to the platform firmware.
- This protocol must be produced by a runtime DXE driver and may be consumed
- only by the DXE Foundation.
-
-**/
+///
+/// Provides the service required to report a status code to the platform firmware.
+/// This protocol must be produced by a runtime DXE driver and may be consumed
+/// only by the DXE Foundation.
+///
typedef struct _EFI_STATUS_CODE_PROTOCOL {
EFI_REPORT_STATUS_CODE ReportStatusCode;
} EFI_STATUS_CODE_PROTOCOL;