summaryrefslogtreecommitdiff
path: root/MdePkg/Include/Protocol/ComponentName.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/ComponentName.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/ComponentName.h')
-rw-r--r--MdePkg/Include/Protocol/ComponentName.h12
1 files changed, 4 insertions, 8 deletions
diff --git a/MdePkg/Include/Protocol/ComponentName.h b/MdePkg/Include/Protocol/ComponentName.h
index 69c61a619e..1f0f5f1749 100644
--- a/MdePkg/Include/Protocol/ComponentName.h
+++ b/MdePkg/Include/Protocol/ComponentName.h
@@ -109,14 +109,10 @@ EFI_STATUS
OUT CHAR16 **ControllerName
);
-//
-// Interface structure for the Component Name Protocol
-//
-/**
- @par Protocol Description:
- This protocol is used to retrieve user readable names of drivers
- and controllers managed by UEFI Drivers.
-**/
+///
+/// This protocol is used to retrieve user readable names of drivers
+/// and controllers managed by UEFI Drivers.
+///
struct _EFI_COMPONENT_NAME_PROTOCOL {
EFI_COMPONENT_NAME_GET_DRIVER_NAME GetDriverName;
EFI_COMPONENT_NAME_GET_CONTROLLER_NAME GetControllerName;