[llvm] r343394 - Add a comment to clarify the contract for LLVMGetErrorMessage in the c-bindings

[Lang Hames via llvm-commits]

Author: lhames
Date: Sat Sep 29 16:49:54 2018
New Revision: 343394

URL: http://llvm.org/viewvc/llvm-project?rev=343394&view=rev
Log:
Add a comment to clarify the contract for LLVMGetErrorMessage in the c-bindings
for Error.

Modified:
    llvm/trunk/include/llvm-c/Error.h

Modified: llvm/trunk/include/llvm-c/Error.h
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/include/llvm-c/Error.h?rev=343394&r1=343393&r2=343394&view=diff
==============================================================================
--- llvm/trunk/include/llvm-c/Error.h (original)
+++ llvm/trunk/include/llvm-c/Error.h Sat Sep 29 16:49:54 2018
@@ -47,6 +47,8 @@ void LLVMConsumeError(LLVMErrorRef Err);
 /**
  * Returns the given string's error message. This operation consumes the error,
  * and the given LLVMErrorRef value is not usable once this call returns.
+ * The caller is responsible for disposing of the string by calling
+ * LLVMDisposeErrorMessage.
  */
 char *LLVMGetErrorMessage(LLVMErrorRef Err);