[llvm] r186987 - Expand the comment on getOpenFileSlice a bit for more details and consistency

[Eli Bendersky]

Author: eliben
Date: Tue Jul 23 16:05:21 2013
New Revision: 186987

URL: http://llvm.org/viewvc/llvm-project?rev=186987&view=rev
Log:
Expand the comment on getOpenFileSlice a bit for more details and consistency

Modified:
    llvm/trunk/include/llvm/Support/MemoryBuffer.h

Modified: llvm/trunk/include/llvm/Support/MemoryBuffer.h
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/include/llvm/Support/MemoryBuffer.h?rev=186987&r1=186986&r2=186987&view=diff
==============================================================================
--- llvm/trunk/include/llvm/Support/MemoryBuffer.h (original)
+++ llvm/trunk/include/llvm/Support/MemoryBuffer.h Tue Jul 23 16:05:21 2013
@@ -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);