From 44717a398fddc4df1f4aeaa70bcd7a043187ed34 Mon Sep 17 00:00:00 2001 From: xli24 Date: Mon, 13 Oct 2008 02:54:29 +0000 Subject: 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 --- MdePkg/Include/Protocol/ComponentName.h | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) (limited to 'MdePkg/Include/Protocol/ComponentName.h') 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; -- cgit v1.2.3