From: Eli Bendersky <eliben@google.com>
Date: Tue, 23 Jul 2013 21:05:21 +0000 (+0000)
Subject: Expand the comment on getOpenFileSlice a bit for more details and consistency
X-Git-Url: http://demsky.eecs.uci.edu/git/?a=commitdiff_plain;h=25c6cec2a29f7f835d559865cecb18621a0d61de;p=oota-llvm.git

Expand the comment on getOpenFileSlice a bit for more details and consistency


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@186987 91177308-0d34-0410-b5e6-96231b3b80d8
---

diff --git a/include/llvm/Support/MemoryBuffer.h b/include/llvm/Support/MemoryBuffer.h
index 9609e3366d4..4f28da4094c 100644
--- a/include/llvm/Support/MemoryBuffer.h
+++ b/include/llvm/Support/MemoryBuffer.h
@@ -74,8 +74,9 @@ public:
                             int64_t FileSize = -1,
                             bool RequiresNullTerminator = true);
 
-  // Get a MemoryBuffer of part of a file. Since this is in the middle of a
-  // file, the buffer is not null terminated.
+  /// Given an already-open file descriptor, map some slice of it into a
+  /// MemoryBuffer. The slice is specified by an \p Offset and \p MapSize.
+  /// Since this is in the middle of a file, the buffer is not null terminated.
   static error_code getOpenFileSlice(int FD, const char *Filename,
                                      OwningPtr<MemoryBuffer> &Result,
                                      uint64_t MapSize, int64_t Offset);