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

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

diff --git a/MdePkg/Include/Guid/FileSystemInfo.h b/MdePkg/Include/Guid/FileSystemInfo.h
index f6e7488a082caf9c558998a6201292757b4fdb8f..7556746db1c7d33f5b48b3a386a1572df46bd73e 100644 (file)
--- a/MdePkg/Include/Guid/FileSystemInfo.h
+++ b/MdePkg/Include/Guid/FileSystemInfo.h
@@ -1,44 +1,62 @@
 /** @file\r
-  FileSystemInfo protocol as defined in the EFI 1.0 specification.\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
-\r
-  Module Name:  FileSystemInfo.h\r
+  Provides a GUID and a data structure that can be used with EFI_FILE_PROTOCOL.GetInfo()\r
+  or EFI_FILE_PROTOCOL.SetInfo() to get or set information about the system's volume.\r
+  This GUID is defined in UEFI specification.\r
+\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
 #ifndef __FILE_SYSTEM_INFO_H__\r
 #define __FILE_SYSTEM_INFO_H__\r
 \r
-#define EFI_FILE_SYSTEM_INFO_ID_GUID \\r
+#define EFI_FILE_SYSTEM_INFO_ID \\r
   { \\r
     0x9576e93, 0x6d3f, 0x11d2, {0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \\r
   }\r
 \r
 typedef struct {\r
+  ///\r
+  /// The size of the EFI_FILE_SYSTEM_INFO structure, including the Null-terminated VolumeLabel string.\r
+  ///\r
   UINT64  Size;\r
+  ///\r
+  /// TRUE if the volume only supports read access.\r
+  ///\r
   BOOLEAN ReadOnly;\r
+  ///\r
+  /// The number of bytes managed by the file system.\r
+  ///\r
   UINT64  VolumeSize;\r
+  ///\r
+  /// The number of available bytes for use by the file system.\r
+  ///\r
   UINT64  FreeSpace;\r
+  ///\r
+  /// The nominal block size by which files are typically grown.\r
+  ///\r
   UINT32  BlockSize;\r
+  ///\r
+  /// The Null-terminated string that is the volume's label.\r
+  ///\r
   CHAR16  VolumeLabel[1];\r
 } EFI_FILE_SYSTEM_INFO;\r
 \r
-//\r
-// The VolumeLabel field of the EFI_FILE_SYSTEM_INFO data structure is variable length.\r
-// Whenever code needs to know the size of the EFI_FILE_SYSTEM_INFO data structure, it needs\r
-// to be the size of the data structure without the VolumeLable field.  The following macro\r
-// computes this size correctly no matter how big the VolumeLable array is declared.\r
-// This is required to make the EFI_FILE_SYSTEM_INFO data structure ANSI compilant.\r
-//\r
-#define SIZE_OF_EFI_FILE_SYSTEM_INFO  EFI_FIELD_OFFSET (EFI_FILE_SYSTEM_INFO, VolumeLabel)\r
+///\r
+/// The VolumeLabel field of the EFI_FILE_SYSTEM_INFO data structure is variable length.\r
+/// Whenever code needs to know the size of the EFI_FILE_SYSTEM_INFO data structure, it needs\r
+/// to be the size of the data structure without the VolumeLable field.  The following macro\r
+/// computes this size correctly no matter how big the VolumeLable array is declared.\r
+/// This is required to make the EFI_FILE_SYSTEM_INFO data structure ANSI compilant.\r
+///\r
+#define SIZE_OF_EFI_FILE_SYSTEM_INFO  OFFSET_OF (EFI_FILE_SYSTEM_INFO, VolumeLabel)\r
 \r
 extern EFI_GUID gEfiFileSystemInfoGuid;\r
 \r