Merge pull request #621 from talex5/stat-docs

Document File.Stat record fields

lib_eio/file.mli

@@ -1,6 +1,6 @@
 open Std
 
-(** Tranditional Unix permissions. *)
+(** Traditional Unix permissions. *)
 module Unix_perm : sig
   type t = int
   (** This is the same as {!Unix.file_perm}, but avoids a dependency on [Unix]. *)
@@ -25,18 +25,18 @@ module Stat : sig
   (** Pretty printer for {! kind}. *)
 
   type t = {
-    dev : Int64.t;
-    ino : Int64.t;
-    kind : kind;
-    perm : Unix_perm.t;
-    nlink : Int64.t;
-    uid : Int64.t;
-    gid : Int64.t;
-    rdev : Int64.t;
-    size : Optint.Int63.t;
-    atime : float;
-    mtime : float;
-    ctime : float;
+    dev : Int64.t;              (** Device containing the filesystem where the file resides. *)
+    ino : Int64.t;              (** Inode number. *)
+    kind : kind;                (** File type. *)
+    perm : Unix_perm.t;         (** Permissions (mode). *)
+    nlink : Int64.t;            (** Number of hard links. *)
+    uid : Int64.t;              (** User ID of owner. *)
+    gid : Int64.t;              (** Group ID of owner. *)
+    rdev : Int64.t;             (** Device's ID (if this is a device). *)
+    size : Optint.Int63.t;      (** Total size in bytes. *)
+    atime : float;              (** Last access time. *)
+    mtime : float;              (** Last modification time. *)
+    ctime : float;              (** Creation time. *)
   }
   (** Like stat(2). *)