Grammatical and disclaimer changes (does not follow internal C coding stds.)

[mirror_edk2.git] / MdePkg / Include / Guid / FileInfo.h

diff --git a/MdePkg/Include/Guid/FileInfo.h b/MdePkg/Include/Guid/FileInfo.h
index 31c9c739515428b4bf3d05267f3ac3791ec636df..5e8ecc848840661412352913ce5ef63f552c4792 100644 (file)
--- a/MdePkg/Include/Guid/FileInfo.h
+++ b/MdePkg/Include/Guid/FileInfo.h
@@ -1,20 +1,16 @@
 /** @file\r
-  SimpleFileSystem guid and data structure as defined in the UEFI 2.0 specification.\r
+  Provides a GUID and a data structure that can be used with EFI_FILE_PROTOCOL.SetInfo()\r
+  and EFI_FILE_PROTOCOL.GetInfo() to set or get generic file information.\r
+  This GUID is defined in UEFI specification.\r
 \r
-  The SimpleFileSystem protocol is the programatic access to the FAT (12,16,32) \r
-  file system specified in UEFI 2.0. It can also be used to abstract any \r
-  file system other than FAT.\r
-\r
-  UEFI 2.0 can boot from any valid EFI image contained in a SimpleFileSystem\r
-\r
-  Copyright (c) 2006, Intel Corporation                                                         \r
-  All rights reserved. This program and the accompanying materials                          \r
-  are licensed and made available under the terms and conditions of the BSD License         \r
-  which accompanies this distribution.  The full text of the license may be found at        \r
-  http://opensource.org/licenses/bsd-license.php                                            \r
-\r
-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
+Copyright (c) 2006 - 2010, Intel Corporation.  All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution.  \r
+The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php.                                          \r
+    \r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
 \r
 **/\r
 \r
@@ -27,24 +23,48 @@
   }\r
 \r
 typedef struct {\r
+  ///\r
+  /// The size of the EFI_FILE_INFO structure, including the Null-terminated FileName string.\r
+  ///\r
   UINT64    Size;\r
+  ///\r
+  /// The size of the file in bytes.\r
+  ///\r
   UINT64    FileSize;\r
+  ///\r
+  /// PhysicalSize The amount of physical space the file consumes on the file system volume.\r
+  ///\r
   UINT64    PhysicalSize;\r
+  ///\r
+  /// The time the file was created.\r
+  ///\r
   EFI_TIME  CreateTime;\r
+  ///\r
+  /// The time when the file was last accessed.\r
+  ///\r
   EFI_TIME  LastAccessTime;\r
+  ///\r
+  /// The time when the file's contents were last modified.\r
+  ///\r
   EFI_TIME  ModificationTime;\r
+  ///\r
+  /// The attribute bits for the file.\r
+  ///\r
   UINT64    Attribute;\r
+  ///\r
+  /// The Null-terminated name of the file.\r
+  ///\r
   CHAR16    FileName[1];\r
 } EFI_FILE_INFO;\r
 \r
-//\r
-// The FileName field of the EFI_FILE_INFO data structure is variable length.\r
-// Whenever code needs to know the size of the EFI_FILE_INFO data structure, it needs to\r
-// be the size of the data structure without the FileName field.  The following macro\r
-// computes this size correctly no matter how big the FileName array is declared.\r
-// This is required to make the EFI_FILE_INFO data structure ANSI compilant.\r
-//\r
-#define SIZE_OF_EFI_FILE_INFO EFI_FIELD_OFFSET (EFI_FILE_INFO, FileName)\r
+///\r
+/// The FileName field of the EFI_FILE_INFO data structure is variable length.\r
+/// Whenever code needs to know the size of the EFI_FILE_INFO data structure, it needs to\r
+/// be the size of the data structure without the FileName field.  The following macro\r
+/// computes this size correctly no matter how big the FileName array is declared.\r
+/// This is required to make the EFI_FILE_INFO data structure ANSI compilant.\r
+///\r
+#define SIZE_OF_EFI_FILE_INFO OFFSET_OF (EFI_FILE_INFO, FileName)\r
 \r
 extern EFI_GUID gEfiFileInfoGuid;\r
 \r