Author: stella.stamenova Date: Thu Jul 12 14:27:56 2018 New Revision: 336948
URL: http://llvm.org/viewvc/llvm-project?rev=336948&view=rev Log: [process] Update the documentation for ReadMemory and DoReadMemory to include the error parameter Summary: The current documentation does not include the error parameter. Reviewers: jingham, asmith Reviewed By: jingham Subscribers: llvm-commits Differential Revision: https://reviews.llvm.org/D49251 Modified: lldb/trunk/include/lldb/Target/Process.h Modified: lldb/trunk/include/lldb/Target/Process.h URL: http://llvm.org/viewvc/llvm-project/lldb/trunk/include/lldb/Target/Process.h?rev=336948&r1=336947&r2=336948&view=diff ============================================================================== --- lldb/trunk/include/lldb/Target/Process.h (original) +++ lldb/trunk/include/lldb/Target/Process.h Thu Jul 12 14:27:56 2018 @@ -1696,8 +1696,15 @@ public: /// A byte buffer that is at least \a size bytes long that /// will receive the memory bytes. /// + /// @param[out] error + /// An error that indicates the success or failure of this + /// operation. If error indicates success (error.Success()), + /// then the value returned can be trusted, otherwise zero + /// will be returned. + /// /// @return /// The number of bytes that were actually read into \a buf. + /// Zero is returned in the case of an error. //------------------------------------------------------------------ virtual size_t DoReadMemory(lldb::addr_t vm_addr, void *buf, size_t size, Status &error) = 0; @@ -1723,12 +1730,18 @@ public: /// @param[in] size /// The number of bytes to read. /// + /// @param[out] error + /// An error that indicates the success or failure of this + /// operation. If error indicates success (error.Success()), + /// then the value returned can be trusted, otherwise zero + /// will be returned. + /// /// @return /// The number of bytes that were actually read into \a buf. If /// the returned number is greater than zero, yet less than \a /// size, then this function will get called again with \a /// vm_addr, \a buf, and \a size updated appropriately. Zero is - /// returned to indicate an error. + /// returned in the case of an error. //------------------------------------------------------------------ virtual size_t ReadMemory(lldb::addr_t vm_addr, void *buf, size_t size, Status &error); _______________________________________________ lldb-commits mailing list lldb-commits@lists.llvm.org http://lists.llvm.org/cgi-bin/mailman/listinfo/lldb-commits
