sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Refine the file/function comments to follow doxygen format

Browse Source 
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10359 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
klu2
2010-04-12 04:38:44 +00:00
parent 9af300fc22
commit 18c97f53ea
15 changed files with 1844 additions and 1003 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
PcAtChipsetPkg/KbcResetDxe/Reset.c
View File

@@ -1,7 +1,8 @@
/*++
/** @file
Reset Architectural Protocol implementation
Copyright (c) 2006, Intel Corporation
All rights reserved. This program and the accompanying materials
Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved. <BR>
This program and the accompanying materials
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
http://opensource.org/licenses/bsd-license.php
@@ -9,17 +10,19 @@ http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Module Name:
Reset.c
Abstract:
Reset Architectural Protocol implementation
--*/
**/
#include "Reset.h"
/**
Reset the system.
@param ResetType warm or cold
@param ResetStatus possible cause of reset
@param DataSize Size of ResetData in bytes
@param ResetData Optional Unicode string
**/
VOID
EFIAPI
KbcResetSystem (
@@ -28,25 +31,6 @@ KbcResetSystem (
IN UINTN DataSize,
IN VOID *ResetData OPTIONAL
)
/*++
Routine Description:
Reset the system.
Arguments:
ResetType - warm or cold
ResetStatus - possible cause of reset
DataSize - Size of ResetData in bytes
ResetData - Optional Unicode string
For details, see efiapi.h
Returns:
Does not return if the reset takes place.
EFI_INVALID_PARAMETER If ResetType is invalid.
--*/
{
UINT8 Data;

71
PcAtChipsetPkg/KbcResetDxe/Reset.h
View File

@@ -1,7 +1,9 @@
/*++
/** @file
Copyright (c) 2006, Intel Corporation
All rights reserved. This program and the accompanying materials
Definitions for reset
Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved. <BR>
This program and the accompanying materials
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
http://opensource.org/licenses/bsd-license.php
@@ -9,14 +11,7 @@ http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Module Name:
Reset.h
Abstract:
some definitions for reset
--*/
**/
#ifndef _KBC_RESET_H
#define _KBC_RESET_H
@@ -30,30 +25,34 @@ Abstract:
#include <Protocol/Reset.h>
/**
Initialize the state information for the Reset Architectural Protocol
@param ImageHandle Handle of the loaded driver
@param SystemTable Pointer to the System Table
@retval EFI_SUCCESS Thread can be successfully created
@retval EFI_OUT_OF_RESOURCES Cannot allocate protocol data structure
@retval EFI_DEVICE_ERROR Cannot create the timer service
**/
EFI_STATUS
EFIAPI
InitializeReset (
IN EFI_HANDLE ImageHandle,
IN EFI_SYSTEM_TABLE *SystemTable
)
/*++
Routine Description:
TODO: Add function description
Arguments:
ImageHandle - TODO: add argument description
SystemTable - TODO: add argument description
Returns:
TODO: add return values
--*/
;
/**
Reset the system.
@param ResetType warm or cold
@param ResetStatus possible cause of reset
@param DataSize Size of ResetData in bytes
@param ResetData Optional Unicode string
**/
VOID
EFIAPI
KbcResetSystem (
@@ -62,24 +61,6 @@ KbcResetSystem (
IN UINTN DataSize,
IN VOID *ResetData OPTIONAL
)
/*++
Routine Description:
TODO: Add function description
Arguments:
ResetType - TODO: add argument description
ResetStatus - TODO: add argument description
DataSize - TODO: add argument description
ResetData - TODO: add argument description
Returns:
TODO: add return values
--*/
;
#endif

44
PcAtChipsetPkg/KbcResetDxe/ResetEntry.c
View File

@@ -1,17 +1,15 @@
/*++
/** @file
Driver entry for KbcReset driver.
Copyright (c) 2009, Intel Corporation
All rights reserved. This program and the accompanying materials
Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved. <BR>
This program and the accompanying materials
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
http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
--*/
**/
#include "Reset.h"
@@ -21,33 +19,23 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
EFI_HANDLE mResetHandle = NULL;
/**
Initialize the state information for the Reset Architectural Protocol
@param ImageHandle Handle of the loaded driver
@param SystemTable Pointer to the System Table
@retval EFI_SUCCESS Thread can be successfully created
@retval EFI_OUT_OF_RESOURCES Cannot allocate protocol data structure
@retval EFI_DEVICE_ERROR Cannot create the timer service
**/
EFI_STATUS
EFIAPI
InitializeReset (
IN EFI_HANDLE ImageHandle,
IN EFI_SYSTEM_TABLE *SystemTable
)
/*++
Routine Description:
Initialize the state information for the Reset Architectural Protocol
Arguments:
ImageHandle of the loaded driver
Pointer to the System Table
Returns:
Status
EFI_SUCCESS - thread can be successfully created
EFI_OUT_OF_RESOURCES - cannot allocate protocol data structure
EFI_DEVICE_ERROR - cannot create the timer service
--*/
// TODO: SystemTable - add argument and description to function comment
{
EFI_STATUS Status;