Don't duplicate name in comments. NFC.

[oota-llvm.git] / include / llvm / Support / StreamableMemoryObject.h

diff --git a/include/llvm/Support/StreamableMemoryObject.h b/include/llvm/Support/StreamableMemoryObject.h
index 6bb130b876afd413c3cf1c1d2704f2b708320983..618610d084cc22f6a778051251299fbd0300c20e 100644 (file)
--- a/include/llvm/Support/StreamableMemoryObject.h
+++ b/include/llvm/Support/StreamableMemoryObject.h
@@ -21,50 +21,47 @@
 
 namespace llvm {
 
-/// StreamableMemoryObject - Interface to data which might be streamed.
-/// Streamability has 2 important implications/restrictions. First, the data
-/// might not yet exist in memory when the request is made. This just means
-/// that readByte/readBytes might have to block or do some work to get it.
-/// More significantly, the exact size of the object might not be known until
-/// it has all been fetched. This means that to return the right result,
-/// getExtent must also wait for all the data to arrive; therefore it should
-/// not be called on objects which are actually streamed (this would defeat
-/// the purpose of streaming). Instead, isValidAddress and isObjectEnd can be
-/// used to test addresses without knowing the exact size of the stream.
-/// Finally, getPointer can be used instead of readBytes to avoid extra copying.
+/// Interface to data which might be streamed. Streamability has 2 important
+/// implications/restrictions. First, the data might not yet exist in memory
+/// when the request is made. This just means that readByte/readBytes might have
+/// to block or do some work to get it. More significantly, the exact size of
+/// the object might not be known until it has all been fetched. This means that
+/// to return the right result, getExtent must also wait for all the data to
+/// arrive; therefore it should not be called on objects which are actually
+/// streamed (this would defeat the purpose of streaming). Instead,
+/// isValidAddress and isObjectEnd can be used to test addresses without knowing
+/// the exact size of the stream. Finally, getPointer can be used instead of
+/// readBytes to avoid extra copying.
 class StreamableMemoryObject : public MemoryObject {
  public:
-  /// Destructor      - Override as necessary.
   virtual ~StreamableMemoryObject();
 
-  /// getPointer  - Ensures that the requested data is in memory, and returns
-  ///               A pointer to it. More efficient than using readBytes if the
-  ///               data is already in memory.
-  ///               May block until (address - base + size) bytes have been read
+  /// Ensures that the requested data is in memory, and returns a pointer to it.
+  /// More efficient than using readBytes if the data is already in memory. May
+  /// block until (address - base + size) bytes have been read
   /// @param address - address of the byte, in the same space as getBase()
   /// @param size    - amount of data that must be available on return
   /// @result        - valid pointer to the requested data
   virtual const uint8_t *getPointer(uint64_t address, uint64_t size) const = 0;
 
-  /// isValidAddress - Returns true if the address is within the object
-  ///                  (i.e. between base and base + extent - 1 inclusive)
-  ///                  May block until (address - base) bytes have been read
+  /// Returns true if the address is within the object (i.e. between base and
+  /// base + extent - 1 inclusive). May block until (address - base) bytes have
+  /// been read
   /// @param address - address of the byte, in the same space as getBase()
   /// @result        - true if the address may be read with readByte()
   virtual bool isValidAddress(uint64_t address) const = 0;
 
-  /// isObjectEnd    - Returns true if the address is one past the end of the
-  ///                  object (i.e. if it is equal to base + extent)
-  ///                  May block until (address - base) bytes have been read
+  /// Returns true if the address is one past the end of the object (i.e. if it
+  /// is equal to base + extent). May block until (address - base) bytes have
+  /// been read
   /// @param address - address of the byte, in the same space as getBase()
   /// @result        - true if the address is equal to base + extent
   virtual bool isObjectEnd(uint64_t address) const = 0;
 };
 
-/// StreamingMemoryObject - interface to data which is actually streamed from
-/// a DataStreamer. In addition to inherited members, it has the
-/// dropLeadingBytes and setKnownObjectSize methods which are not applicable
-/// to non-streamed objects.
+/// Interface to data which is actually streamed from a DataStreamer. In
+/// addition to inherited members, it has the dropLeadingBytes and
+/// setKnownObjectSize methods which are not applicable to non-streamed objects.
 class StreamingMemoryObject : public StreamableMemoryObject {
 public:
   StreamingMemoryObject(DataStreamer *streamer);