Mention that the getError() semantics are unclear

Change-Id: Ifd5b04cc13085749f0f800bdb69cc3fdd5581916
This commit is contained in:
Tor Lillqvist 2018-01-10 17:28:20 +02:00
parent d2763bde00
commit 4e5716b57c

View file

@ -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);