From e73a208fb2b70fb5d195a74956f22ea6557d361f Mon Sep 17 00:00:00 2001 From: David Baker Date: Tue, 1 Oct 2019 11:18:05 +0100 Subject: doc string --- include/olm/olm.h | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'include') diff --git a/include/olm/olm.h b/include/olm/olm.h index 770be72..242277a 100644 --- a/include/olm/olm.h +++ b/include/olm/olm.h @@ -318,6 +318,12 @@ int olm_session_has_received_message( OlmSession *session ); +/** + * Return a string describing the internal state of an olm session, + * for debugging and logging purposes. The pointer returned points + * to an internal buffer and is valid until the next call to + * olm_session_describe on the same olm session object. + */ const char * olm_session_describe(OlmSession * session); /** Checks if the PRE_KEY message is for this in-bound session. This can happen -- cgit v1.2.3