Update comments to conform to the new, Doxygen friendly, coding standard. These are structural changes only. There is NO NEW CONTENT.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@462 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
darylm503 2006-06-09 23:44:26 +00:00
parent ed72955cc8
commit 8b4e96c42b
1 changed files with 31 additions and 60 deletions

View File

@ -1,22 +1,14 @@
/*++ /** @file
Copyright (c) 2006, Intel Corporation Copyright (c) 2006, Intel Corporation
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Module Name: **/
ComponentName.h
Abstract:
Revision History
--*/
#ifndef _IDE_BUS_COMPONENT_NAME_H #ifndef _IDE_BUS_COMPONENT_NAME_H
#define _IDE_BUS_COMPONENT_NAME_H #define _IDE_BUS_COMPONENT_NAME_H
@ -38,6 +30,16 @@ extern EFI_COMPONENT_NAME_PROTOCOL gIDEBusComponentName;
// //
// EFI Component Name Functions // EFI Component Name Functions
// //
/**
TODO: Add function description
@param This TODO: add argument description
@param Language TODO: add argument description
@param DriverName TODO: add argument description
TODO: add return values
**/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
IDEBusComponentNameGetDriverName ( IDEBusComponentNameGetDriverName (
@ -45,25 +47,20 @@ IDEBusComponentNameGetDriverName (
IN CHAR8 *Language, IN CHAR8 *Language,
OUT CHAR16 **DriverName OUT CHAR16 **DriverName
) )
/*++ ;
Routine Description:
/**
TODO: Add function description TODO: Add function description
Arguments: @param This TODO: add argument description
@param ControllerHandle TODO: add argument description
This - TODO: add argument description @param ChildHandle TODO: add argument description
Language - TODO: add argument description @param Language TODO: add argument description
DriverName - TODO: add argument description @param ControllerName TODO: add argument description
Returns:
TODO: add return values TODO: add return values
--*/ **/
;
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
IDEBusComponentNameGetControllerName ( IDEBusComponentNameGetControllerName (
@ -73,46 +70,20 @@ IDEBusComponentNameGetControllerName (
IN CHAR8 *Language, IN CHAR8 *Language,
OUT CHAR16 **ControllerName OUT CHAR16 **ControllerName
) )
/*++ ;
Routine Description:
/**
TODO: Add function description TODO: Add function description
Arguments: @param IdeBlkIoDevicePtr TODO: add argument description
This - TODO: add argument description
ControllerHandle - TODO: add argument description
ChildHandle - TODO: add argument description
Language - TODO: add argument description
ControllerName - TODO: add argument description
Returns:
TODO: add return values TODO: add return values
--*/ **/
;
VOID VOID
AddName ( AddName (
IN IDE_BLK_IO_DEV *IdeBlkIoDevicePtr IN IDE_BLK_IO_DEV *IdeBlkIoDevicePtr
) )
/*++
Routine Description:
TODO: Add function description
Arguments:
IdeBlkIoDevicePtr - TODO: add argument description
Returns:
TODO: add return values
--*/
; ;
#endif #endif