FatPkg/EnhancedFatDxe: Make the comments align with EDKIIcoding style

Cc: Ruiyu Ni <ruiyu.ni@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Dandan Bi <dandan.bi@intel.com>
Reviewed-by: Ruiyu Ni <ruiyu.ni@intel.com>
This commit is contained in:
Dandan Bi
2016-12-09 10:07:49 +08:00
committed by Ruiyu Ni
parent 6b7e4498e8
commit cae7420b4b
21 changed files with 1664 additions and 2747 deletions

View File

@@ -1,4 +1,5 @@
/*++
/** @file
Functions for directory cache operation.
Copyright (c) 2005, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials are licensed and made available
@@ -10,40 +11,22 @@ 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:
DirectoryCache.c
Abstract:
Functions for directory cache operation
Revision History
--*/
**/
#include "Fat.h"
/**
Free the directory structure and release the memory.
@param ODir - The directory to be freed.
**/
STATIC
VOID
FatFreeODir (
IN FAT_ODIR *ODir
)
/*++
Routine Description:
Free the directory structure and release the memory.
Arguments:
ODir - The directory to be freed.
Returns:
None.
--*/
{
FAT_DIRENT *DirEnt;
@@ -63,26 +46,18 @@ Returns:
FreePool (ODir);
}
/**
Allocate the directory structure.
@param OFile - The corresponding OFile.
**/
STATIC
FAT_ODIR *
FatAllocateODir (
IN FAT_OFILE *OFile
)
/*++
Routine Description:
Allocate the directory structure.
Arguments:
OFile - The corresponding OFile.
Returns:
None.
--*/
{
FAT_ODIR *ODir;
@@ -99,26 +74,18 @@ Returns:
return ODir;
}
VOID
FatDiscardODir (
IN FAT_OFILE *OFile
)
/*++
Routine Description:
/**
Discard the directory structure when an OFile will be freed.
Volume will cache this directory if the OFile does not represent a deleted file.
Arguments:
@param OFile - The OFile whose directory structure is to be discarded.
OFile - The OFile whose directory structure is to be discarded.
Returns:
None.
--*/
**/
VOID
FatDiscardODir (
IN FAT_OFILE *OFile
)
{
FAT_ODIR *ODir;
FAT_VOLUME *Volume;
@@ -154,27 +121,20 @@ Returns:
}
}
VOID
FatRequestODir (
IN FAT_OFILE *OFile
)
/*++
/**
Routine Description:
Request the directory structure when an OFile is newly generated.
If the directory structure is cached by volume, then just return this directory;
Otherwise, allocate a new one for OFile.
Arguments:
@param OFile - The OFile which requests directory structure.
OFile - The OFile which requests directory structure.
Returns:
None.
--*/
**/
VOID
FatRequestODir (
IN FAT_OFILE *OFile
)
{
UINTN DirCacheTag;
FAT_VOLUME *Volume;
@@ -208,25 +168,17 @@ Returns:
OFile->ODir = ODir;
}
/**
Clean up all the cached directory structures when the volume is going to be abandoned.
@param Volume - FAT file system volume.
**/
VOID
FatCleanupODirCache (
IN FAT_VOLUME *Volume
)
/*++
Routine Description:
Clean up all the cached directory structures when the volume is going to be abandoned.
Arguments:
Volume - FAT file system volume.
Returns:
None.
--*/
{
FAT_ODIR *ODir;
while (Volume->DirCacheCount > 0) {