diff --git a/include/llvm/ExecutionEngine/ObjectBuffer.h b/include/llvm/ExecutionEngine/ObjectBuffer.h index c817c17aa86..88a4213ed85 100644 --- a/include/llvm/ExecutionEngine/ObjectBuffer.h +++ b/include/llvm/ExecutionEngine/ObjectBuffer.h @@ -21,13 +21,13 @@ namespace llvm { -/// ObjectBuffer - This class acts as a container for the memory buffer used during -/// generation and loading of executable objects using MCJIT and RuntimeDyld. The +/// This class acts as a container for the memory buffer used during generation +/// and loading of executable objects using MCJIT and RuntimeDyld. The /// underlying memory for the object will be owned by the ObjectBuffer instance -/// throughout its lifetime. The getMemBuffer() method provides a way to create a -/// MemoryBuffer wrapper object instance to be owned by other classes (such as -/// ObjectFile) as needed, but the MemoryBuffer instance returned does not own the -/// actual memory it points to. +/// throughout its lifetime. The getMemBuffer() method provides a way to create +/// a MemoryBuffer wrapper object instance to be owned by other classes (such as +/// ObjectFile) as needed, but the MemoryBuffer instance returned does not own +/// the actual memory it points to. class ObjectBuffer { virtual void anchor(); public: @@ -35,9 +35,9 @@ public: ObjectBuffer(MemoryBuffer* Buf) : Buffer(Buf) {} virtual ~ObjectBuffer() {} - /// getMemBuffer - Like MemoryBuffer::getMemBuffer() this function - /// returns a pointer to an object that is owned by the caller. However, - /// the caller does not take ownership of the underlying memory. + /// Like MemoryBuffer::getMemBuffer() this function returns a pointer to an + /// object that is owned by the caller. However, the caller does not take + /// ownership of the underlying memory. MemoryBuffer *getMemBuffer() const { return MemoryBuffer::getMemBuffer(Buffer->getBuffer(), Buffer->getBufferIdentifier(), false); @@ -55,10 +55,10 @@ protected: std::unique_ptr Buffer; }; -/// ObjectBufferStream - This class encapsulates the SmallVector and -/// raw_svector_ostream needed to generate an object using MC code emission -/// while providing a common ObjectBuffer interface for access to the -/// memory once the object has been generated. +/// This class encapsulates the SmallVector and raw_svector_ostream needed to +/// generate an object using MC code emission while providing a common +/// ObjectBuffer interface for access to the memory once the object has been +/// generated. class ObjectBufferStream : public ObjectBuffer { void anchor() override; public: