Mention that the getError() semantics are unclear

Change-Id: Ifd5b04cc13085749f0f800bdb69cc3fdd5581916

1 files changed, 5 insertions, 0 deletions

diff --git a/include/LibreOfficeKit/LibreOfficeKit.hxx b/include/LibreOfficeKit/LibreOfficeKit.hxx
index 310b9cfcee88..e158ee62cab7 100644
--- a/include/LibreOfficeKit/LibreOfficeKit.hxx
+++ b/include/LibreOfficeKit/LibreOfficeKit.hxx
@@ -583,6 +583,11 @@ public:
     }
 
     /// Returns the last error as a string, the returned pointer has to be freed by the caller.
+
+    /// Exact semantics somewhat unclear (sometimes the code clears the string that the next call to
+    /// getError() will return if no error happens in another function, sometimes not), and
+    /// unfortunately cleaning up that is harder than it seems, because of lovely global variables
+    /// and a unit test that uses the LibreOfficeKit API in an untypical manner.
     char* getError()
     {
         return mpThis->pClass->getError(mpThis);