diff options
author | qhuang8 <qhuang8@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-05-09 07:08:30 +0000 |
---|---|---|
committer | qhuang8 <qhuang8@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-05-09 07:08:30 +0000 |
commit | 162ed594438ab8d39f89b43e6d645ca24e1e1e65 (patch) | |
tree | 8fe9f6ab44ae5c8809567b98737db5611867ccc9 /MdeModulePkg/Core/Dxe/Misc/Stall.c | |
parent | dc2e539a344115537c1d3883ba96eaade345827b (diff) | |
download | edk2-platforms-162ed594438ab8d39f89b43e6d645ca24e1e1e65.tar.xz |
Add doxygen style comments for functions in DxeMain.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5189 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdeModulePkg/Core/Dxe/Misc/Stall.c')
-rw-r--r-- | MdeModulePkg/Core/Dxe/Misc/Stall.c | 29 |
1 files changed, 11 insertions, 18 deletions
diff --git a/MdeModulePkg/Core/Dxe/Misc/Stall.c b/MdeModulePkg/Core/Dxe/Misc/Stall.c index db32c1fa3a..8ab48e6cf3 100644 --- a/MdeModulePkg/Core/Dxe/Misc/Stall.c +++ b/MdeModulePkg/Core/Dxe/Misc/Stall.c @@ -20,29 +20,22 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #include <DxeMain.h>
-EFI_STATUS
-EFIAPI
-CoreStall (
- IN UINTN Microseconds
- )
-/*++
-
-Routine Description:
+/**
Introduces a fine-grained stall.
-Arguments:
-
- Microseconds The number of microseconds to stall execution
-
-Returns:
+ @param Microseconds The number of microseconds to stall execution.
- EFI_SUCCESS - Execution was stalled for at least the requested amount
- of microseconds.
+ @retval EFI_SUCCESS Execution was stalled for at least the requested
+ amount of microseconds.
+ @retval EFI_NOT_AVAILABLE_YET gMetronome is not available yet
- EFI_NOT_AVAILABLE_YET - gMetronome is not available yet
-
---*/
+**/
+EFI_STATUS
+EFIAPI
+CoreStall (
+ IN UINTN Microseconds
+ )
{
UINT32 Counter;
UINT32 Remainder;
|