]> git.proxmox.com Git - mirror_edk2.git/blobdiff - FatPkg/EnhancedFatDxe/DirectoryCache.c
MdeModulePkg CapsuleApp: Do not parse bits in CapsuleFlags of ESRT
[mirror_edk2.git] / FatPkg / EnhancedFatDxe / DirectoryCache.c
index 1cb8b9f117b7cecbe84f788ff7603345bc5a004f..30de86a996a1e13b72bd4a737b68925ef78b65d2 100644 (file)
@@ -1,7 +1,8 @@
-/*++\r
+/** @file\r
+  Functions for directory cache operation.\r
 \r
-Copyright (c) 2005, Intel Corporation\r
-All rights reserved. This program and the accompanying materials are licensed and made available\r
+Copyright (c) 2005, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available\r
 under the terms and conditions of the BSD License which accompanies this\r
 distribution. The full text of the license may be found at\r
 http://opensource.org/licenses/bsd-license.php\r
@@ -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.\r
 \r
 \r
-Module Name:\r
+**/\r
 \r
-  DirectoryCache.c\r
-\r
-Abstract:\r
-\r
-  Functions for directory cache operation\r
+#include "Fat.h"\r
 \r
-Revision History\r
+/**\r
 \r
---*/\r
+  Free the directory structure and release the memory.\r
 \r
-#include "Fat.h"\r
+  @param  ODir                  - The directory to be freed.\r
 \r
+**/\r
 STATIC\r
 VOID\r
 FatFreeODir (\r
   IN FAT_ODIR    *ODir\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Free the directory structure and release the memory.\r
-\r
-Arguments:\r
-\r
-  ODir                  - The directory to be freed.\r
-\r
-Returns:\r
-\r
-  None.\r
-\r
---*/\r
 {\r
   FAT_DIRENT  *DirEnt;\r
 \r
@@ -63,26 +46,18 @@ Returns:
   FreePool (ODir);\r
 }\r
 \r
+/**\r
+\r
+  Allocate the directory structure.\r
+\r
+  @param  OFile                   - The corresponding OFile.\r
+\r
+**/\r
 STATIC\r
 FAT_ODIR *\r
 FatAllocateODir (\r
   IN FAT_OFILE   *OFile\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Allocate the directory structure.\r
-\r
-Arguments:\r
-\r
-  OFile                   - The corresponding OFile.\r
-\r
-Returns:\r
-\r
-  None.\r
-\r
---*/\r
 {\r
   FAT_ODIR  *ODir;\r
 \r
@@ -99,26 +74,18 @@ Returns:
   return ODir;\r
 }\r
 \r
-VOID\r
-FatDiscardODir (\r
-  IN FAT_OFILE    *OFile\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
+/**\r
 \r
   Discard the directory structure when an OFile will be freed.\r
   Volume will cache this directory if the OFile does not represent a deleted file.\r
 \r
-Arguments:\r
+  @param  OFile                 - The OFile whose directory structure is to be discarded.\r
 \r
-  OFile                 - The OFile whose directory structure is to be discarded.\r
-\r
-Returns:\r
-\r
-  None.\r
-\r
---*/\r
+**/\r
+VOID\r
+FatDiscardODir (\r
+  IN FAT_OFILE    *OFile\r
+  )\r
 {\r
   FAT_ODIR    *ODir;\r
   FAT_VOLUME  *Volume;\r
@@ -154,27 +121,20 @@ Returns:
   }\r
 }\r
 \r
-VOID\r
-FatRequestODir (\r
-  IN FAT_OFILE    *OFile\r
-  )\r
-/*++\r
+/**\r
 \r
-Routine Description:\r
 \r
   Request the directory structure when an OFile is newly generated.\r
   If the directory structure is cached by volume, then just return this directory;\r
   Otherwise, allocate a new one for OFile.\r
 \r
-Arguments:\r
-\r
-  OFile                 - The OFile which requests directory structure.\r
+  @param  OFile                 - The OFile which requests directory structure.\r
 \r
-Returns:\r
-\r
-  None.\r
-\r
---*/\r
+**/\r
+VOID\r
+FatRequestODir (\r
+  IN FAT_OFILE    *OFile\r
+  )\r
 {\r
   UINTN           DirCacheTag;\r
   FAT_VOLUME      *Volume;\r
@@ -208,25 +168,17 @@ Returns:
   OFile->ODir = ODir;\r
 }\r
 \r
-VOID\r
-FatCleanupODirCache (\r
-  IN FAT_VOLUME         *Volume\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
+/**\r
 \r
   Clean up all the cached directory structures when the volume is going to be abandoned.\r
 \r
-Arguments:\r
+  @param  Volume                - FAT file system volume.\r
 \r
-  Volume                - FAT file system volume.\r
-\r
-Returns:\r
-\r
-  None.\r
-\r
---*/\r
+**/\r
+VOID\r
+FatCleanupODirCache (\r
+  IN FAT_VOLUME         *Volume\r
+  )\r
 {\r
   FAT_ODIR  *ODir;\r
   while (Volume->DirCacheCount > 0) {\r